快速入门：使用 gcloud CLI 将函数部署到 Cloud Run

本页介绍了如何使用 Cloud Run 通过 gcloud CLI 部署 HTTP 函数。

准备工作

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging APIs.

    Enable the APIs

  5. Install the Google Cloud CLI.

  6. To initialize the gcloud CLI, run the following command: 

    gcloud init

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

  9. Enable the Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging APIs.

    Enable the APIs

  10. Install the Google Cloud CLI.

  11. To initialize the gcloud CLI, run the following command: 

    gcloud init
  12. 要为 Cloud Run 服务设置默认项目，请使用以下命令： 
     gcloud config set project PROJECT_ID
     将 PROJECT_ID 替换为您为此快速入门创建的项目的名称。

  13. 如果您通过网域限制组织政策来限制项目的未经身份验证的调用，则您需要按照测试专用服务中的说明访问已部署的服务。

  14. 向 Cloud Build 服务账号授予以下 IAM 角色。

    点击查看 Cloud Build 服务账号需要的角色

    除非您替换此行为，否则 Cloud Build 会自动使用 Compute Engine 默认服务账号作为默认 Cloud Build 服务账号来构建源代码和 Cloud Run 资源。为了让 Cloud Build 能够构建来源，请让您的管理员向项目的 Compute Engine 默认服务账号授予 Cloud Run Builder (roles/run.builder) 角色：

      gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
      --role=roles/run.builder

    将 PROJECT_NUMBER 替换为您的 Google Cloud项目编号，将 PROJECT_ID 替换为您的 Google Cloud项目 ID。如需详细了解如何查找项目 ID 和项目编号，请参阅创建和管理项目。

    向 Compute Engine 默认服务账号授予 Cloud Run 构建器角色需要几分钟时间才能传播。

编写示例函数

如需编写应用，请按照以下步骤操作：

Node.js

  1. 创建名为 helloworld 的新目录，并转到此目录中：

       mkdir helloworld
   cd helloworld

  2. 在 helloworld 目录中创建一个 package.json 文件以指定 Node.js 依赖项：

    {
  "name": "nodejs-docs-samples-functions-hello-world-get",
  "version": "0.0.1",
  "private": true,
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "repository": {
    "type": "git",
    "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
  },
  "engines": {
    "node": ">=16.0.0"
  },
  "scripts": {
    "test": "c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.1.0"
  },
  "devDependencies": {
    "c8": "^10.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "wait-port": "^1.0.4"
  }
}

  3. 使用以下 Node.js 示例在 helloworld 目录中创建一个 index.js 文件：

    const functions = require('@google-cloud/functions-framework');

// Register an HTTP function with the Functions Framework that will be executed
// when you make an HTTP request to the deployed function's endpoint.
functions.http('helloGET', (req, res) => {
  res.send('Hello World!');
});

Python

  1. 创建名为 helloworld 的新目录，并转到此目录中：

       mkdir helloworld
   cd helloworld

  2. 在 helloworld 目录中创建一个 requirements.txt 文件，以指定 Python 依赖项：

    functions-framework==3.8.2
flask==3.0.3
google-cloud-error-reporting==1.11.1
MarkupSafe==2.1.3

    这会添加示例所需的软件包。

  3. 使用以下 Python 示例在 helloworld 目录中创建一个 main.py 文件：

    import functions_framework

@functions_framework.http
def hello_get(request):
    """HTTP Cloud Function.
    Args:
        request (flask.Request): The request object.
        <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
    Returns:
        The response text, or any set of values that can be turned into a
        Response object using `make_response`
        <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
    Note:
        For more information on how Flask integrates with Cloud
        Functions, see the `Writing HTTP functions` page.
        <https://cloud.google.com/functions/docs/writing/http#http_frameworks>
    """
    return "Hello World!"

Go

  1. 创建名为 helloworld 的新目录，并转到此目录中：

       mkdir helloworld
   cd helloworld

  2. 创建 go.mod 文件以声明 go 模块：

    module github.com/GoogleCloudPlatform/golang-samples/functions/functionsv2/helloworld

go 1.22.0

require github.com/GoogleCloudPlatform/functions-framework-go v1.8.1

