检查点
Deploy the function
/ 100
Cloud Functions:Qwik Start - 指令列
GSP080
總覽
「Cloud 函式」是因應事件執行的程式碼,事件包括 HTTP 要求、訊息傳遞服務發送的訊息,或是檔案上傳作業等。「Cloud 事件」是雲端環境中發生的「事項」,可能是資料庫內的資料出現異動、儲存系統中新增了檔案,或是建立新的虛擬機器執行個體。
Cloud 函式是以事件為準,只有發生事件時才會執行,因此適合用於必須迅速完成或不必隨時保持運作的任務。
舉例來說,Cloud 函式可以用於:
- 為上傳至 Cloud Storage 的圖片自動產生縮圖。
- 在 Cloud Pub/Sub 收到新訊息時,傳送通知至使用者的手機。
- 處理 Cloud Firestore 資料庫提供的資料,並產生報告。
您在編寫程式碼時,可以使用任何支援 Node.js 的語言。只要按幾下滑鼠,即可將程式碼部署至雲端。Cloud 函式部署完畢之後,就會因應事件自動開始執行。
透過這個實作研究室,您可以瞭解如何使用 Google Cloud 控制台來建立、部署及測試 Cloud 函式。
透過這個實作研究室,您可以瞭解如何使用 Google Cloud Shell 指令列來建立、部署及測試 Cloud 函式。
學習內容
- 建立 Cloud 函式
- 部署及測試 Cloud 函式
- 查看記錄檔
設定
點選「Start Lab」按鈕前的須知事項
請詳閱以下操作說明。研究室活動會計時,而且中途無法暫停。點選「Start Lab」 後就會開始計時,讓您瞭解有多少時間可以使用 Google Cloud 資源。
您將在真正的雲端環境中完成實作研究室活動,而不是在模擬或示範環境。為達此目的,我們會提供新的暫時憑證,讓您用來在研究室活動期間登入及存取 Google Cloud。
如要完成這個研究室活動,請先確認:
- 您可以使用標準的網際網路瀏覽器 (Chrome 瀏覽器為佳)。
- 是時候完成研究室活動了!別忘了,活動一開始將無法暫停。
如何開始研究室及登入 Google Cloud 控制台
-
按一下「Start Lab」(開始研究室) 按鈕。如果研究室會產生費用,畫面中會出現選擇付款方式的彈出式視窗。左側的「Lab Details」窗格會顯示下列項目:
- 「Open Google Cloud console」按鈕
- 剩餘時間
- 必須在這個研究室中使用的暫時憑證
- 完成這個實驗室所需的其他資訊 (如有)
-
點選「Open Google Cloud console」;如果使用 Chrome 瀏覽器,也能按一下滑鼠右鍵,然後選取「在無痕式視窗中開啟連結」。
接著,實驗室會啟動相關資源並開啟另一個分頁,當中顯示「登入」頁面。
提示:您可以在不同的視窗中並排開啟分頁。
注意:如果頁面中顯示「選擇帳戶」對話方塊,請點選「使用其他帳戶」。 -
如有必要,請將下方的 Username 貼到「登入」對話方塊。
{{{user_0.username | "Username"}}} 您也可以在「Lab Details」窗格找到 Username。
-
點選「下一步」。
-
複製下方的 Password,並貼到「歡迎使用」對話方塊。
{{{user_0.password | "Password"}}} 您也可以在「Lab Details」窗格找到 Password。
-
點選「下一步」。
重要事項:請務必使用實驗室提供的憑證,而非自己的 Google Cloud 帳戶憑證。 注意:如果使用自己的 Google Cloud 帳戶來進行這個實驗室,可能會產生額外費用。 -
按過後續的所有頁面:
- 接受條款及細則。
- 由於這是臨時帳戶,請勿新增救援選項或雙重驗證機制。
- 請勿申請免費試用。
Google Cloud 控制台稍後會在這個分頁開啟。
啟動 Cloud Shell
Cloud Shell 是搭載多項開發工具的虛擬機器,提供永久的 5 GB 主目錄,而且在 Google Cloud 中運作。Cloud Shell 提供指令列存取權,方便您使用 Google Cloud 資源。
- 點按 Google Cloud 控制台上方的「啟用 Cloud Shell」圖示 。
連線完成即代表已通過驗證,且專案已設為您的 PROJECT_ID。輸出內容中有一行宣告本工作階段 PROJECT_ID 的文字:
gcloud
是 Google Cloud 的指令列工具,已預先安裝於 Cloud Shell,並支援 Tab 鍵自動完成功能。
- (選用) 您可以執行下列指令來列出使用中的帳戶:
-
點按「授權」。
-
輸出畫面應如下所示:
輸出內容:
- (選用) 您可以使用下列指令來列出專案 ID:
輸出內容:
輸出內容範例:
gcloud
的完整說明,請前往 Google Cloud 並參閱「gcloud CLI overview guide」(gcloud CLI 總覽指南)。
工作 1:建立函式
首先,您會建立名為 helloWorld
的簡單函式,以便將訊息寫入 Cloud Functions 記錄檔。這個函式由 Cloud 函式事件觸發,並會接受用於表示「函式已執行完畢」的回呼函式。
這個研究室中的 Cloud 函式事件屬於 Cloud Pub/Sub 主題事件。Pub/Sub 是一項訊息傳遞服務,而且傳送者與接收者彼此分離。傳送或發布訊息時,接收者必須訂閱主題,才能收到快訊與訊息內容。如要進一步瞭解 Pub/Sub,請參閱 Cloud Pub/Sub 指南中的「Google Cloud Pub/Sub:Google 規模的訊息傳遞服務」。
如要進一步瞭解事件參數和回呼參數,請參閱 Cloud Functions 說明文件中的「背景函式」。
如要建立 Cloud 函式,請按照下列指示操作:
-
在 Cloud Shell 執行下列指令,設定預設區域:
gcloud config set run/region {{{project_0.default_region |REGION}}} -
為函式程式碼建立目錄:
mkdir gcf_hello_world && cd $_ -
建立並開啟
index.js
來編輯內容:nano index.js -
將下列內容複製到
index.js
檔案:const functions = require('@google-cloud/functions-framework'); // Register a CloudEvent callback with the Functions Framework that will // be executed when the Pub/Sub trigger topic receives a message. functions.cloudEvent('helloPubSub', cloudEvent => { // The Pub/Sub message is passed as the CloudEvent's data payload. const base64name = cloudEvent.data.message.data; const name = base64name ? Buffer.from(base64name, 'base64').toString() : 'World'; console.log(`Hello, ${name}!`); }); -
按下 Ctrl+X 鍵退出 nano 編輯器,並按下 Y 鍵儲存檔案。
-
建立並開啟
package.json
來編輯內容: -
將下列內容複製到
package.json
檔案:{ "name": "gcf_hello_world", "version": "1.0.0", "main": "index.js", "scripts": { "start": "node index.js", "test": "echo \"Error: no test specified\" && exit 1" }, "dependencies": { "@google-cloud/functions-framework": "^3.0.0" } } -
按下 Ctrl+X 鍵退出 nano 編輯器,並按下 Y 鍵儲存檔案。
-
安裝套件依附元件:
npm install 預期的輸出內容如下:
added 140 packages, and audited 141 packages in 9s 27 packages are looking for funding run `npm fund` for details found 0 vulnerabilities
工作 2:部署函式
在本實驗室中,您會將 --trigger-topic
設為 cf_demo
。
Cloud Functions 是事件導向型服務,因此必須指定觸發條件類型。部署新函式時,「--trigger-topic」、「--trigger-bucket」或「--trigger-http」都是常見的觸發事件。更新現有函式時,如未另行指定,函式會沿用原有的觸發條件。
-
將 helloPubSub 函式部署至名為 cf-demo 的 Pub/Sub 主題
gcloud functions deploy nodejs-pubsub-function \ --gen2 \ --runtime=nodejs20 \ --region={{{ project_0.default_region | REGION }}} \ --source=. \ --entry-point=helloPubSub \ --trigger-topic cf-demo \ --stage-bucket {{{ project_0.project_id | PROJECT_ID }}}-bucket \ --service-account cloudfunctionsa@{{{ project_0.project_id | PROJECT_ID }}}.iam.gserviceaccount.com \ --allow-unauthenticated 注意:
出現服務帳戶 serviceAccountTokenCreator 通知時,請按下 n 鍵。 -
驗證函式的狀態:
gcloud functions describe nodejs-pubsub-function \ --region={{{ project_0.default_region | REGION }}} 如果狀態為「ACTIVE」,代表函式已部署完畢。
預期的輸出內容如下:
BuildConfig: automaticUpdatePolicy: {} build: projects/630521560493/locations/{{{ project_0.default_region | REGION }}}/builds/7ff9d415-50d9-4557-9bcd-5afad42a6390 dockerRegistry: ARTIFACT_REGISTRY dockerRepository: projects/{{{ project_0.project_id | PROJECT_ID }}}/locations/{{{ project_0.default_region | REGION }}}/repositories/gcf-artifacts entryPoint: helloPubSub ... State: ACTIVE ... UpdateTime: '2024-08-05T13:51:05.317298824Z' Url: https://{{{ project_0.default_region | REGION }}}-{{{ project_0.project_id | PROJECT_ID }}}.cloudfunctions.net/nodejs-pubsub-function
在主題中發布的每則訊息都會觸發函式執行作業,訊息內容則會以輸入資料的形式傳遞。
測試已完成的工作
點選「Check my progress」,確認工作已完成。如果順利完成,就會看見評估分數。
工作 3:測試函式
部署函式並確認函式狀態為「ACTIVE」後,請測試函式是否會在偵測到事件後,將訊息寫入 Cloud 記錄檔。
-
使用部分資料叫用 Pub/Sub。
gcloud pubsub topics publish cf-demo --message="Cloud Function Gen2" 輸出內容範例:
messageIds: - '11927162971409664'
請查看記錄檔,確認當中有符合這組執行作業 ID 的記錄訊息。
工作 4:查看記錄檔
-
查看記錄檔,確認歷史記錄中有您的訊息:
gcloud functions logs read nodejs-pubsub-function \ --region={{{ project_0.default_region | REGION }}} 注意:
記錄檔會在 10 分鐘內顯示,您也能依序點選「記錄」>「記錄檔探索工具」來查看記錄檔。Cloud 函式的輸出資訊大致如下所示:
LEVEL: NAME: nodejs-pubsub-function EXECUTION_ID: h4v6akxf4sxt TIME_UTC: 2024-08-05 15:15:25.723 LOG: Hello, Cloud Function Gen2! LEVEL: I NAME: nodejs-pubsub-function EXECUTION_ID: TIME_UTC: 2024-08-05 15:15:25.711 LOG: LEVEL: NAME: nodejs-pubsub-function EXECUTION_ID: h4oxfjn7zlyu TIME_UTC: 2024-08-05 15:10:34.303 LOG: Hello, Friend! LEVEL: I NAME: nodejs-pubsub-function EXECUTION_ID: TIME_UTC: 2024-08-05 15:10:34.291 LOG: LEVEL: NAME: nodejs-pubsub-function EXECUTION_ID: h4fjhyfxua3k TIME_UTC: 2024-08-05 15:03:16.342 LOG: Hello, "SGVsbG8gZnJvbSB0aGUgY29tbWFuZCBsaW5l"!
應用程式已部署並測試完畢,您可以查看記錄檔。
工作 5:隨堂測驗
-
完成下列選擇題能加深您的印象,更清楚本實驗室介紹的概念,請盡您所能回答。
恭喜!
您已使用 Google Cloud 控制台來建立、部署及測試使用指令列的 Cloud 函式
挑戰下一個研究室
本研究室屬於 Qwik Start 研究室系列,旨在帶您一窺 Google Cloud 的眾多功能。在研究室目錄中搜尋「Qwik Start」,即可找到要進行的下一個研究室!
後續步驟/瞭解詳情
- 您已透過指令列啟動 Cloud 函式,接著請前往「Cloud Functions:Qwik Start - 控制台」研究室,嘗試使用 Cloud 控制台啟動 Cloud 函式。
- 如要進一步瞭解如何建立觸發條件並連結至函式,請參閱 Cloud Functions 指南的「Events and triggers」(事件與觸發條件) 部分。
Google Cloud 教育訓練與認證
協助您瞭解如何充分運用 Google Cloud 的技術。我們的課程會介紹專業技能和最佳做法,讓您可以快速掌握要領並持續進修。我們提供從基本到進階等級的訓練課程,並有隨選、線上和虛擬課程等選項,方便您抽空參加。認證可協助您驗證及證明自己在 Google Cloud 技術方面的技能和專業知識。
使用手冊上次更新日期:2024 年 8 月 5 日
實驗室上次測試日期:2024 年 8 月 5 日
Copyright 2024 Google LLC 保留所有權利。Google 和 Google 標誌是 Google LLC 的商標,其他公司和產品名稱則有可能是其關聯公司的商標。