Menangani sesi dengan Firestore

Tutorial ini menunjukkan cara menangani sesi di App Engine.

Banyak aplikasi memerlukan penanganan sesi untuk autentikasi dan preferensi pengguna. PHP dilengkapi dengan implementasi berbasis memori untuk menjalankan fungsi ini. Namun, implementasi ini tidak cocok untuk aplikasi yang dapat ditayangkan dari beberapa instance, karena sesi yang direkam dalam satu instance mungkin berbeda dengan instance lainnya.

Tujuan

• Menulis aplikasi.
• Menjalankan aplikasi secara lokal.
• Men-deploy aplikasi di App Engine.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen yang dapat ditagih sebagai berikut Google Cloud:

• App Engine
• Firestore

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna Google Cloud baru mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, baca bagian Pembersihan.

Sebelum memulai

Login keakun Anda. Google Cloud Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus terlebih dahulu login ke gcloud CLI dengan identitas gabungan Anda.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus terlebih dahulu login ke gcloud CLI dengan identitas gabungan Anda.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

1. Konfigurasikan gcloud CLI untuk menggunakan new Google Cloud project baru Anda:

   # Configure gcloud for your project
   gcloud config set project PROJECT_ID

   Ganti PROJECT_ID dengan Google Cloud project ID yang Anda buat atau pilih sebelumnya.

Menyiapkan project

1. Di jendela terminal, mulai di direktori pilihan Anda dan buat direktori baru bernama sessions. Semua kode untuk tutorial ini berada di dalam direktori sessions.

2. Ubah ke direktori sessions:

   cd sessions
   

3. Instal dependensinya:

   composer require google/cloud-firestore
   

Di akhir tutorial ini, struktur file akhir akan mirip dengan yang berikut:

sessions
├── app.yaml
└── composer.json
├── index.php

Menulis aplikasi

• Di jendela terminal, buat file bernama index.php dengan konten berikut:

  <?php
  /*
   * Copyright 2019 Google LLC
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  require_once __DIR__ . '/vendor/autoload.php';
  
  use Google\Cloud\Firestore\FirestoreClient;
  
  $projectId = getenv('GOOGLE_CLOUD_PROJECT');
  // Instantiate the Firestore Client for your project ID.
  $firestore = new FirestoreClient([
      'projectId' => $projectId,
  ]);
  
  $handler = $firestore->sessionHandler(['gcLimit' => 500]);
  
  // Configure PHP to use the the Firebase session handler.
  session_set_save_handler($handler, true);
  session_save_path('sessions');
  session_start();
  
  $colors = ['red', 'blue', 'green', 'yellow', 'pink'];
  /**
   * This is an example of a front controller for a flat file PHP site. Using a
   * Static list provides security against URL injection by default.
   */
  switch (@parse_url($_SERVER['REQUEST_URI'])['path']) {
      case '/':
          if (!isset($_SESSION['views'])) {
              $_SESSION['views'] = 0;
              $_SESSION['color'] = $colors[rand(0, 4)];
          }
          printf(
              '<body bgcolor="%s">Views: %s</body>',
              $_SESSION['color'],
              $_SESSION['views']++
          );
          break;
      default:
          http_response_code(404);
          exit('Not Found');
  }
  

Aplikasi ini menampilkan sapaan dalam berbagai bahasa untuk setiap pengguna. Pengguna yang kembali akan selalu disambut dalam bahasa yang sama.

Sebelum aplikasi dapat menyimpan preferensi untuk pengguna, Anda memerlukan cara untuk menyimpan informasi tentang pengguna saat ini dalam sesi. Aplikasi contoh ini menggunakan Firestore untuk menyimpan data sesi.

Anda dapat menggunakan Firestore session handler untuk menggunakan Firestore untuk sesi PHP.

Diagram berikut mengilustrasikan cara Firestore menangani sesi untuk aplikasi App Engine.

Setelah Anda menetapkan session_set_save_handler, setiap permintaan akan memiliki variabel global $_SESSION yang dapat Anda gunakan untuk mengakses sesi. Data sesi disimpan di Firestore.

Berjalan secara lokal

1. Mulai server web PHP bawaan:

   php -S localhost:8080
   

2. Lihat aplikasi di browser web Anda:

   Cloud Shell

   Di toolbar Cloud Shell, klik Web preview dan pilih Preview on port 8080.

   Mesin lokal

   Di browser Anda, buka http://localhost:8080

   Anda akan melihat salah satu dari lima sapaan: “Hello World”, “Hallo Welt”, "Hola mundo”, “Salut le Monde”, atau “Ciao Mondo”. Bahasa akan berubah jika Anda membuka halaman di browser lain atau dalam mode penyamaran. Anda dapat melihat dan mengedit data sesi di Google Cloud konsol.

   

