快速入门：使用 Ruby 创建和部署 HTTP Cloud Functions 函数

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

注意：此内容仅适用于 Cloud Functions (第 1 代)。 如需查看本文档的第 2 代版本，请参阅使用 Ruby 创建和部署 HTTP Cloud Functions 函数。如需了解详情，请参阅 Cloud Functions 版本比较。

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

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

本指南中的示例演示了如何创建简单的 HTTP 函数。

了解详情：如需了解详情，请参阅 HTTP 函数和 CloudEvent 函数。

准备工作

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

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

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

   转到“项目选择器”

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

4. 启用 Cloud Functions and Cloud Build API。

   启用 API

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

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

   转到“项目选择器”

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

7. 启用 Cloud Functions and Cloud Build API。

   启用 API

8. 安装并初始化 gcloud CLI。
9. 更新并安装 gcloud 组件：

   gcloud components update

注意：需要命令提示符？您可以使用 Cloud Shell。Cloud Shell 是一个已包含 Google Cloud CLI 的命令行环境，因此您无需再进行安装。Compute Engine 虚拟机也预安装了 Google Cloud CLI。
10. 准备开发环境。

    转到 Ruby 设置指南

创建一个函数

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

   Linux 或 Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

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

2. 在 helloworld 目录中创建一个 app.rb 文件，其中包含以下内容：

   require "functions_framework"
   require "cgi"
   require "json"
   
   FunctionsFramework.http "hello_http" do |request|
     # The request parameter is a Rack::Request object.
     # See https://www.rubydoc.info/gems/rack/Rack/Request
     name = request.params["name"] ||
            (request.body.rewind && JSON.parse(request.body.read)["name"] rescue nil) ||
            "World"
     # 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 #{CGI.escape_html name}!"
   end

   此示例函数会获取 HTTP 请求中提供的姓名并返回问候语；或者，如果没有提供姓名，则返回“Hello World!”。

   注意：默认情况下，Cloud Functions 会在 app.rb 中查找可部署的函数。您可以在通过 gcloud 部署函数时使用 --source 标志指定包含 app.rb 文件的不同目录。

指定依赖项

Ruby 依赖项可通过 bundler 进行管理，并在名为 Gemfile 的文件中表示。

部署您的函数时，Cloud Functions 会使用 bundler 下载并安装 Gemfile 和 Gemfile.lock 中声明的依赖项。

Gemfile 会列出函数所需的软件包以及所有可选版本限制条件。对于 Cloud Functions 函数，其中一个软件包必须是 functions_framework gem。

在此练习中，在包含函数代码的 app.rb 文件所在的目录中创建名为 Gemfile 的文件，其中包含以下内容：

source "https://rubygems.org"

gem "functions_framework", "~> 0.7"

运行以下命令安装 functions_framework gem 和其他依赖项：

bundle install

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

在本地构建和测试

在部署函数之前，您可以在本地构建和测试该函数。运行以下命令以使用 functions-framework-ruby 可执行文件启动运行 hello_http 函数的本地 Web 服务器：

bundle exec functions-framework-ruby --target hello_http
# ...starts the web server in the foreground

如果函数成功构建，它会显示一个网址，您可以在网络浏览器中访问该网址，以查看实际应用中的函数：http://localhost:8080/。您应该会看到 Hello World! 消息。

或者，您也可以从另一个终端窗口使用 curl 向此函数发送请求：

curl localhost:8080
# Output: Hello World!

请参阅 Ruby Functions 框架文档中的测试函数。

部署该函数

如需使用 HTTP 触发器部署该函数，请在 helloworld 目录中运行以下命令：

gcloud functions deploy hello_http --runtime ruby32 --trigger-http --allow-unauthenticated

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

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

测试已部署的函数

1. 当函数完成部署时，请记下 httpsTrigger.url 属性，或使用以下命令查找该属性：

   gcloud functions describe hello_http
   

   该属性应如下所示：

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http

2. 在浏览器中访问此网址。您应该会看到一条“Hello World!”消息。

   尝试通过 HTTP 请求传递姓名，例如使用以下网址：

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http?name=NAME

   您应该会看到一条“Hello NAME!”消息。

查看日志

您可以在 Cloud Logging 界面中或通过 Google Cloud CLI 查看 Cloud Functions 日志。

使用命令行工具查看日志

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

gcloud functions logs read hello_http

输出应类似于以下内容：

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

注意：日志条目在创建以后通常会稍微延迟一点时间才会显示在 Cloud Logging 中。

在 Logging 信息中心内查看日志

您还可以通过 Google Cloud 控制台查看 Cloud Functions 函数的日志。

了解详情：如需了解详情，请参阅写入、查看和响应日志。