1. סקירה כללית
ב-Codelab הזה תיצרו ממשק אינטרנט ב-Google App Engine, שיאפשר למשתמשים להעלות תמונות מאפליקציית האינטרנט, וגם לעיין בתמונות שהועלו ובתמונות הממוזערות שלהן.

אפליקציית האינטרנט הזו תשתמש ב-framework של CSS שנקראת Bulma, כדי ליצור ממשק משתמש שנראה טוב, וגם ב-framework של ממשק קצה (frontend) ב-JavaScript שנקראת Vue.JS כדי לשלוח קריאה ל-API של האפליקציה שתיצרו.
האפליקציה הזו תכלול שלוש כרטיסיות:
- דף בית שבו יוצגו התמונות הממוזערות של כל התמונות שהועלו, יחד עם רשימת התוויות שמתארות את התמונה (אלה שזוהו על ידי Cloud Vision API בשיעור Lab קודם).
- דף קולאז' שבו יוצג קולאז' של 4 התמונות האחרונות שהועלו.
- דף העלאה, שבו המשתמשים יכולים להעלות תמונות חדשות.
החזית שנוצרת נראית כך:

שלושת הדפים האלה הם דפי HTML פשוטים:
- דף הבית (
index.html) קורא לקוד הקצה העורפי של Node App Engine כדי לקבל את רשימת התמונות הממוזערות והתוויות שלהן, באמצעות קריאת AJAX לכתובת ה-URL/api/pictures. דף הבית משתמש ב-Vue.js כדי לאחזר את הנתונים האלה. - הדף collage (
collage.html) מפנה לתמונהcollage.pngשמרכיבה את 4 התמונות האחרונות. - בדף ההעלאה (
upload.html) יש טופס פשוט להעלאת תמונה באמצעות בקשת POST לכתובת ה-URL/api/pictures.
מה תלמדו
- App Engine
- Cloud Storage
- Cloud Firestore
2. הגדרה ודרישות
הגדרת סביבה בקצב אישי
- נכנסים למסוף Google Cloud ויוצרים פרויקט חדש או משתמשים בפרויקט קיים. אם עדיין אין לכם חשבון Gmail או Google Workspace, אתם צריכים ליצור חשבון.



- שם הפרויקט הוא השם שמוצג למשתתפים בפרויקט. זוהי מחרוזת תווים שלא משמשת את Google APIs, ואפשר לעדכן אותה בכל שלב.
- מזהה הפרויקט חייב להיות ייחודי בכל הפרויקטים ב-Google Cloud, ואי אפשר לשנות אותו אחרי שהוא הוגדר. מסוף Cloud יוצר באופן אוטומטי מחרוזת ייחודית. בדרך כלל לא משנה מה היא. ברוב ה-Codelabs תצטרכו להפנות למזהה הפרויקט (בדרך כלל הוא מזוהה בתור
PROJECT_ID), אז אם אתם לא אוהבים אותו, אתם יכולים ליצור עוד אחד אקראי, או לנסות ליצור אחד משלכם ולבדוק אם הוא זמין. אחרי שיוצרים את הפרויקט, הערך הזה "מוקפא". - יש ערך שלישי, מספר פרויקט, שמשמש בחלק מממשקי ה-API. מידע נוסף על שלושת הערכים האלה זמין במסמכי התיעוד.
- בשלב הבא, תצטרכו להפעיל את החיוב במסוף Cloud כדי להשתמש במשאבים או בממשקי ה-API של Cloud. ההרצה של ה-Codelab הזה לא אמורה לעלות הרבה, אם בכלל. כדי להשבית משאבים כדי שלא תצברו חיובים מעבר ל-Codelab הזה, צריך לפעול לפי ההוראות ל"ניקוי" בסוף ה-Codelab. משתמשים חדשים ב-Google Cloud זכאים לתוכנית תקופת ניסיון בחינם בשווי 300$.
הפעלת Cloud Shell
אפשר להפעיל את Google Cloud מרחוק מהמחשב הנייד, אבל ב-Codelab הזה תשתמשו ב-Google Cloud Shell, סביבה של שורת פקודה שפועלת ב-Cloud.
במסוף Google Cloud, לוחצים על הסמל של Cloud Shell בסרגל הכלים שבפינה הימנית העליונה:

ההקצאה והחיבור לסביבה אמורים להימשך רק כמה רגעים. בסיום התהליך, אמור להופיע משהו כזה:

המכונה הווירטואלית הזו כוללת את כל הכלים למפתחים שתצטרכו. יש בה ספריית בית בנפח מתמיד של 5GB והיא פועלת ב-Google Cloud, מה שמשפר מאוד את ביצועי הרשת והאימות. את כל העבודה ב-Lab הזה אפשר לעשות פשוט באמצעות דפדפן.
3. הפעלת ממשקי ה-API
כדי להשתמש ב-App Engine צריך את Compute Engine API. מוודאים שהתכונה מופעלת:
gcloud services enable compute.googleapis.com
הפעולה אמורה להסתיים בהצלחה:
Operation "operations/acf.5c5ef4f6-f734-455d-b2f0-ee70b5a17322" finished successfully.
4. שכפול הקוד
אם עדיין לא עשיתם זאת, הורידו את הקוד:
git clone https://github.com/GoogleCloudPlatform/serverless-photosharing-workshop
אחרי כן אפשר לעבור לספרייה שמכילה את ממשק המשתמש:
cd serverless-photosharing-workshop/frontend
פריסת הקבצים של ממשק המשתמש תיראה כך:
frontend
|
├── index.js
├── package.json
├── app.yaml
|
├── public
|
├── index.html
├── collage.html
├── upload.html
|
├── app.js
├── script.js
├── style.css
ברמה הבסיסית של הפרויקט יש 3 קבצים:
-
index.jsמכיל את הקוד של Node.js -
package.jsonמגדיר את יחסי התלות של הספרייה -
app.yamlהוא קובץ התצורה של Google App Engine
תיקיית public מכילה את המשאבים הסטטיים:
index.htmlהוא הדף שבו מוצגות כל התמונות הממוזערות והתוויות-
collage.htmlמציג את הקולאז' של התמונות האחרונות - ב-
upload.htmlיש טופס להעלאת תמונות חדשות -
app.jsמשתמש ב-Vue.js כדי לאכלס את הדףindex.htmlבנתונים -
script.jsמטפל בתפריט הניווט ובסמל ה "המבורגר" שלו במסכים קטנים -
style.cssמגדיר כמה הוראות CSS
5. עיון בקוד
יחסי תלות
בקובץ package.json מוגדרים יחסי התלות הנדרשים של הספרייה:
{
"name": "frontend",
"version": "0.0.1",
"main": "index.js",
"scripts": {
"start": "node index.js"
},
"dependencies": {
"@google-cloud/firestore": "^3.4.1",
"@google-cloud/storage": "^4.0.0",
"express": "^4.16.4",
"dayjs": "^1.8.22",
"bluebird": "^3.5.0",
"express-fileupload": "^1.1.6"
}
}
האפליקציה שלנו תלויה בגורמים הבאים:
- firestore: כדי לגשת ל-Cloud Firestore עם המטא-נתונים של התמונות,
- storage: כדי לגשת ל-Google Cloud Storage שבו התמונות מאוחסנות,
- express: מסגרת האינטרנט של Node.js,
- dayjs: ספרייה קטנה להצגת תאריכים בצורה ידידותית למשתמש,
- bluebird: ספריית JavaScript promise,
- thought express-fileupload: ספרייה לטיפול קל בהעלאות קבצים.
קצה קדמי של Express
בתחילת הבקר index.js, תצטרכו את כל יחסי התלות שהוגדרו ב-package.json קודם לכן:
const express = require('express');
const fileUpload = require('express-fileupload');
const Firestore = require('@google-cloud/firestore');
const Promise = require("bluebird");
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const path = require('path');
const dayjs = require('dayjs');
const relativeTime = require('dayjs/plugin/relativeTime')
dayjs.extend(relativeTime)
בשלב הבא, נוצר המופע של אפליקציית Express.
נעשה שימוש בשני רכיבי תוכנת ביניים של Express:
- הקריאה
express.static()מציינת שמשאבים סטטיים יהיו זמינים בספריית המשנהpublic. - הפקודה
fileUpload()מגדירה את העלאת הקבצים כך שגודל הקובץ מוגבל ל-10MB, כדי להעלות את הקבצים באופן מקומי במערכת הקבצים בזיכרון בספרייה/tmp.
const app = express();
app.use(express.static('public'));
app.use(fileUpload({
limits: { fileSize: 10 * 1024 * 1024 },
useTempFiles : true,
tempFileDir : '/tmp/'
}))
בין המשאבים הסטטיים, יש לכם את קובצי ה-HTML של דף הבית, דף הקולאז' ודף ההעלאה. הדפים האלה יקראו לקצה העורפי של ה-API. ל-API הזה יהיו נקודות הקצה הבאות:
-
POST /api/picturesבאמצעות הטופס ב-upload.html, תמונות יועלו באמצעות בקשת POST GET /api/picturesנקודת הקצה הזו מחזירה מסמך JSON שמכיל את רשימת התמונות והתוויות שלהןGET /api/pictures/:nameכתובת ה-URL הזו מפנה למיקום של התמונה בגודל מלא ב-Cloud Storage-
GET /api/thumbnails/:nameכתובת ה-URL הזו מפנה למיקום של התמונה הממוזערת ב-Cloud Storage -
GET /api/collageכתובת ה-URL האחרונה הזו מפנה למיקום ב-Cloud Storage שבו נשמרת תמונת הקולאז' שנוצרה.
העלאת תמונה
לפני שבוחנים את קוד ה-Node.js להעלאת תמונות, כדאי לעיין ב-public/upload.html.
...
<form method="POST" action="/api/pictures" enctype="multipart/form-data">
...
<input type="file" name="pictures">
<button>Submit</button>
...
</form>
...
רכיב הטופס מפנה לנקודת הקצה /api/pictures, בשיטת HTTP POST ובפורמט מרובה חלקים. עכשיו index.js צריך להגיב לנקודת הקצה ול-method האלה, ולחלץ את הקבצים:
app.post('/api/pictures', async (req, res) => {
if (!req.files || Object.keys(req.files).length === 0) {
console.log("No file uploaded");
return res.status(400).send('No file was uploaded.');
}
console.log(`Receiving files ${JSON.stringify(req.files.pictures)}`);
const pics = Array.isArray(req.files.pictures) ? req.files.pictures : [req.files.pictures];
pics.forEach(async (pic) => {
console.log('Storing file', pic.name);
const newPicture = path.resolve('/tmp', pic.name);
await pic.mv(newPicture);
const pictureBucket = storage.bucket(process.env.BUCKET_PICTURES);
await pictureBucket.upload(newPicture, { resumable: false });
});
res.redirect('/');
});
קודם כול, אתם בודקים שאכן מתבצעת העלאה של קבצים. לאחר מכן, אתם מורידים את הקבצים באופן מקומי באמצעות השיטה mv שמגיעה מהמודול Node להעלאת קבצים. עכשיו, כשהקבצים זמינים במערכת הקבצים המקומית, אתם מעלים את התמונות לקטגוריה של Cloud Storage. בסיום, אתם מפנים את המשתמש בחזרה למסך הראשי של האפליקציה.
הצגת רשימת התמונות
הגיע הזמן להציג את התמונות היפות שלכם!
ב-handler של /api/pictures, אתם בודקים את האוסף pictures של מסד הנתונים של Firestore כדי לאחזר את כל התמונות (שהתמונה הממוזערת שלהן נוצרה), בסדר יורד לפי תאריך היצירה.
אתם דוחפים כל תמונה למערך ב-JavaScript, עם השם שלה, התוויות שמתארות אותה (שמגיעות מ-Cloud Vision API), הצבע הדומיננטי ותאריך יצירה ידידותי (עם dayjs, אנחנו משתמשים בהיסטים של הזמן שחלף כמו "בעוד 3 ימים").
app.get('/api/pictures', async (req, res) => {
console.log('Retrieving list of pictures');
const thumbnails = [];
const pictureStore = new Firestore().collection('pictures');
const snapshot = await pictureStore
.where('thumbnail', '==', true)
.orderBy('created', 'desc').get();
if (snapshot.empty) {
console.log('No pictures found');
} else {
snapshot.forEach(doc => {
const pic = doc.data();
thumbnails.push({
name: doc.id,
labels: pic.labels,
color: pic.color,
created: dayjs(pic.created.toDate()).fromNow()
});
});
}
console.table(thumbnails);
res.send(thumbnails);
});
הבקר הזה מחזיר תוצאות בצורה הבאה:
[
{
"name": "IMG_20180423_163745.jpg",
"labels": [
"Dish",
"Food",
"Cuisine",
"Ingredient",
"Orange chicken",
"Produce",
"Meat",
"Staple food"
],
"color": "#e78012",
"created": "a day ago"
},
...
]
מבנה הנתונים הזה נצרך על ידי קטע קוד קטן של Vue.js מהדף index.html. זו גרסה פשוטה של תגי העיצוב מהדף הזה:
<div id="app">
<div class="container" id="app">
<div id="picture-grid">
<div class="card" v-for="pic in pictures">
<div class="card-content">
<div class="content">
<div class="image-border" :style="{ 'border-color': pic.color }">
<a :href="'/api/pictures/' + pic.name">
<img :src="'/api/thumbnails/' + pic.name">
</a>
</div>
<a class="panel-block" v-for="label in pic.labels" :href="'/?q=' + label">
<span class="panel-icon">
<i class="fas fa-bookmark"></i>
</span>
{{ label }}
</a>
</div>
</div>
</div>
</div>
</div>
</div>
המזהה של ה-div יציין ל-Vue.js שזה החלק של תגי העיצוב שירונדר באופן דינמי. האיטרציות מתבצעות בזכות ההוראות של v-for.
התמונות מקבלות מסגרת צבעונית יפה שתואמת לצבע הדומיננטי בתמונה, כפי שזוהה על ידי Cloud Vision API, ואנחנו מצביעים על התמונות הממוזערות ועל התמונות ברוחב מלא במקורות הקישורים והתמונות.
לבסוף, אנחנו מציגים את התוויות שמתארות את התמונה.
זהו קוד ה-JavaScript של קטע הקוד של Vue.js (בקובץ public/app.js שיובא בתחתית הדף index.html):
var app = new Vue({
el: '#app',
data() {
return { pictures: [] }
},
mounted() {
axios
.get('/api/pictures')
.then(response => { this.pictures = response.data })
}
})
קוד ה-Vue משתמש בספריית Axios כדי לבצע קריאת AJAX לנקודת הקצה /api/pictures. הנתונים שמוחזרים מקושרים לקוד התצוגה בתגי העיצוב שראיתם קודם.
צפייה בתמונות
בindex.html המשתמשים שלנו יכולים לראות את התמונות הממוזערות, ללחוץ עליהן כדי לראות את התמונות בגודל מלא, ובcollage.html המשתמשים רואים את התמונה collage.png.
בתגי העיצוב של ה-HTML של הדפים האלה, התמונה src והקישור href מפנים ל-3 נקודות הקצה האלה, שמפנות למיקומים ב-Cloud Storage של התמונות, התמונות הממוזערות והקולאז'. אין צורך להוסיף את הנתיב בתוך הקוד של תגי העיצוב ב-HTML.
app.get('/api/pictures/:name', async (req, res) => {
res.redirect(`https://storage.cloud.google.com/${process.env.BUCKET_PICTURES}/${req.params.name}`);
});
app.get('/api/thumbnails/:name', async (req, res) => {
res.redirect(`https://storage.cloud.google.com/${process.env.BUCKET_THUMBNAILS}/${req.params.name}`);
});
app.get('/api/collage', async (req, res) => {
res.redirect(`https://storage.cloud.google.com/${process.env.BUCKET_THUMBNAILS}/collage.png`);
});
הרצת אפליקציית Node
אחרי שכל נקודות הקצה מוגדרות, אפליקציית Node.js מוכנה להפעלה. אפליקציית Express מאזינה ליציאה 8080 כברירת מחדל, והיא מוכנה לשרת בקשות נכנסות.
const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
console.log(`Started web frontend service on port ${PORT}`);
console.log(`- Pictures bucket = ${process.env.BUCKET_PICTURES}`);
console.log(`- Thumbnails bucket = ${process.env.BUCKET_THUMBNAILS}`);
});
6. בדיקה מקומית
לבדוק את הקוד באופן מקומי כדי לוודא שהוא פועל לפני שפורסים אותו בענן.
צריך לייצא את שני משתני הסביבה שתואמים לשתי הקטגוריות של Cloud Storage:
export BUCKET_THUMBNAILS=thumbnails-${GOOGLE_CLOUD_PROJECT}
export BUCKET_PICTURES=uploaded-pictures-${GOOGLE_CLOUD_PROJECT}
בתוך התיקייה frontend, מתקינים את יחסי התלות של npm ומפעילים את השרת:
npm install; npm start
אם הכול תקין, השרת אמור להתחיל לפעול ביציאה 8080:
Started web frontend service on port 8080
- Pictures bucket = uploaded-pictures-${GOOGLE_CLOUD_PROJECT}
- Thumbnails bucket = thumbnails-${GOOGLE_CLOUD_PROJECT}
השמות האמיתיים של הקטגוריות יופיעו ביומנים האלה, וזה יכול לעזור לכם לנפות באגים.
מ-Cloud Shell, אתם יכולים להשתמש בתכונה בגרסת טרום-השקה (Preview) של תצוגה מקדימה באינטרנט כדי לעיין באפליקציה שפועלת באופן מקומי:

כדי לצאת מהמצב הזה, אפשר ללחוץ על CTRL-C.
7. פריסה ב-App Engine
האפליקציה מוכנה לפריסה.
הגדרת App Engine
בודקים את קובץ התצורה app.yaml של App Engine:
runtime: nodejs16 env_variables: BUCKET_PICTURES: uploaded-pictures-GOOGLE_CLOUD_PROJECT BUCKET_THUMBNAILS: thumbnails-GOOGLE_CLOUD_PROJECT
בשורה הראשונה מצהירים שסביבת זמן הריצה מבוססת על Node.js 10. שני משתני סביבה מוגדרים כך שיצביעו על שני הקטגוריות, לתמונות המקוריות ולתמונות הממוזערות.
כדי להחליף את GOOGLE_CLOUD_PROJECT במזהה הפרויקט, אפשר להריץ את הפקודה הבאה:
sed -i -e "s/GOOGLE_CLOUD_PROJECT/${GOOGLE_CLOUD_PROJECT}/" app.yaml
פריסה
מגדירים את האזור המועדף ל-App Engine, ומוודאים שמשתמשים באותו אזור כמו בשיעורי ה-Lab הקודמים:
gcloud config set compute/region europe-west1
ולפרוס:
gcloud app deploy
אחרי דקה או שתיים, תופיע הודעה שהאפליקציה משרתת תנועה:
Beginning deployment of service [default]... ╔════════════════════════════════════════════════════════════╗ ╠═ Uploading 8 files to Google Cloud Storage ═╣ ╚════════════════════════════════════════════════════════════╝ File upload done. Updating service [default]...done. Setting traffic split for service [default]...done. Deployed service [default] to [https://GOOGLE_CLOUD_PROJECT.appspot.com] You can stream logs from the command line by running: $ gcloud app logs tail -s default To view your application in the web browser run: $ gcloud app browse
אפשר גם להיכנס לקטע App Engine במסוף Cloud כדי לראות שהאפליקציה נפרסה, ולבדוק את התכונות של App Engine, כמו ניהול גרסאות וחלוקת התנועה:

8. בדיקת האפליקציה
כדי לבדוק, עוברים לכתובת ה-URL של האפליקציה שמוגדרת כברירת מחדל ב-App Engine (https://<YOUR_PROJECT_ID>.appspot.com/) ורואים שממשק המשתמש של החזית פועל.

9. ניקוי (אופציונלי)
אם אתם לא מתכוונים להשאיר את האפליקציה, אתם יכולים למחוק את הפרויקט כולו כדי לנקות משאבים, לחסוך בעלויות ולהיות משתמשי ענן טובים:
gcloud projects delete ${GOOGLE_CLOUD_PROJECT}
10. מעולה!
מעולה! אפליקציית האינטרנט הזו ב-Node.js, שמתארחת ב-App Engine, מקשרת בין כל השירותים שלכם ומאפשרת למשתמשים להעלות תמונות ולהציג אותן.
מה למדנו
- App Engine
- Cloud Storage
- Cloud Firestore