3. Untuk menghentikan server HTTP, di jendela terminal, tekan Control+C.

Men-deploy dan menjalankan di App Engine

Anda dapat menggunakan lingkungan standar App Engine untuk membangun dan men-deploy aplikasi yang berjalan secara andal dalam beban berat dan dengan data dalam jumlah besar.

Tutorial ini menggunakan lingkungan standar App Engine untuk men-deploy server.

1. Di jendela terminal, buat file app.yaml dan salin kode berikut:

   runtime: php73
   

2. Deploy aplikasi di App Engine:

   gcloud app deploy
   

3. Untuk melihat aplikasi aktif, masukkan URL berikut:

   https://PROJECT_ID.REGION_ID.r.appspot.com

   Ganti kode berikut:

   • PROJECT_ID: Project ID Anda Google Cloud
   • REGION_ID: Kode yang ditetapkan App Engine ke aplikasi Anda

Sapaan kini dikirim oleh server web yang berjalan pada instance App Engine.

Menghapus sesi

PHP melakukan pembersihan sampah memori (GC) sesi, yang menghapus sesi lama dan yang telah berakhir sesuai dengan konfigurasi php.ini Anda. Penangan sesi Firestore tidak membersihkan sesi secara default, tetapi Anda dapat mengonfigurasinya untuk melakukannya dengan meneruskan opsi gcLimit saat membuat penangan sesi:

$handler = $firestore->sessionHandler(['gcLimit' => 500]);

Sesi dihapus menggunakan GC sesi berbasis probabilitas, atau saat Anda memanggil fungsi session_gc secara eksplisit.

Men-debug aplikasi

Jika Anda tidak dapat terhubung ke aplikasi App Engine, periksa hal-hal berikut:

1. Pastikan perintah deployment gcloud berhasil diselesaikan dan tidak menampilkan error apa pun. Jika ada error (misalnya, message=Build failed), perbaiki, lalu coba deploy aplikasi App Engine lagi.

2. Di Google Cloud konsol, buka halaman Logs Explorer.

   Buka halaman Logs Explorer

   1. Di menu drop-down Recently selected resources, klik App Engine Application, lalu klik All module_id. Anda akan melihat daftar permintaan dari saat Anda mengunjungi aplikasi. Jika tidak melihat daftar permintaan, pastikan Anda memilih All module_id dari menu drop-down. Jika Anda melihat pesan error yang dicetak ke Google Cloud konsol, pastikan kode aplikasi Anda cocok dengan kode di bagian tentang menulis aplikasi web.

   2. Pastikan Firestore API diaktifkan.

Pembersihan

Menghapus project

Perhatian: Menghapus project memiliki efek berikut:

• Semua hal dalam project akan dihapus. Jika menggunakan project yang sudah ada untuk tugas dalam dokumen ini, saat Anda menghapusnya, pekerjaan lain yang telah Anda lakukan dalam project tersebut juga akan terhapus.
• Project ID kustom hilang. Saat membuat project ini, Anda mungkin telah membuat project ID kustom yang ingin digunakan di masa mendatang. Untuk mempertahankan URL yang menggunakan project ID, seperti URL appspot.com, hapus resource yang dipilih di dalam project, bukan menghapus seluruh project.

Jika Anda berencana mempelajari beberapa arsitektur, tutorial atau panduan memulai, dengan menggunakan kembali project dapat membantu Anda agar tidak melampaui batas kuota project.

1. Di Google Cloud konsol, buka halaman Manage resources.

   Buka Kelola resource

2. Pada daftar project, pilih project yang Anda ingin Anda hapus, lalu klik Delete.
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Menghapus instance App Engine

1. Di Google Cloud konsol, buka halaman Versions untuk App Engine.

   Buka Versi

2. Pilih kotak centang untuk versi aplikasi non-default yang ingin Anda hapus.
   Catatan: Satu-satunya cara untuk menghapus versi default aplikasi App Engine adalah dengan menghapus project Anda. Namun, Anda dapat menghentikan versi default ini di Google Cloud konsol. Tindakan ini akan menonaktifkan semua instance yang terkait dengan versi tersebut. Anda dapat memulai ulang instance ini jika nanti dibutuhkan.

   Di lingkungan standar App Engine, Anda dapat menghentikan versi default hanya jika aplikasi memiliki penskalaan manual atau dasar.

3. Untuk menghapus versi aplikasi, klik Delete.

Langkah berikutnya

• Pelajari App Engine lebih lanjut.
• Tambahkan pemrosesan latar belakang dengan Pub/Sub dan Cloud Run.
• Deploy aplikasi ke Compute Engine.
• Deploy aplikasi ke Google Kubernetes Engine.
• Autentikasi pengguna dengan IAP.