編寫 Cloud Run 函式

Cloud Run 函式支援多種程式設計語言編寫的原始碼，您選擇的語言執行階段和要編寫的函式類型，會決定程式碼的結構和函式實作方式。本頁面將概略說明 Cloud Run 函式類型和來源程式碼的預期內容。

Cloud Run 函式的類型

Cloud Run 函式分為兩種類型：

當您需要函式具備網址端點，並回應 HTTP 要求 (例如 webhook) 時，請使用 HTTP 函式。當函式應直接觸發，以回應 Google Cloud 專案中的事件 (例如 Pub/Sub 主題的訊息或 Cloud Storage 值區中的變更) 時，請使用事件驅動函式。

來源目錄結構

為使 Cloud Run 函式能夠找到函式定義，每個語言執行階段都對原始碼的結構有相關規定。下方是各個執行階段中函式的基本目錄結構。

Node.js

Node.js 函式的基本目錄結構如下：

.
├── index.js
└── package.json

根據預設，Cloud Run 函式會嘗試從函式目錄根目錄中名為 index.js 的檔案載入原始碼。如要指定不同的主要來源檔案，請在 package.json 檔案中使用 main 欄位。

package.json 檔案也必須將 Node.js 的 Functions Framework 納入依附元件：

{
  "main": "index.js",
  "dependencies": {
    "@google-cloud/functions-framework": "^3.0.0"
  }
}

主要檔案中的程式碼必須定義函式進入點，並能正常匯入其他程式碼和 Node.js 模組。主檔案也可以定義多個可個別部署的函式進入點。

Python

Python 函式的目錄結構如下：

.
├── main.py
└── requirements.txt

Cloud Run 函式會從函式目錄根目錄中名為 main.py 的檔案載入原始碼。主要檔案必須命名為 main.py。

requirements.txt 檔案必須將 Python 的 Functions Framework 納入為依附元件：

functions-framework==3.*

main.py 檔案中的程式碼必須定義函式進入點，並能正常匯入其他程式碼和外部依附元件。main.py 檔案也可以定義多個可個別部署的函式進入點。

Go

Go 函式的目錄結構如下：

.
├── myfunction.go
└── go.mod

您的函式必須位於專案根目錄中的 Go 套件中。套件及其來源檔案可以有任何名稱，但函式不得位於 package main 中。如果您需要 main 套件 (例如用於本機測試)，可以在子目錄中建立一個：

.
├── myfunction.go
├── go.mod
└── cmd/
    └── main.go

go.mod 檔案必須將 Go 的函式架構設為依附元件：

module example.com/my-module

require (
  github.com/GoogleCloudPlatform/functions-framework-go v1.5.2
)

根套件中的程式碼必須定義函式進入點，並能正常匯入子套件和依附元件的其他程式碼。您的套件也可以定義多個可個別部署的函式進入點。

Java

Java 函式的目錄結構如下：

.
├── pom.xml
└── src/
    └── main/
        └── java/
            └── MyFunction.java

Java 來源檔案必須位於 src/main/java/ 目錄下，且可以使用任何名稱。如果來源檔案宣告套件，請在 src/main/java 下方新增一個套件名稱的目錄：

.
├── pom.xml
└── src/
    └── main/
        └── java/
            └── mypackage/
                └── MyFunction.java

建議將相關測試放在 src/test/java/ 子目錄下。

pom.xml 檔案必須將 Java 版 Functions Framework 納入依附元件：

...
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.0.4</version>
    </dependency>
...

原始檔案中的程式碼必須定義函式進入點，並能正常匯入其他程式碼和外部依附元件。來源檔案也可以定義多個可個別部署的函式進入點。

C#

.NET 函式的基本目錄結構如下：

.
├── MyFunction.cs
└── MyProject.csproj

您可以按照任何其他 .NET 原始碼的做法來建構專案。來源檔案可以使用任何名稱。

專案檔案必須納入 .NET 的 Functions Framework 做為依附元件：

...
    <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0" />
...

原始檔案中的程式碼必須定義函式進入點，並能正常匯入其他程式碼和外部依附元件。來源檔案也可以定義多個可個別部署的函式進入點。

您也可以使用 .NET 適用的 Cloud Run 函式範本套件來產生必要檔案。

Ruby

Ruby 函式的基本目錄結構如下：

.
├── app.rb
├── Gemfile
└── Gemfile.lock

Cloud Run 函式會從函式目錄根目錄中名為 app.rb 的檔案載入原始碼。主要檔案必須命名為 app.rb。

Gemfile 檔案必須將 Functions Framework for Ruby 納入依附元件：

source "https://rubygems.org"
gem "functions_framework", "~> 1.0"

app.rb 檔案中的程式碼必須定義函式進入點，並能正常匯入其他程式碼和外部依附元件。app.rb 檔案也可以定義多個可個別部署的函式進入點。

PHP

PHP 函式的基本目錄結構如下：

.
├── index.php
└── composer.json

Cloud Run 函式會從函式目錄根目錄中名為 index.php 的檔案載入原始碼。主要檔案必須命名為 index.php。

composer.json 檔案必須納入 PHP 的函式架構做為依附元件：

{
  "require": {
    "google/cloud-functions-framework": "^1.1"
  }
}

index.php 檔案中的程式碼必須定義函式進入點，並能正常匯入其他程式碼和外部依附元件。index.php 檔案也可以定義多個可個別部署的函式進入點。

如果您打算將多個函式歸入單一專案，請注意，每個函式可能都會共用相同的依附元件。不過，部分函式可能不需要所有依附元件。

建議您盡可能分割大型多函式程式碼集，並將每個函式放在專屬的頂層目錄中，如上圖所示，並附上專屬的原始碼和專案設定檔。這種做法可盡量減少特定函式所需的依附元件數量，進而減少函式所需的記憶體量。

函式進入點

原始碼必須為函式定義進入點，也就是在叫用 Cloud Run 函式時執行的特定程式碼。您可以在部署函式時指定這個進入點。

定義進入點的方式取決於您使用的語言執行階段。在某些語言中，進入點是函式，而在其他語言中，進入點則是類別。如要進一步瞭解如何定義進入點，以及使用不同語言實作 Cloud Run 函式，請參閱「編寫 HTTP 函式」和「編寫事件驅動函式」。

依附元件

您可以使用各個執行階段的標準工具管理依附元件。如需更多資訊，請參閱適用頁面：

後續步驟