‫Pic-a-daily: آزمایشگاه ۴—ایجاد فرانت‌اند وب

۱. نمای کلی

در این codelab، یک میانای وب در Google App Engine ایجاد می‌کنید که به کاربران اجازه می‌دهد تصاویر را از برنامه وب بارگذاری کنند و همچنین تصاویر بارگذاری‌شده و ریزعکس‌های آن‌ها را مرور کنند.

21741cd63b425aeb.png

این برنامه وب از چارچوب CSS به‌نام Bulma برای داشتن میانای کاربر زیبا و همچنین چارچوب پیشانه جاوااسکریپت Vue.JS برای فراخوانی میانای برنامه‌سازی کاربردی برنامه که خواهید ساخت استفاده خواهد کرد.

این برنامه از سه برگه تشکیل شده است:

  • صفحه اصلی که تصاویر کوچک همه عکس‌های بارگذاری‌شده را به‌همراه فهرست برچسب‌های توصیف‌کننده عکس (برچسب‌هایی که Cloud Vision API در آزمایشگاه قبلی شناسایی کرده است) نمایش می‌دهد.
  • صفحه کلاژ که کلاژ ساخته‌شده از ۴ عکس جدید بارگذاری‌شده را نشان می‌دهد.
  • صفحه بارگذاری که کاربران می‌توانند تصاویر جدید را در آن بارگذاری کنند.

نمای ظاهری حاصل به‌صورت زیر است:

6a4d5e5603ba4b73.png

این ۳ صفحه، صفحه‌های HTML ساده هستند:

  • صفحه اصلی (index.html) کد پسین Node App Engine را فراخوانی می‌کند تا فهرست تصاویر کوچک و برچسب‌های آن‌ها را ازطریق فراخوانی AJAX به نشانی وب /api/pictures دریافت کند. صفحه اصلی از Vue.js برای واکشی این داده‌ها استفاده می‌کند.
  • صفحه کلاژ (collage.html) به تصویر collage.png اشاره می‌کند که ۴ عکس آخر را جمع‌آوری می‌کند.
  • صفحه بارگذاری (upload.html) فرم ساده‌ای برای بارگذاری تصویر ازطریق درخواست POST به نشانی وب /api/pictures ارائه می‌دهد.

آنچه خواهید آموخت

  • App Engine
  • فضای ذخیره‌سازی ابری
  • Cloud Firestore

۲. راه‌اندازی و شرایط لازم

راه‌اندازی محیط با سرعت دلخواه

  1. به سیستم کنسول Google Cloud وارد شوید و پروژه جدیدی ایجاد کنید یا از پروژه موجودی دوباره استفاده کنید. اگر ازقبل حساب Gmail یا Google Workspace ندارید، باید حسابی ایجاد کنید.

b35bf95b8bf3d5d8.pnga99b7ace416376c4.pngbd84a6d3004737c5.png

  • نام پروژه نام نمایشی برای شرکت‌کنندگان این پروژه است. این رشته نویسه‌ای است که Google APIs از آن استفاده نمی‌کند و هرزمان بخواهید می‌توانید آن را به‌روز کنید.
  • شناسه پروژه باید در همه پروژه‌های Google Cloud یکتا باشد و تغییرناپذیر است (پس‌از تنظیم شدن نمی‌توان آن را تغییر داد). «کنسول Cloud» به‌طور خودکار یک رشته یکتا تولید می‌کند؛ معمولاً برایتان مهم نیست که این رشته چیست. در اکثر codelabها، باید به «شناسه پروژه» ارجاع دهید (و معمولاً به‌صورت PROJECT_ID شناسایی می‌شود)، بنابراین اگر آن را دوست ندارید، یک شناسه تصادفی دیگر تولید کنید، یا می‌توانید شناسه خودتان را امتحان کنید و ببینید دردسترس است یا نه. سپس بعداز ایجاد پروژه، «ثابت» می‌شود.
  • مقدار سومی هم وجود دارد، شماره پروژه که برخی‌از میاناهای برنامه‌سازی کاربردی از آن استفاده می‌کنند. در اسناد درباره هر سه مقدار بیشتر بدانید.
  1. سپس، برای استفاده از منابع/ میاناهای برنامه‌سازی کاربردی Cloud، باید صورت‌حساب را در Cloud Console فعال کنید. اجرای این codelab نباید هزینه زیادی داشته باشد، اگر اصلاً هزینه‌ای داشته باشد. برای خاموش کردن منابع به‌منظور جلوگیری از صدور صورت‌حساب فراتر از این آموزش، دستورالعمل‌های «پاک‌سازی» را که در پایان codelab آمده است دنبال کنید. کاربران جدید Google Cloud واجدشرایط برنامه دوره آزمایشی رایگان ۳۰۰ دلاری هستند.