require (
	github.com/cloudevents/sdk-go/v2 v2.15.2 // indirect
	github.com/google/go-cmp v0.6.0 // indirect
	github.com/google/uuid v1.6.0 // indirect
	github.com/json-iterator/go v1.1.12 // indirect
	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
	github.com/modern-go/reflect2 v1.0.2 // indirect
	github.com/stretchr/testify v1.10.0 // indirect
	go.uber.org/multierr v1.11.0 // indirect
	go.uber.org/zap v1.27.0 // indirect
	golang.org/x/time v0.9.0 // indirect
)

  3. 使用以下 Go 代码示例在 helloworld 目录中创建一个 hello_http.go 文件：

    
// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"fmt"
	"net/http"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
)

func init() {
	functions.HTTP("HelloGet", helloGet)
}

// helloGet is an HTTP Cloud Function.
func helloGet(w http.ResponseWriter, r *http.Request) {
	fmt.Fprint(w, "Hello, World!")
}

Java

  1. 创建名为 helloworld 的新目录，并转到此目录中：

       mkdir helloworld
   cd helloworld

  2. 创建以下项目结构以包含源目录和源文件：

    mkdir -p ~/helloworld/src/main/java/functions
touch ~/helloworld/src/main/java/functions/HelloWorld.java

  3. 使用以下 Java 代码示例更新 HelloWorld.java 文件：

    
package functions;

import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.BufferedWriter;
import java.io.IOException;

public class HelloWorld implements HttpFunction {
  // Simple function to return "Hello World"
  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    BufferedWriter writer = response.getWriter();
    writer.write("Hello World!");
  }
}

  4. 在 helloworld 目录中创建一个 pom.xml 文件，并添加以下 Java 依赖项：

    <?xml version="1.0" encoding="UTF-8"?>

