טיפול בסשנים באמצעות Firestore

במדריך הזה מוסבר איך לנהל סשנים ב-App Engine.

באפליקציות רבות נדרש ניהול סשנים לצורך אימות והעדפות משתמש. ‫PHP מגיעה עם הטמעה מבוססת-זיכרון לביצוע הפונקציה הזו. עם זאת, ההטמעה הזו לא מתאימה לאפליקציה שאפשר להציג ממספר מופעים, כי יכול להיות שהביקור שתועד במופע אחד יהיה שונה ממופעים אחרים.

מטרות

• כותבים את האפליקציה.
• מריצים את האפליקציה באופן מקומי.
• פורסים את האפליקציה ב-App Engine.

עלויות

במסמך הזה משתמשים ברכיבים הבאים של Google Cloud, והשימוש בהם כרוך בתשלום:

• App Engine
• Firestore

כדי להעריך את ההוצאות בהתאם לתחזית השימוש שלכם, אתם יכולים להיעזר במחשבון העלויות.

משתמשים חדשים של Google Cloud ? יכול להיות שאתם זכאים לתקופת ניסיון בחינם.

כשמסיימים את המשימות שמתוארות במסמך הזה אפשר למחוק את המשאבים שיצרתם כדי להימנע מחיובים נוספים. מידע נוסף זמין בקטע הסרת המשאבים.

לפני שמתחילים

נכנסים לחשבון Google Cloud . אם אתם משתמשים חדשים ב- Google Cloud, צרו חשבון כדי שתוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.

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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

1. מגדירים שה-CLI של gcloud ישתמש בפרויקט החדש Google Cloud :

   # Configure gcloud for your project
   gcloud config set project PROJECT_ID

   מחליפים את PROJECT_ID במזהה הפרויקט שיצרתם או שבחרתם קודם. Google Cloud

הגדרת הפרויקט

1. בחלון המסוף, מתחילים בספרייה לפי בחירתכם ויוצרים ספרייה חדשה בשם sessions. כל הקוד של המדריך הזה נמצא בספרייה sessions.

2. עוברים לספרייה sessions:

   cd sessions
   

3. מתקינים את יחסי התלות:

   composer require google/cloud-firestore
   

בסוף המדריך הזה, מבנה הקבצים הסופי יהיה דומה לזה:

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

כתיבת האפליקציה

• בחלון הטרמינל, יוצרים קובץ בשם index.php עם התוכן הבא:

  <?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');
  }
  

האפליקציה הזו מציגה ברכות בשפות שונות לכל משתמש. משתמשים חוזרים תמיד מקבלים את פניית המערכת באותה שפה.

לפני שהאפליקציה יכולה לאחסן העדפות של משתמש, צריך לאחסן מידע על המשתמש הנוכחי בסשן. אפליקציית הדוגמה הזו משתמשת ב-Firestore לאחסון נתוני סשנים.

אפשר להשתמש ב-Firestore session handler כדי להשתמש ב-Firestore עבור סשנים של PHP.

הדיאגרמה הבאה ממחישה איך Firestore מטפל בסשנים באפליקציית App Engine.

אחרי שמגדירים את session_set_save_handler, לכל בקשה יש משתנה גלובלי $_SESSION שאפשר להשתמש בו כדי לגשת לסשן. נתוני הסשן מאוחסנים ב-Firestore.

הרצה מקומית

1. מפעילים את שרת האינטרנט המובנה של PHP:

   php -S localhost:8080
   

2. צפייה באפליקציה בדפדפן אינטרנט:

   Cloud Shell

   בסרגל הכלים של Cloud Shell, לוחצים על Web preview (תצוגה מקדימה של אתר) ובוחרים באפשרות Preview on port 8080 (תצוגה מקדימה ביציאה 8080).

   מכונה מקומית

   בדפדפן, עוברים אל http://localhost:8080

   מוצגת אחת מ-5 ברכות: Hello World,‏ Hallo Welt,‏ Hola mundo,‏ Salut le Monde או Ciao Mondo. השפה משתנה אם פותחים את הדף בדפדפן אחר או במצב פרטי. אפשר לראות ולערוך את נתוני הסשן בGoogle Cloud מסוף.

   

3. כדי לעצור את שרת ה-HTTP, בחלון הטרמינל לוחצים על Control+C.

פריסה והרצה ב-App Engine

אתם יכולים להשתמש בסביבה רגילה של App Engine כדי ליצור ולפרוס אפליקציה שפועלת בצורה מהימנה בעומס כבד ועם כמויות גדולות של נתונים.

במדריך הזה משתמשים בסביבה הרגילה של App Engine כדי לפרוס את השרת.

1. בחלון הטרמינל, יוצרים קובץ app.yaml ומעתיקים את הטקסט הבא:

   runtime: php73
   