شروع Cloud Shell

درحالی‌که Google Cloud را می‌توان از راه دور از رایانه کیفی شما اجرا کرد، در این codelab از Google Cloud Shell استفاده خواهید کرد که یک محیط خط فرمان است که در Cloud اجرا می‌شود.

از کنسول Google Cloud، روی نماد Cloud Shell در نوار ابزار بالا سمت چپ کلیک کنید:

55efc1aaa7a4d3ad.png

تأمین و اتصال به محیط فقط چند لحظه طول می‌کشد. وقتی تمام شد، باید چیزی شبیه به این ببینید:

7ffe5cbb04455448.png

این ماشین مجازی با همه ابزارهای توسعه‌ای که نیاز دارید بارگیری شده است. این ابزار یک دایرکتوری خانگی دائمی ۵ گیگابایتی ارائه می‌دهد و در Google Cloud اجرا می‌شود که عملکرد شبکه و اصالت‌سنجی را به‌طور قابل‌توجهی بهبود می‌بخشد. تمام کارهای شما در این آزمایشگاه را می‌توان به‌سادگی با یک مرورگر انجام داد.

۳. فعال کردن میاناهای برنامه‌سازی کاربردی

‫App Engine به Compute Engine API نیاز دارد. مطمئن شوید فعال باشد:

gcloud services enable compute.googleapis.com

باید ببینید که عملیات باموفقیت تکمیل شده است:

Operation "operations/acf.5c5ef4f6-f734-455d-b2f0-ee70b5a17322" finished successfully.

۴. کلون کردن کد

اگر قبلاً کد را بررسی نکرده‌اید، اکنون این کار را انجام دهید:

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

در ریشه پروژه ما، ۳ فایل دارید:

  • 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 را تعریف می‌کند

۵. کاوش کد

وابستگی‌ها

فایل 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 با فراداده تصویر ما،
  • فضای ذخیره‌سازی: برای دسترسی به Google Cloud Storage که تصاویر در آن ذخیره شده‌اند،
  • express: چارچوب وب برای Node.js،
  • dayjs: کتابخانه‌ای کوچک برای نمایش تاریخ‌ها به‌صورت کاربرپسند،
  • bluebird: کتابخانه JavaScript promise،
  • 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() بارگذاری فایل را پیکربندی می‌کند تا اندازه فایل را به ۱۰ مگابایت محدود کند، تا فایل‌ها را به‌صورت محلی در سیستم فایل درون‌حافظه‌ای در فهرست راهنمای /tmp بارگذاری کند.
const app = express();
app.use(express.static('public'));
app.use(fileUpload({
    limits: { fileSize: 10 * 1024 * 1024 },
    useTempFiles : true,
    tempFileDir : '/tmp/'
}))

در میان منابع ایستا، فایل‌های HTML برای صفحه اصلی، صفحه کلاژ، و صفحه بارگذاری را دارید. آن صفحه‌ها با API backend تماس می‌گیرند. این میانای برنامه‌سازی کاربردی نقاط پایانی زیر را خواهد داشت:

  • POST /api/pictures ازطریق فرم در upload.html، تصاویر ازطریق درخواست POST بارگذاری خواهند شد
  • GET /api/pictures این نقطه پایانی سند JSON حاوی فهرست تصاویر و برچسب‌های آن‌ها را برمی‌گرداند
  • GET /api/pictures/:name این نشانی وب به مکان فضای ذخیره‌سازی ابری تصویر با اندازه کامل هدایت می‌کند
  • GET /api/thumbnails/:name این نشانی وب به مکان فضای ذخیره‌سازی ابری تصویر کوچک هدایت می‌کند
  • GET /api/collage این آخرین نشانی وب به مکان فضای ذخیره‌سازی ابری تصویر کلاژ تولیدشده هدایت می‌کند

بارگذاری تصویر

پیش‌از کاوش کد 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 باید به آن نقطه پایانی و روش پاسخ دهد و فایل‌ها را استخراج کند:

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 بارگذاری می‌کنید. درنهایت، کاربر را به صفحه اصلی برنامه هدایت می‌کنید.

درحال فهرست کردن عکس‌ها

وقت آن است که عکس‌های زیبایتان را نمایش دهید!