<!--
  Copyright 2020 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.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example.functions</groupId>
  <artifactId>functions-hello-world</artifactId>
  <version>1.0.0-SNAPSHOT</version>

  <parent>
    <groupId>com.google.cloud.samples</groupId>
    <artifactId>shared-configuration</artifactId>
    <version>1.2.0</version>
  </parent>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <artifactId>libraries-bom</artifactId>
        <groupId>com.google.cloud</groupId>
        <scope>import</scope>
        <type>pom</type>
        <version>26.32.0</version>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <!-- Required for Function primitives -->
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.0</version>
      <scope>provided</scope>
    </dependency>

    <!-- The following dependencies are only required for testing -->
    <dependency>
      <groupId>com.google.truth</groupId>
      <artifactId>truth</artifactId>
      <version>1.4.0</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava-testlib</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.mockito</groupId>
      <artifactId>mockito-core</artifactId>
      <version>5.10.0</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <!--
          Google Cloud Functions Framework Maven plugin

          This plugin allows you to run Cloud Functions Java code
          locally. Use the following terminal command to run a
          given function locally:

          mvn function:run -Drun.functionTarget=your.package.yourFunction
        -->
        <groupId>com.google.cloud.functions</groupId>
        <artifactId>function-maven-plugin</artifactId>
        <version>0.11.0</version>
        <configuration>
          <functionTarget>functions.HelloWorld</functionTarget>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <!-- version 3.0.0-M4 does not load JUnit5 correctly -->
        <!-- see https://issues.apache.org/jira/browse/SUREFIRE-1750 -->
        <version>3.2.5</version>
        <configuration>
          <includes>
            <include>**/*Test.java</include>
          </includes>
          <skipTests>${skipTests}</skipTests>
          <reportNameSuffix>sponge_log</reportNameSuffix>
          <trimStackTrace>false</trimStackTrace>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Ruby

  1. 创建名为 helloworld 的新目录，并转到此目录中：

       mkdir helloworld
   cd helloworld

  2. 创建名为 app.rb 的文件，并将以下代码粘贴到其中：

    require "functions_framework"

FunctionsFramework.http "hello_get" do |_request|
  # The request parameter is a Rack::Request object.
  # See https://www.rubydoc.info/gems/rack/Rack/Request

  # Return the response body as a string.
  # You can also return a Rack::Response object, a Rack response array, or
  # a hash which will be JSON-encoded into a response.
  "Hello World!"
end

  3. 创建名为 Gemfile 的文件，并将以下内容复制到其中：

    source "https://rubygems.org"

gem "functions_framework", "~> 1.4"

  4. 如果您未安装 Bundler 2.0 或更高版本，请安装 Bundler。

  5. 通过运行以下命令生成 Gemfile.lock 文件：

    bundle install

PHP

  1. 创建名为 helloworld 的新目录，并转到此目录中：

       mkdir helloworld
   cd helloworld

  2. 创建名为 index.php 的文件，并将以下代码粘贴到其中：

    
use Psr\Http\Message\ServerRequestInterface;

function helloGet(ServerRequestInterface $request): string
{
    return 'Hello, World!' . PHP_EOL;
}

  3. 如果您不使用 Cloud Shell，请创建一个 composer.json 文件，并将以下代码粘贴到其中：

    {
    "require": {
        "google/cloud-functions-framework": "^1.0"
    },
    "scripts": {
        "start": [
           "Composer\\Config::disableProcessTimeout",
           "FUNCTION_TARGET=helloGet php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
        ]
    }
}

.NET

  1. 安装 .NET SDK 6.0。 本快速入门仅适用于 .NET 版本 6。

  2. 在 Console 中，使用 dotnet 命令新建一个空 Web 项目。

    dotnet new web -o helloworld-csharp

  3. 转到 helloworld-csharp 目录：

  4. 将项目文件 helloworld-csharp.csproj 中的示例代码替换为以下代码：

    <Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net6.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Google.Cloud.Functions.Hosting" Version="2.2.1" />
  </ItemGroup>
</Project>

  5. 将 Program.cs 文件中的示例代码替换为以下代码：

    
using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;

namespace HelloWorld;

public class Function : IHttpFunction
{
    public async Task HandleAsync(HttpContext context)
    {
        await context.Response.WriteAsync("Hello World!", context.RequestAborted);
    }
}

部署该函数

重要提示：本快速入门假定您在快速入门中使用的项目中拥有所有者或编辑者角色。否则，请参阅 Cloud Run Source Developer 角色，了解从源代码部署 Cloud Run 资源所需的权限。

如需部署 Cloud Run 函数，请按以下步骤操作：

  1. 在包含示例代码的目录中运行以下命令，以部署函数：

    Node.js

    gcloud beta run deploy nodejs-http-function \
      --source . \
      --function helloGET \
      --base-image nodejs20 \
      --region REGION \
      --allow-unauthenticated

    将 REGION 替换为要在其中部署函数的服务的 Google Cloud 区域。例如 us-central1。

    Python

    gcloud beta run deploy python-http-function \
      --source . \
      --function hello_get \
      --base-image python312 \
      --region REGION \
      --allow-unauthenticated

    将 REGION 替换为要在其中部署函数的服务的 Google Cloud 区域。例如 us-central1。

    Go

    gcloud beta run deploy go-http-function \
       --source . \
       --function HelloGet \
       --base-image go122 \
       --region REGION \
       --allow-unauthenticated

    将 REGION 替换为要在其中部署函数的服务的 Google Cloud 区域。例如 us-central1。

    Java

    在包含 pom.xml 文件的目录中运行以下命令：

    gcloud beta run deploy java-http-function \
       --source . \
       --function functions.HelloWorld \
       --base-image java21 \
       --region REGION \
       --allow-unauthenticated

    将 REGION 替换为要在其中部署函数的服务的 Google Cloud 区域。例如 us-central1。

    Ruby

    gcloud beta run deploy ruby-http-function \
       --source . \
       --function hello_get \
       --base-image ruby33 \
       --region REGION \
       --allow-unauthenticated

    将 REGION 替换为要在其中部署函数的服务的 Google Cloud 区域。例如 us-central1。

    PHP

    gcloud beta run deploy php-http-function \
       --source . \
       --function helloGet \
       --base-image php83 \
       --region REGION \
       --allow-unauthenticated

    将 REGION 替换为要在其中部署函数的服务的 Google Cloud 区域。例如 us-central1。

    .NET 

    gcloud beta run deploy csharp-http-function \
      --source . \
      --function HelloWorld.Function \
      --base-image dotnet6 \
      --region REGION \
      --allow-unauthenticated

    将 REGION 替换为要在其中部署函数的服务的 Google Cloud 区域。例如 us-central1。

  2. 部署完成后，Google Cloud CLI 会显示一个运行服务的网址。在浏览器中打开该网址，查看函数的输出。

如需了解如何将 Eventarc 触发器添加到函数，请参阅部署函数指南以查看相关说明。

清理

虽然 Cloud Run 不会对未在使用中的服务计费，但您可能仍然需要支付将容器映像存储在 Artifact Registry 中而产生的相关费用。为避免产生费用，您可以删除容器映像或删除 Google Cloud 项目。删除 Google Cloud 项目后，系统会停止对该项目中使用的所有资源计费。

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

后续步骤