使用 .NET 创建和部署 HTTP Cloud Functions 函数

使用 .NET 创建和部署 HTTP Cloud Functions 函数

本指南将引导您完成使用 .NET 运行时语言 C# 编写 Cloud Functions 函数的过程。Cloud Functions 函数有两种类型：

• HTTP 函数，通过标准 HTTP 请求调用。
• 事件驱动型函数，由云基础设施中的事件触发，例如 Pub/Sub 主题中收到消息或 Cloud Storage 存储桶发生更改。

如需了解详情，请参阅编写 HTTP 函数和编写事件驱动型函数。

准备工作

1. 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手，请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金，用于运行、测试和部署工作负载。

2. 在 Google Cloud Console 中的项目选择器页面上，选择或创建一个 Google Cloud 项目。

   注意：如果您不打算保留在此过程中创建的资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以删除所创建的项目，并移除与该项目关联的所有资源。

   转到“项目选择器”

3. 确保您的 Google Cloud 项目已启用结算功能。

4. 启用 Cloud Functions、Cloud Build、Artifact Registry、Cloud Run 和 Cloud Logging API。

   启用 API

5. 在 Google Cloud Console 中的项目选择器页面上，选择或创建一个 Google Cloud 项目。

   注意：如果您不打算保留在此过程中创建的资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以删除所创建的项目，并移除与该项目关联的所有资源。

   转到“项目选择器”

6. 确保您的 Google Cloud 项目已启用结算功能。

7. 启用 Cloud Functions、Cloud Build、Artifact Registry、Cloud Run 和 Cloud Logging API。

   启用 API

8. 安装并初始化 Google Cloud SDK。
注意：需要命令提示符？您可以使用 Google Cloud Shell。Google Cloud Shell 命令行环境已经包含 Google Cloud CLI，因此您无需再进行安装。Google Compute Engine 虚拟机也预装了 Google Cloud CLI。
9. 使用以下命令更新和安装 gcloud 组件。

   gcloud components update

10. 准备开发环境。

    转到 .NET 设置指南

创建函数

本部分介绍了如何手动创建 .NET 函数。或者，您也可以使用 Functions 框架模板创建函数。

如需创建函数，请执行以下操作：

1. 在本地系统上为函数代码创建一个目录：

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

   Linux 或 Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

2. 在 helloworld 目录中创建一个名为 Function.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!");
       }
   }

指定依赖项

Cloud Functions 函数需要一组名为 Functions 框架的库。如需将 Functions 框架提供给 build，请执行以下步骤：

1. 将目录切换到您刚刚创建的 helloworld 目录：

    cd ~/helloworld
   

2. 在 helloworld 目录中创建一个名为 HelloWorld.csproj 的文件，其中包含以下内容：

   <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
       <OutputType>Exe</OutputType>
       <TargetFramework>net6.0</TargetFramework>
     </PropertyGroup>
   
     <ItemGroup>
       <PackageReference Include="Google.Cloud.Functions.Hosting" Version="2.1.0" />
     </ItemGroup>
   </Project>

了解详情：如需了解详情，请参阅指定依赖项。

如需了解如何通过项目文件或在代码中通过依赖项注入将其他库提供给 build，请参阅通过 Functions 启动类进行自定义。

在本地构建和测试函数

1. 使用以下命令在本地构建并运行函数：

   dotnet run
   

2. 在浏览器中访问 http://localhost:8080，或从其他窗口运行 curl localhost:8080，以测试函数。 如果您使用的是 Cloud Shell，请点击 图标，然后选择在端口 8080 上预览，以查看函数输出。

   如需了解详情，请参阅向本地函数发送请求。

部署函数

如需部署函数，请在 helloworld 目录中运行以下命令：

  gcloud functions deploy csharp-http-function \
    --gen2 \
    --entry-point=HelloWorld.Function \
    --runtime=dotnet6 \
    --region=REGION \
    --source=. \
    --trigger-http \
    --allow-unauthenticated

将 REGION 替换为要部署函数的 Google Cloud 区域的名称（例如 us-west1）。

其中，csharp-http-function 是在 Google Cloud 控制台中用来标识函数的注册名称，而 --entry-point 用于指定函数的完全限定类名称 (FQN)。

通过可选的 --allow-unauthenticated 标志，您可以在不进行身份验证的情况下访问函数。

了解详情：如需了解详情，请参阅部署 Cloud Functions 函数。

测试已部署的函数

1. 函数部署后，请记下 gcloud functions deploy 命令输出中的 uri 属性，或使用以下命令检索该属性：

   gcloud functions describe csharp-http-function \
     --region=REGION
   

   将 REGION 替换为您在其中部署函数的 Google Cloud 区域的名称（例如 us-west1）。

2. 在浏览器中访问 http://localhost:8080，或从其他窗口运行 curl localhost:8080，以测试函数。

   如需了解详情，请参阅向本地函数发送请求。

查看函数日志

使用命令行工具查看日志

您可以使用 Cloud Logging 界面或通过 Google Cloud CLI 查看函数的日志。

如需使用 gcloud CLI 查看函数的日志，请使用 logs read 命令：

  gcloud functions logs read \
    --gen2 \
    --limit=10 \
    --region=REGION \
    csharp-http-function

将 REGION 替换为您在其中部署函数的 Google Cloud 区域的名称（例如 us-west1）。

输出类似以下内容：

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-06-01 12:47:42.221
LOG: Request finished HTTP/1.1 GET http://my-first-function-l5vqvupfzq-uw.a.run.app/favicon.ico - - - 404 0 - 0.9393ms

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-06-01 12:47:42.220
LOG: Request starting HTTP/1.1 GET http://my-first-function-l5vqvupfzq-uw.a.run.app/favicon.ico - -

注意：日志条目可能需要稍微延迟一段时间才会显示在 Cloud Logging 中。

使用日志记录信息中心查看日志

要使用日志记录信息中心查看函数的日志，请打开 Cloud Functions 概览页面，点击列表中的函数名称，然后点击日志标签页。

使用模板软件包创建函数

以下说明帮助您创建一个简单的函数。在实际情况下，您可能更希望使用 Functions 框架模板来创建函数。

如需使用 Functions 框架模板创建、构建和测试函数，请执行以下操作：

1. 安装 .NET SDK。如果您使用的是 Cloud Shell，则可以跳过此步骤。

2. 安装模板软件包：

   dotnet new install Google.Cloud.Functions.Templates
   

   注意：.NET 7 之前的 .NET SDK 版本使用 dotnet new -i 而不是 dotnet new install。

3. 为您的项目创建一个目录，并创建一个空的 HTTP 函数：

   mkdir HelloFunctions
   cd HelloFunctions
   dotnet new gcf-http
   

   此命令会在当前目录中创建 HelloFunctions.csproj 和 Function.cs。打开 Function.cs 查看代码，并根据需要提供自定义消息。

   注意：如需了解如何使用模板创建 F# 和 Visual Basic 函数，请参阅 .NET 语言。

4. （可选）按照上述说明在本地构建和测试函数。

5. 执行以下 gcloud deploy 命令以部署函数：

   gcloud functions deploy HelloFunctions.Function \
     --gen2 \
     --entry-point=HelloWorld.Function \
     --runtime=dotnet6 \
     --region=REGION \
     --source=. \
     --trigger-http \
     --allow-unauthenticated
   

   将 REGION 替换为您在其中部署函数的 Google Cloud 区域的名称（例如 us-west1）。

如需详细了解 Functions 框架，请参阅 Functions 框架文档。