در گرداننده /api/pictures، مجموعه pictures پایگاه داده Firestore را بررسی می‌کنید تا همه تصاویر (که ریزعکس آن‌ها تولید شده است) را به‌ترتیب نزولی تاریخ ایجاد بازیابی کنید.

هر تصویر را در آرایه جاوا اسکریپت با نام آن، برچسب‌های توصیف‌کننده آن (برگرفته از Cloud Vision API)، رنگ غالب، و تاریخ ایجاد دوستانه (با dayjs، ما انحراف‌های زمانی نسبی مانند «۳ روز از اکنون») قرار می‌دهید.

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> &nbsp;
                                                        </span>
                                                        {{ label }}
                                                </a>
                                        </div>
                                </div>
                        </div>
            </div>
        </div>
</div>

شناسه div به Vue.js نشان می‌دهد که این بخش از نشانه‌گذاری است که به‌صورت پویا ارائه خواهد شد. تکرارها به‌لطف دستورالعمل‌های v-for انجام می‌شود.

تصاویر حاشیه رنگی زیبایی دریافت می‌کنند که با رنگ غالب در تصویر مطابقت دارد، همان‌طور که توسط Cloud Vision API یافت شده است و ما به تصاویر کوچک و تصاویر با عرض کامل در منابع پیوند و تصویر اشاره می‌کنیم.

در آخر، برچسب‌هایی را که تصویر را توصیف می‌کنند فهرست می‌کنیم.

کد جاوا اسکریپت برای قطعه 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 به آن ۳ نقطه پایانی اشاره می‌کنند که به مکان‌های 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 به‌طور پیش‌فرض به درگاه ۸۰۸۰ گوش می‌دهد و آماده ارائه خدمات به درخواست‌های ورودی است.

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}`);
});

‫۶. آزمایش محلی

کد را به‌صورت محلی آزمایش کنید تا مطمئن شوید قبل‌از استقرار در فضای ابری کار می‌کند.

باید دو متغیر محیطی مربوط به دو فضای ذخیره‌سازی Cloud Storage را صادر کنید:

export BUCKET_THUMBNAILS=thumbnails-${GOOGLE_CLOUD_PROJECT}
export BUCKET_PICTURES=uploaded-pictures-${GOOGLE_CLOUD_PROJECT}

در پوشه frontend، وابستگی‌های npm را نصب کنید و سرور را راه‌اندازی کنید:

npm install; npm start

اگر همه‌چیز خوب پیش رفت، باید سرور را در درگاه ۸۰۸۰ راه‌اندازی کند:

Started web frontend service on port 8080
- Pictures bucket = uploaded-pictures-${GOOGLE_CLOUD_PROJECT}
- Thumbnails bucket = thumbnails-${GOOGLE_CLOUD_PROJECT}

نام‌های واقعی دسته‌های شما در آن گزارش‌ها نشان داده خواهد شد که برای اشکال‌زدایی مفید است.

از Cloud Shell، می‌توانید از ویژگی پیش‌نمایش وب برای مرور برنامه درحال اجرا به‌صورت محلی استفاده کنید:

82fa3266d48c0d0a.png

برای خارج شدن، از CTRL-C استفاده کنید.

‫۷. مستقر کردن در 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 تنظیم کنید، حتماً از همان منطقه در آزمایشگاه‌های قبلی استفاده کنید:

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 مانند نسخه‌بندی و توزیع کردن ترافیک را کاوش کنید:

db0e196b00fceab1.png

‫۸. آزمایش کردن برنامه

برای آزمایش، به نشانی وب پیش‌فرض App Engine برای برنامه (https://<YOUR_PROJECT_ID>.appspot.com/) بروید و باید میانای کاربر پیش‌نما را درحال اجرا ببینید!

6a4d5e5603ba4b73.png

‫۹. پاک‌سازی (اختیاری)

اگر قصد ندارید برنامه را نگه دارید، می‌توانید با حذف کل پروژه، منابع را پاک‌سازی کنید تا در هزینه‌ها صرفه‌جویی کنید و به‌طور کلی شهروند ابری خوبی باشید:

gcloud projects delete ${GOOGLE_CLOUD_PROJECT} 

‫۱۰. تبریک!

تبریک! این برنامه وب Node.js که در App Engine میزبانی می‌شود، همه سرویس‌های شما را به هم متصل می‌کند و به کاربران شما اجازه می‌دهد تصاویر را بارگذاری و تجسم کنند.

آنچه پوشش دادیم

  • App Engine
  • فضای ذخیره‌سازی ابری
  • Cloud Firestore

مراحل بعدی