文档首页 > > 开发指南> 如何开发函数> Go函数开发指南(Go 1.x)

Go函数开发指南(Go 1.x)

分享
更新时间:2020/12/14 GMT+08:00

函数定义

对于Go,FunctionGraph运行时目前支持Go 1.x版本。

函数有明确的接口定义,如下所示:

func Handler (payload []byte, ctx context.RuntimeContext)

  • 入口函数名(Handler):入口函数名称。
  • 执行事件体(payload): 函数执行界面由用户输入的执行事件参数, 格式为JSON对象。
  • 上下文环境(ctx ):Runtime提供的函数执行上下文,其接口定义在SDK接口说明。

SDK接口

FunctionGraph函数GoSDK提供了Event事件接口、Context接口和日志记录接口。Go SDK下载

  • Event事件接口

    Go SDK加入了触发器事件结构体定义,目前支持CTS、KAFKA、DIS、DDS、SMN、LTS、TIMER、APIG八种。在需要使用触发器的场景时,编写相关代码更简单。

    1. APIG触发器相关字段说明
      1. APIGTriggerEvent相关字段说明
        表1 APIGTriggerEvent相关字段说明

        字段名

        字段描述

        IsBase64Encoded

        Event中的body是否是base64编码

        HttpMethod

        Http请求方法

        Path

        Http请求路径

        Body

        Http请求body

        PathParameters

        所有路径参数

        RequestContext

        相关的APIG配置(APIGRequestContext对象

        Headers

        Http请求头

        QueryStringParameters

        查询参数

        UserData

        APIG自定义认证中设置的userdata

        表2 APIGRequestContext相关字段说明

        字段名

        字段描述

        ApiId

        API的ID

        RequestId

        此次API请求的requestId

        Stage

        发布环境名称

      2. APIGTriggerResponse相关字段说明
        表3 APIGTriggerResponse相关字段说明

        字段名

        字段描述

        Body

        消息体

        Headers

        最终返回的Http响应头

        StatusCode

        Http状态码,int类型

        IsBase64Encoded

        body是否经过base64编码,bool类型

        APIGTriggerEvent提供GetRawBody()方法获取base64解码后的body体,相应的APIGTriggerResponse提供SetBase64EncodedBody()方法来设置base64加密的body体。

    2. DIS触发器相关字段说明
      表4 DISTriggerEvent相关字段说明

      字段名

      字段描述

      ShardID

      分区ID

      Message

      DIS消息体(DISMessage结构

      Tag

      函数版本

      StreamName

      通道名称

      表5 DISMessage相关字段说明

      字段名

      字段描述

      NextPartitionCursor

      下一个游标

      Records

      消息记录(DISRecord结构

      MillisBehindLatest

      保留字段

      表6 DISRecord相关字段说明

      字段名

      字段描述

      PartitionKey

      数据分区

      Data

      数据

      SequenceNumber

      序列号(每个记录的唯一标识)

    3. KAFKA触发器相关字段说明
      表7 KAFKATriggerEvent相关字段说明

      字段名

      字段描述

      InstanceId

      实例ID

      Records

      消息记录(表8

      TriggerType

      触发器类型,返回KAFKA

      Region

      region

      EventTime

      事件发生时间,秒数

      EventVersion

      事件版本

      表8 KAFKARecord相关字段说明

      字段名

      字段描述

      Messages

      DMS消息体

      TopicId

      DMS的主题ID

    4. SMN触发器相关字段说明
      表9 SMNTriggerEvent相关字段说明

      字段名

      字段描述

      Record

      消息记录集合(SMNRecord结构

      表10 SMNRecord相关字段说明

      字段名

      字段描述

      EventVersion

      事件版本(当前为1.0)

      EventSubscriptionUrn

      订阅URN

      EventSource

      事件源

      Smn

      SMN事件消息体(SMNBody结构

      表11 SMNBody相关字段说明

      字段名

      字段描述

      TopicUrn

      SMN主题URN

      TimeStamp

      消息时间戳

      MessageAtrributes

      消息属性集合

      Message

      消息体

      Type

      消息类型

      MessageId

      消息ID

      Subject

      消息主题

    5. 定时触发器相关字段说明
      表12 TimerTriggerEvent相关字段说明

      字段名

      字段描述

      Version

      版本名称(当前为“v1.0”)

      Time

      当前时间

      TriggerType

      触发器类型(“Timer”)

      TriggerName

      触发器名称

      UserEvent

      触发器附加信息

    6. LTS触发器相关字段说明
      表13 LTSTriggerEvent相关字段说明

      字段名

      字段描述

      Lts

      LTS消息(LTSBody结构

      表14 LTSBody相关字段说明

      字段名

      字段描述

      Data

      LTS原始消息

      LTSBody提供GetRawData()函数返回base64解码后的消息。

    7. CTS触发器相关字段说明
      表15 CTSTriggerEvent字段说明

      字段名

      字段说明

      CTS

      CTS消息体(表16

      表16 CTS结构相关字段说明

      字段名

      字段描述

      Time

      事件产生时间

      User

      触发该事件的用户信息(表17

      Request

      事件请求内容

      Response

      事件响应内容

      Code

      响应码

      ServiceType

      事件触发的服务名称

      ResourceType

      事件触发的资源类型

      ResourceName

      事件触发的资源名称

      ResourceId

      事件触发资源的唯一标识

      TraceName

      事件名称

      TraceType

      事件触发的方式(如ConsoleAction:代表前台操作)

      RecordTime

      CTS服务接收事件时间

      TraceId

      当前事件的唯一标识

      TraceStatus

      事件状态

      表17 User字段说明

      字段名

      字段描述

      Name

      用户名(同一账号可以创建多个子用户)

      Id

      用户ID

      Domain

      账号信息(表18

      表18 Domain字段说明

      字段名

      字段描述

      Name

      账号名称

      Id

      账号ID

      8.DDS触发器相关方法说明

      表19 DDS事件结构相关字段说明

      字段名

      字段描述

      Records

      DDS记录(表20

      表20 DDS记录体相关字段说明

      字段名

      字段描述

      EventName

      事件名称

      EventVersion

      事件版本

      EventSource

      事件源

      Region

      region

      Dds

      文档数据

      EventSourceId

      事件源ID

    1. 例如使用APIG触发器时,只需要把入口函数(假如函数名为handler)的第一个参数按照如下方式设置:handler(APIGTriggerEvent event, Context context)。
    2. 关于所有TriggerEvent,上面提到的TriggerEvent方法均有与之对应的set方法,建议在本地调试时使用;DIS和LTS均有对应的getRawData()方法,但无与之相应的setRawData()方法。
  • Context接口

    Context接口提供函数获取函数执行上下文,例如,租户AK/SK、当前请求ID、函数执行分配的内存空间、CPU数等。

    Context接口说明如表21所示。

    表21 Context类上下文方法说明

    方法名

    方法说明

    GetRequestID( )

    获取请求ID。

    GetRemainingTimeInMilligetRunningTimeInSecondsSeconds ( )

    获取函数剩余运行时间。

    GetAccessKey( )

    获取租户AccessKey,使用该方法需要给函数配置委托。

    GetSecretKey( )

    获取租户SecretKey,使用该方法需要给函数配置委托。

    GetUserData(string key)

    通过key获取用户通过环境变量传入的值。

    GetFunctionName( )

    获取函数名称。

    GetRunningTimeInSeconds ( )

    获取函数超时时间。

    GetVersion( )

    获取函数的版本。

    GetMemorySize( )

    分配的内存。

    GetCPUNumber( )

    分配的CPU数。

    GetProjectID( )

    获取projectID。

    GetPackage( )

    获取函数组。

    GetToken( )

    获取token,使用该方法需要给函数配置委托。

    GetLogger( )

    获取context提供的logger方法(默认会输出时间、请求ID等信息)。

    GetToken()、GetAccessKey()和GetSecretKey()方法返回的内容包含敏感信息,请谨慎使用,避免造成用户敏感信息的泄露。

  • 日志接口Go SDK日志接口日志说明如表22所示。
    表22 日志接口说明表

    方法名

    方法说明

    RuntimeLogger()

    • 记录用户输入日志对象,包含方法如下:Logf(format string, args ...interface{})
    • 该方法会将内容输出到标准输出,格式:"时间-请求ID-输出内容",示例如下:2017-10-25T09:10:03.328Z 473d369d-101a-445e-a7a8-315cca788f86 test log output。

开发Go函数

登录已经安装了Go 1.x SDK的linux服务器(当前支持Ubuntu 14.04,Ubuntu 16.04,SuSE 11.3,SuSE 12.0,SuSE 12.1)

  • 如果Go的版本支持go mod(go版本高于1.11.1),可以按照如下步骤进行编译和打包:
  1. 创建一个临时目录例如“/home/fssgo”,将FunctionGraph的Go RUNTIME SDK解压到新创建的目录,并开启go module开关,操作如下:

    $ mkdir -p /home/fssgo

    $ unzip functiongraph-go-runtime-sdk-1.0.1.zip -d /home/fssgo

    $ export GO111MODULE="on"

  2. 在目录“/home/fssgo”下生成go.mod文件,操作如下,以模块名为test为例:

    $ go mod init test

  3. 在目录“/home/fssgo”下编辑go.mod文件,添加红色部分内容:

    module test
    
    go 1.14
    
    require (
        huaweicloud.com/go-runtime v0.0.0-00010101000000-000000000000
    )
    
    replace (
        huaweicloud.com/go-runtime => ./go-runtime
    )

  4. 在目录“/home/fssgo”下创建函数文件,并实现如下接口:

    func Handler(payload []byte, ctx context.RuntimeContext) (interface{}, error)

    其中payload为客户端请求的body数据,ctx为FunctionGraph函数服务提供的运行时上下文对象,具体提供的方法可以参考表21,以test.go为例:

    package main
    
    import (
        "fmt"
        "huaweicloud.com/go-runtime/go-api/context"
        "huaweicloud.com/go-runtime/pkg/runtime"
        "huaweicloud.com/go-runtime/events/apig"
        "huaweicloud.com/go-runtime/events/cts"
        "huaweicloud.com/go-runtime/events/dds"
        "huaweicloud.com/go-runtime/events/dis"
        "huaweicloud.com/go-runtime/events/kafka"
        "huaweicloud.com/go-runtime/events/lts"
        "huaweicloud.com/go-runtime/events/smn"
        "huaweicloud.com/go-runtime/events/timer"
        "encoding/json"
    )
    
    func ApigTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var apigEvent apig.APIGTriggerEvent
        err := json.Unmarshal(payload, &apigEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", apigEvent.String())
        apigResp := apig.APIGTriggerResponse{
           Body: apigEvent.String(),
           Headers: map[string]string {
              "content-type": "application/json",
           },
           StatusCode: 200,
        }
        return apigResp, nil
    }
    
    func CtsTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var ctsEvent cts.CTSTriggerEvent
        err := json.Unmarshal(payload, &ctsEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", ctsEvent.String())
        return "ok", nil
    }
    
    func DdsTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var ddsEvent dds.DDSTriggerEvent
        err := json.Unmarshal(payload, &ddsEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", ddsEvent.String())
        return "ok", nil
    }
    
    func DisTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var disEvent dis.DISTriggerEvent
        err := json.Unmarshal(payload, &disEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", disEvent.String())
        return "ok", nil
    }
    
    func KafkaTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var kafkaEvent kafka.KAFKATriggerEvent
        err := json.Unmarshal(payload, &kafkaEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", kafkaEvent.String())
        return "ok", nil
    }
    
    func LtsTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var ltsEvent lts.LTSTriggerEvent
        err := json.Unmarshal(payload, &ltsEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", ltsEvent.String())
        return "ok", nil
    }
    
    func SmnTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var smnEvent smn.SMNTriggerEvent
        err := json.Unmarshal(payload, &smnEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", smnEvent.String())
        return "ok", nil
    }
    
    func TimerTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var timerEvent timer.TimerTriggerEvent
        err := json.Unmarshal(payload, &timerEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        return timerEvent.String(), nil
    }
    
    func main() {
        runtime.Register(ApigTest)
    }
    1. 如果函数返回的error参数不是nil,则会认为函数执行失败。
    2. 如果函数返回的error为nil,FunctionGraph函数服务仅支持返回如下几种类型的值。

      nil:返回的HTTP响应Body为空。

      []byte:返回的HTTP响应Body内容为该字节数组内容。

      string:返回的HTTP响应Body内容为该字符串内容。

      其它:FunctionGraph函数服务会将返回值作为对象进行json编码,并将编码后的内容作为HTTP响应的Body,同时设置响应的"Content-Type"头为"application/json"。

    3. 上面的例子是APIG触发器的事件类型,如果是其他触发器类型需要修改main函数的内容,例如cts触发器修改为runtime.Register(CtsTest),目前只支持注册一个入口。

  5. 编译和打包

    函数代码编译完成后,按照如下方式编译和打包。

    1. 编译

      $ cd /home/fssgo

      $ go build -o handler test.go

      handler可以自定义,后面作为函数入口

    2. 打包:

      $ zip fss_examples_go1.x.zip handler

  • 如果Go的版本不支持go mod(go版本低于1.11.1),可以按照如下步骤进行编译和打包:
  1. 创建一个临时目录例如“/home/fssgo/src/huaweicloud.com”,将FunctionGraph的sdk Go RUNTIME SDK解压到新创建的目录,操作如下:

    $ mkdir -p /home/fssgo/src/huaweicloud.com

    $ unzip functiongraph-go-runtime-sdk-1.0.1.zip -d /home/fssgo/src/huaweicloud.com

  2. 在目录“/home/fssgo/src”下创建函数文件,并实现如下接口:

    func Handler(payload []byte, ctx context.RuntimeContext) (interface{}, error)

    其中payload为客户端请求的body数据,ctx为FunctionGraph函数服务提供的运行时上下文对象,具体提供的方法可以参考SDK接口,以test.go为例:

    package main
    
    import (
        "fmt"
        "huaweicloud.com/go-runtime/go-api/context"
        "huaweicloud.com/go-runtime/pkg/runtime"
        "huaweicloud.com/go-runtime/events/apig"
        "huaweicloud.com/go-runtime/events/cts"
        "huaweicloud.com/go-runtime/events/dds"
        "huaweicloud.com/go-runtime/events/dis"
        "huaweicloud.com/go-runtime/events/kafka"
        "huaweicloud.com/go-runtime/events/lts"
        "huaweicloud.com/go-runtime/events/smn"
        "huaweicloud.com/go-runtime/events/timer"
        "encoding/json"
    )
    
    func ApigTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var apigEvent apig.APIGTriggerEvent
        err := json.Unmarshal(payload, &apigEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", apigEvent.String())
        apigResp := apig.APIGTriggerResponse{
           Body: apigEvent.String(),
           Headers: map[string]string {
              "content-type": "application/json",
           },
           StatusCode: 200,
        }
        return apigResp, nil
    }
    
    func CtsTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var ctsEvent cts.CTSTriggerEvent
        err := json.Unmarshal(payload, &ctsEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", ctsEvent.String())
        return "ok", nil
    }
    
    func DdsTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var ddsEvent dds.DDSTriggerEvent
        err := json.Unmarshal(payload, &ddsEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", ddsEvent.String())
        return "ok", nil
    }
    
    func DisTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var disEvent dis.DISTriggerEvent
        err := json.Unmarshal(payload, &disEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", disEvent.String())
        return "ok", nil
    }
    
    func KafkaTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var kafkaEvent kafka.KAFKATriggerEvent
        err := json.Unmarshal(payload, &kafkaEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", kafkaEvent.String())
        return "ok", nil
    }
    
    func LtsTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var ltsEvent lts.LTSTriggerEvent
        err := json.Unmarshal(payload, &ltsEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", ltsEvent.String())
        return "ok", nil
    }
    
    func SmnTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var smnEvent smn.SMNTriggerEvent
        err := json.Unmarshal(payload, &smnEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        ctx.GetLogger().Logf("payload:%s", smnEvent.String())
        return "ok", nil
    }
    
    func TimerTest(payload []byte, ctx context.RuntimeContext) (interface{}, error) {
        var timerEvent timer.TimerTriggerEvent
        err := json.Unmarshal(payload, &timerEvent)
        if err != nil {
           fmt.Println("Unmarshal failed")
           return "invalid data", err
        }
        return timerEvent.String(), nil
    }
    
    func main() {
        runtime.Register(ApigTest)
    }
    1. 如果函数返回的error参数不是nil,则会认为函数执行失败。
    2. 如果函数返回的error为nil,FunctionGraph函数服务仅支持返回如下几种类型的值。

      nil:返回的HTTP响应Body为空。

      []byte:返回的HTTP响应Body内容为该字节数组内容。

      string:返回的HTTP响应Body内容为该字符串内容。

      其它:FunctionGraph函数服务会将返回值作为对象进行json编码,并将编码后的内容作为HTTP响应的Body,同时设置响应的"Content-Type"头为"application/json"。

    3. 上面的例子是APIG触发器的事件类型,如果是其他触发器类型需要修改main函数的内容,例如cts触发器修改为runtime.Register(CtsTest),目前只支持注册一个入口。

  3. 编译和打包

    函数代码编译完成后,按照如下方式编译和打包。

    1. 设置GOROOT和GOPATH环境变量:

      $ export GOROOT=/usr/local/go (假设Go安装到了/usr/local/go目录)

      $ export PATH=$GOROOT/bin:$PATH

      $ export GOPATH=/home/fssgo

    2. 编译:

      $ cd /home/fssgo

      $ go build -o handler test.go

      handler可以自定义,后面作为函数入口

    3. 打包:

      $ zip fss_examples_go1.x.zip handler

    • 创建函数

      登录FunctionGraph控制台,创建Go1.x函数,上传代码包fss_examples_go1.x.zip

      图1 上传程序包

    对于Go runtime,必须在编译之后打zip包,编译后的文件名称必须与函数执行入口的名称保持一致,例如:二进制文件名为handler,则“函数执行入口”命名为handler,Handler与步骤1中定义的函数保持一致。

    • 测试函数
      1. 创建测试事件。

        在函数详情页,单击“请选择测试事件 > 请配置测试事件”,弹出“配置测试事件”页,输入测试信息如图2所示,单击“保存”。

        图2 配置测试事件
      2. 在函数详情页,选择已配置测试事件,单击“测试”。
    • 函数执行

      函数执行结果分为三部分,分别为函数返回(由callback返回)、执行摘要、日志输出(由console.log或getLogger()方法获取的日志方法输出),如图3所示。

      图3 执行结果

执行结果

执行结果由3部分组成:函数返回、执行摘要和日志。

表23 执行结果说明

参数项

执行成功

执行失败

函数返回

返回函数中定义的返回信息。

返回包含错误信息和错误类型的JSON文件。格式如下:

{
    "errorMessage": "", 
    "errorType":"", 
}

errorMessage:Runtime返回的错误信息

errorType:错误类型

执行摘要

显示请求ID、配置内存、执行时长、实际使用内存和收费时长。

显示请求ID、配置内存、执行时长、实际使用内存和收费时长。

日志

打印函数日志,最多显示4KB的日志。

打印报错信息,最多显示4KB的日志。

函数执行失败的函数返回示例如下:

{   "errorMessage": "runtime error: invalid memory address or nil pointer dereference",  
    "errorType": "panic",   
    "stackTrace": [       "HandleRequest()",       "    go-runtime/main.go:15"   ] 
}

函数执行失败的日志示例如下:

2020/08/12 09:17:07 GMT+08:00  Start invoke request 'e9d3c07f-583c-469b-866a-56a927576998', version: latest
2020/08/12 09:17:07 GMT+08:00  e9d3c07f-583c-469b-866a-56a927576998 payload:{"key": "value"}2020/08/12 09:17:07 GMT+08:00  Finish invoke request 'e9d3c07f-583c-469b-866a-56a927576998'(invoke Failed), duration: 39.413ms, billing duration: 100ms, memory used: 73.766MB
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问