部署基于Gin Gonic的GCP Gen2 Cloud Function报错求助

问题概述 #

通过Zip包部署基于Gin Gonic开发的GCP Gen2 Cloud Function时失败，容器健康检查不通过，提示未监听PORT=8080端口，且对应的Cloud Run服务未就绪。

现有代码 #

HelloHTTP.go #

package hello

import (
    "fmt"
    "html"
    "net/http"

    "github.com/gin-gonic/gin"
)

// helloHTTP is a Gin handler function.
func HelloHTTP(c *gin.Context) {
    var d struct {
        Name string `json:"name"`
    }

    if err := c.BindJSON(&d); err != nil {
        c.String(http.StatusOK, "Hello, World!")
        return
    }

    if d.Name == "" {
        c.String(http.StatusOK, "Hello, World!")
        return
    }

    c.String(http.StatusOK, fmt.Sprintf("Hello, %s!", html.EscapeString(d.Name)))
}

go.mod #

module github.com/cap

go 1.21.1

require github.com/gin-gonic/gin v1.9.1

require (
    github.com/bytedance/sonic v1.9.1 // indirect
    github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
    github.com/gabriel-vasile/mimetype v1.4.2 // indirect
    github.com/gin-contrib/sse v0.1.0 // indirect
    github.com/go-playground/locales v0.14.1 // indirect
    github.com/go-playground/universal-translator v0.18.1 // indirect
    github.com/go-playground/validator/v10 v10.14.0 // indirect
    github.com/goccy/go-json v0.10.2 // indirect
    github.com/json-iterator/go v1.1.12 // indirect
    github.com/klauspost/cpuid/v2 v2.2.4 // indirect
    github.com/leodido/go-urn v1.2.4 // indirect
    github.com/mattn/go-isatty v0.0.19 // indirect
    github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
    github.com/modern-go/reflect2 v1.0.2 // indirect
    github.com/pelletier/go-toml/v2 v2.0.8 // indirect
    github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
    github.com/ugorji/go/codec v1.2.11 // indirect
    golang.org/x/arch v0.3.0 // indirect
    golang.org/x/crypto v0.9.0 // indirect
    golang.org/x/net v0.10.0 // indirect
    golang.org/x/sys v0.8.0 // indirect
    golang.org/x/text v0.9.0 // indirect
    google.golang.org/protobuf v1.30.0 // indirect
    gopkg.in/yaml.v3 v3.0.1 // indirect
)

错误信息 #

无法创建或更新Cloud Run服务hello，容器健康检查失败。版本'hello-00001-gef'未就绪，无法处理流量。用户提供的容器未能启动并监听PORT=8080环境变量定义的端口。该版本的日志可能包含更多信息。更多故障排除指南，请查看官方文档。

未找到该函数对应的Cloud Run服务projects/winter-vim-412404/locations/us-central1/services/hello。函数无法正常工作，请重新部署。

解决步骤 #

1. 适配GCP Gen2 Cloud Function的函数签名 #

GCP Gen2 Cloud Function的HTTP触发器要求导出的函数符合func(http.ResponseWriter, *http.Request)签名，而Gin的handler使用*gin.Context，需要将Gin引擎转换为标准HTTP Handler适配。修改后的HelloHTTP.go如下：

package hello

import (
    "fmt"
    "html"
    "net/http"

    "github.com/gin-gonic/gin"
)

// 初始化Gin引擎，程序启动时执行
var ginEngine *gin.Engine

func init() {
    ginEngine = gin.Default()
    // 将Gin handler绑定到根路径（可根据触发器配置调整）
    ginEngine.POST("/", HelloHTTP)
}

// 原Gin handler逻辑保持不变
func HelloHTTP(c *gin.Context) {
    var d struct {
        Name string `json:"name"`
    }

    if err := c.BindJSON(&d); err != nil {
        c.String(http.StatusOK, "Hello, World!")
        return
    }

    if d.Name == "" {
        c.String(http.StatusOK, "Hello, World!")
        return
    }

    c.String(http.StatusOK, fmt.Sprintf("Hello, %s!", html.EscapeString(d.Name)))
}

// 导出符合GCP要求的HTTP处理函数，将请求转发给Gin引擎
func HelloHTTPFunc(w http.ResponseWriter, r *http.Request) {
    ginEngine.ServeHTTP(w, r)
}

2. 部署时指定正确的入口点 #

部署Zip包时，需指定函数入口点为hello.HelloHTTPFunc（格式为包名.函数名）：

• 命令行部署示例：

  gcloud functions deploy hello \
      --gen2 \
      --runtime go121 \
      --region us-central1 \
      --entry-point HelloHTTPFunc \
      --trigger-http \
      --source ./path-to-zip-or-directory
  

• 控制台部署：在"运行时、构建、连接设置"的"运行时"部分，设置"入口点"为HelloHTTPFunc。

3. 确保Zip包结构正确 #

Zip包根目录下需包含HelloHTTP.go和go.mod文件，不要嵌套在子目录中。

验证部署 #

部署完成后，通过触发器URL发送POST请求测试：

curl -X POST https://us-central1-winter-vim-412404.cloudfunctions.net/hello \
  -H "Content-Type: application/json" \
  -d '{"name": "GCP"}'

应返回Hello, GCP!。

内容的提问来源于stack exchange，提问作者Shreyas Awankar