2. פורסים את האפליקציה ב-App Engine:

   gcloud app deploy
   

3. כדי לראות את האפליקציה הפעילה, מזינים את כתובת ה-URL הבאה:

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

   מחליפים את מה שכתוב בשדות הבאים:

   • ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud
   • ‫REGION_ID: קוד שמוקצה לאפליקציה על ידי App Engine

ההודעה מועברת עכשיו על ידי שרת אינטרנט שפועל במופע של App Engine.

מחיקת סשנים

ב-PHP מתבצעת איסוף אשפה (GC) של סשנים, שמיועד להסרת סשנים ישנים ותוקפם פג, בהתאם להגדרה של php.ini. כברירת מחדל, handler הסשן של Firestore לא מנקה את הסשנים, אבל אפשר להגדיר אותו כך שיעשה זאת על ידי העברת אפשרות gcLimit כשיוצרים את handler הסשן:

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

הסשנים מוסרים באמצעות GC של סשנים שמבוסס על הסתברות, או כשקוראים לפונקציה session_gc באופן מפורש.

ניפוי באגים באפליקציה

אם אתם לא מצליחים להתחבר לאפליקציית App Engine, כדאי לבדוק את הדברים הבאים:

1. בודקים שהפקודות gcloud deploy הושלמו בהצלחה ולא הוחזרו שגיאות. אם היו שגיאות (לדוגמה, message=Build failed), צריך לתקן אותן ולנסות שוב לפרוס את אפליקציית App Engine.

2. נכנסים לדף Logs Explorer במסוף Google Cloud .

   כניסה לדף Logs Explorer

   1. בתפריט הנפתח Recently selected resources (משאבים שנבחרו לאחרונה), לוחצים על App Engine Application (אפליקציית App Engine) ואז על All module_id (כל מזהי המודולים). מוצגת רשימה של בקשות מהביקור שלכם באפליקציה. אם לא מוצגת רשימה של בקשות, צריך לוודא שבחרתם באפשרות All module_id מהרשימה הנפתחת. אם הודעות השגיאה מודפסות ב Google Cloud מסוף, צריך לוודא שהקוד של האפליקציה זהה לקוד שבקטע על כתיבת אפליקציית האינטרנט.

   2. מוודאים ש-Firestore API מופעל.

הסרת המשאבים

מחיקת הפרויקט

זהירות: כשמוחקים פרויקט:

• התוכן של הפרויקט נמחק כולו. אם השתמשתם בפרויקט קיים כדי לתרגל את המשימות במדריך הזה, כשתמחקו אותו תימחק גם כל העבודה שביצעתם באותו פרויקט.
• מאבדים את מזהה הפרויקט בהתאמה אישית. כשיצרתם את הפרויקט, יכולתם לבחור לו מזהה פרויקט בהתאמה אישית כדי להשתמש בו בעתיד. כדי לשמור על כתובות ה-URL שמשתמשות במזהה הפרויקט, כמו appspot.com, צריך למחוק את המשאבים שנבחרו בפרויקט אבל לא את הפרויקט כולו.

אם אתם מתכננים להיעזר בכמה ארכיטקטורות, מדריכים או מדריכים למתחילים, מומלץ להשתמש שוב באותו פרויקט כדי לא לחרוג ממכסות הפרויקטים.

1. במסוף Google Cloud , נכנסים לדף Manage resources.

   כניסה לדף Manage resources

2. ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete.
3. כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.

מחיקת מכונת App Engine

1. במסוף Google Cloud , נכנסים לדף Versions של App Engine.

   כניסה לדף Versions

2. מסמנים את התיבה שלצד גרסת האפליקציה שלא מוגדרת כברירת מחדל ושרוצים למחוק.
   הערה: אפשר למחוק את גרסת ברירת המחדל של אפליקציית App Engine רק על ידי מחיקת הפרויקט. עם זאת, אפשר להפסיק את גרסת ברירת המחדל במסוף Google Cloud . כל המכונות שקשורות לגרסה יכובו. במידת הצורך, אפשר יהיה להפעיל מחדש את המכונות בהמשך.

   בסביבה הרגילה של App Engine, אפשר להפסיק את גרסת ברירת המחדל רק אם ההתאמה לעומס (scaling) של האפליקציה היא ידנית או בסיסית.

3. כדי למחוק את גרסת האפליקציה, לוחצים על Delete.

המאמרים הבאים

• מידע נוסף על App Engine
• הוספת עיבוד ברקע באמצעות Pub/Sub ו-Cloud Run.
• פריסת אפליקציה ב-Compute Engine.
• פריסת אפליקציה ב-Google Kubernetes Engine
• אימות משתמשים באמצעות IAP.