网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2025-02-18 GMT+08:00
分享

开发事件函数

Go函数接口定义

FunctionGraph运行时支持Go 1.x版本,函数有明确的接口定义,如下所示:

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

Go函数的函数执行入口参数格式为:与代码包中的可执行文件名保持一致。编译后的动态库文件名称必须与函数执行入口的插件名称保持一致,例如:动态库名称为testplugin.so,则函数执行入口命名为testplugin.Handler。请参考函数执行入口进行配置或修改。

约束与限制

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

SDK接口

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

  • 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

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

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

    Context接口说明如表19所示。

    表19 Context类上下文方法说明

    方法名

    方法说明

    getRequestID( )

    获取请求ID。

    getRemainingTimeInMilligetRunningTimeInSecondsSeconds ( )

    获取函数剩余运行时间。

    getAccessKey( )

    获取用户委托的AccessKey(有效期24小时),使用该方法需要给函数配置委托。

    当前函数工作流已停止维护Runtime SDK 中getAccessKey接口,您将无法使用getAccessKey获取临时AK。

    getSecretKey( )

    获取用户委托的SecretKey(有效期24小时),使用该方法需要给函数配置委托。

    当前函数工作流已停止维护Runtime SDK 中getSecretKey接口,您将无法使用getSecretKey获取临时SK。

    getSecurityAccessKey()

    获取用户委托的SecurityAccessKey(有效期24小时),使用该方法需要给函数配置委托。

    getSecuritySecretKey()

    获取用户委托的SecuritySecretKey(有效期24小时),使用该方法需要给函数配置委托。

    getSecurityToken()

    获取用户委托的SecurityToken(有效期24小时),使用该方法需要给函数配置委托。

    getUserData(string key)

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

    getFunctionName( )

    获取函数名称。

    getRunningTimeInSeconds ( )

    获取函数超时时间。

    getVersion( )

    获取函数的版本。

    getMemorySize( )

    分配的内存。

    getCPUNumber( )

    获取函数占用的CPU资源。

    getPackage( )

    获取函数组。

    getToken( )

    获取用户委托的token(有效期24小时),使用该方法需要给函数配置委托。

    getLogger( )

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

    getAlias

    获取函数的别名

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

    方法名

    方法说明

    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.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提供的运行时上下文对象,具体提供的方法可以参考表19,以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),目前只支持注册一个入口
    4. 当函数的事件源是APIG时,相关约束条件请参考Base64解码和返回结构体的说明

  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),目前只支持注册一个入口
    4. 当函数的事件源是APIG时,相关约束条件请参考Base64解码和返回结构体的说明

  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

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

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

        在函数详情页,单击“配置测试事件”,弹出“配置测试事件”页,输入测试信息如图1所示,单击“创建”。

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

      函数执行结果分为三部分,分别为函数返回(由callback返回)、执行摘要、日志输出(由fmt.Println()方法获取的日志方法输出)。

执行结果

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

表21 执行结果说明

参数项

执行成功

执行失败

函数返回

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

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

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

errorMessage:Runtime返回的错误信息

errorType:错误类型

执行摘要

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

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

日志

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

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

相关文档