AI 助理
备案控制台
文档
输入文档关键字查找
首页 云工作流 云工作流 CloudFlow（新版） 开发参考 SDK参考 安装Go SDK

安装Go SDK

更新时间：
产品详情
我的收藏

本文将详细介绍云工作流的Go SDK安装步骤及调用示例。以Go语言为例，本文将讲解如何调用云工作流以创建流程接口、获取流程相关信息接口，以及异步启动流程执行的接口为例，并提供完整的集成步骤。

前提条件

调用阿里云OpenAPI通常需要设置访问密钥（AccessKey）。请确保已创建AccessKey。具体操作，请参见创建AccessKey。为了避免凭据泄露，常见的方案是将其写入到环境变量中，更多安全方案请参见使用访问凭据访问阿里云OpenAPI最佳实践。

环境要求

Go 环境版本必须不低于 1.10.x。

步骤一：引入SDK

阿里云SDK支持泛化与特化两种方式调用OpenAPI，详情参见泛化调用与特化调用，不同的调用方式需要引入的SDK也不同。

特化调用

您可以访问OpenAPI门户网站，搜索您需要的产品，查看产品支持的SDK语言及安装方法，然后在您的项目中引入SDK。本案例的SDK获取步骤如下：

  1. 访问云工作流 SDK。

  2. 在所有语言栏目中选择您需要的SDK语言。

  3. 选择您需要的安装方式，将代码复制到您的项目中。

  4. 在您的项目中载入该依赖包。

其Go语言安装云工作流（FNF）产品如下：

go get github.com/alibabacloud-go/fnf-20190315/v2

泛化调用

泛化调用方式不依赖任何一个产品的SDK，只依赖如下核心包github.com/alibabacloud-go/darabonba-openapi/v2/client。其Go语言安装方式如下，最新版本请参见darabonba-openapi。

go get github.com/alibabacloud-go/darabonba-openapi/v2/client

步骤二：初始化Client

请根据云工作流（FNF）所属地域正确填写服务接入地址（又称“访问端点”或“Endpoint”），关于服务接入地址的更多信息，请参见支持的地域。

以下将以特化调用代码为例，详细说明调用过程。如您选择泛化调用方案，更多信息请参见泛化调用与特化调用。

使用AK初始化

说明

阿里云账号AccessKey拥有所有OpenAPI的访问权限，建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。

本示例以将AccessKey配置在环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET的方式来实现身份验证为例。

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  fnf20190315  "github.com/alibabacloud-go/fnf-20190315/v2/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient () (_result *fnf20190315.Client, _err error) {
  config := &openapi.Config{
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  config.Endpoint = tea.String("cn-hangzhou.fnf.aliyuncs.com")
  _result = &fnf20190315.Client{}
  _result, _err = fnf20190315.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {

  client, _err := CreateClient()

  if _err != nil {

    return _err

  }

}

步骤三：使用已初始化的Client调用云工作流（FNF） API

说明

初始化Client后，您可以通过Client调用云工作流API。

接口名称：CreateFlow

此接口用于创建一个流程。在调用过程中，您需要根据实际业务需求创建请求对象，并设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

 // 创建请求对象
 createFlowRequest := &fnf20190315.CreateFlowRequest{
    // 您的流程名称
    Name: tea.String("your_flow_name"),
    // 流程定义，遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。
    Definition: tea.String("旧版：
\"
type: flow
version: v1
name: my_flow_name
steps:
  - type: pass
    name: mypass
\"

新版：
\"
Type: StateMachine
SpecVersion: v1
Name: my_flow_name
StartAt: my_state
States:
  - Type: Pass
    Name: my_state
    End: true
\""),
    // 流程描述
    Description: tea.String("your test flow"),
    // 流程类型
    Type: tea.String("FDL"),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}

以下是使用AK创建一个流程的完整示例代码：

// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  fnf20190315  "github.com/alibabacloud-go/fnf-20190315/v2/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient () (_result *fnf20190315.Client, _err error) {
  config := &openapi.Config{
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  config.Endpoint = tea.String("cn-hangzhou.fnf.aliyuncs.com")
  _result = &fnf20190315.Client{}
  _result, _err = fnf20190315.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  // 创建请求对象
 createFlowRequest := &fnf20190315.CreateFlowRequest{
    // 您的流程名称
    Name: tea.String("your_flow_name"),
    // 流程定义，遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。
    Definition: tea.String("旧版：
\"
type: flow
version: v1
name: my_flow_name
steps:
  - type: pass
    name: mypass
\"

新版：
\"
Type: StateMachine
SpecVersion: v1
Name: my_flow_name
StartAt: my_state
States:
  - Type: Pass
    Name: my_state
    End: true
\""),
    // 流程描述
    Description: tea.String("your test flow"),
    // 流程类型
    Type: tea.String("FDL"),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    // 复制代码运行请自行打印 API 的返回值
    _, _err = client.CreateFlowWithOptions(createFlowRequest, runtime)
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var error = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      error = _t
    } else {
      error.Message = tea.String(tryErr.Error())
    }
    // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
    // 错误 message
    fmt.Println(tea.StringValue(error.Message))
    // 诊断地址
    var data interface{}
    d := json.NewDecoder(strings.NewReader(tea.StringValue(error.Data)))
    d.Decode(&data)
    if m, ok := data.(map[string]interface{}); ok {
      recommend, _ := m["Recommend"]
      fmt.Println(recommend)
    }
    _, _err = util.AssertAsString(error.Message)
    if _err != nil {
      return _err
    }
  }
  return _err
}


func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

接口名称：DescribeFlow

此接口用于获取特定流程的相关信息。在调用过程中，您需要根据实际业务需求创建请求对象，并设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

// 创建请求对象并设置入参
describeFlowRequest := &fnf20190315.DescribeFlowRequest{
    // 您的流程名称
    Name: tea.String("your_flow_name"),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}

以下是使用AK获取流程相关信息的完整示例代码：

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  fnf20190315  "github.com/alibabacloud-go/fnf-20190315/v2/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient () (_result *fnf20190315.Client, _err error) {
  config := &openapi.Config{
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  config.Endpoint = tea.String("cn-hangzhou.fnf.aliyuncs.com")
  _result = &fnf20190315.Client{}
  _result, _err = fnf20190315.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }
  // 创建请求对象并设置入参
  describeFlowRequest := &fnf20190315.DescribeFlowRequest{
    // 您的流程名称
    Name: tea.String("your_flow_name"),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    // 复制代码运行请自行打印 API 的返回值
    _, _err = client.DescribeFlowWithOptions(describeFlowRequest, runtime)
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var error = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      error = _t
    } else {
      error.Message = tea.String(tryErr.Error())
    }
    // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
    // 错误 message
    fmt.Println(tea.StringValue(error.Message))
    // 诊断地址
    var data interface{}
    d := json.NewDecoder(strings.NewReader(tea.StringValue(error.Data)))
    d.Decode(&data)
    if m, ok := data.(map[string]interface{}); ok {
      recommend, _ := m["Recommend"]
      fmt.Println(recommend)
    }
    _, _err = util.AssertAsString(error.Message)
    if _err != nil {
      return _err
    }
  }
  return _err
}


func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

接口名称：StartExecution

此接口用于异步调用以启动一个流程的执行。在调用过程中，您需要根据实际业务需求构建请求对象，并设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

// 创建请求对象并设置入参
startExecutionRequest := &fnf20190315.StartExecutionRequest{
    // 您开始执行的流程名称 
    FlowName: tea.String("your_flow_name"),
    // 您的执行名称
    ExecutionName: tea.String("your_exec_name"),
    // 执行的输入
    Input: tea.String("{\"key\":\"value\"}"),
    // 流程执行结束后回调TaskToken相关任务 示例值：12
    CallbackFnFTaskToken: tea.String("12"),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}

以下是使用AK异步调用启动一个流程的执行的完整示例代码：

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  fnf20190315  "github.com/alibabacloud-go/fnf-20190315/v2/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient () (_result *fnf20190315.Client, _err error) {
  config := &openapi.Config{
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  config.Endpoint = tea.String("cn-hangzhou.fnf.aliyuncs.com")
  _result = &fnf20190315.Client{}
  _result, _err = fnf20190315.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

// 创建请求对象并设置入参
startExecutionRequest := &fnf20190315.StartExecutionRequest{
    // 您开始执行的流程名称 
    FlowName: tea.String("your_flow_name"),
    // 您的执行名称
    ExecutionName: tea.String("your_exec_name"),
    // 执行的输入
    Input: tea.String("{\"key\":\"value\"}"),
    // 流程执行结束后回调TaskToken相关任务 示例值：12
    CallbackFnFTaskToken: tea.String("12"),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    // 复制代码运行请自行打印 API 的返回值
    _, _err = client.StartExecutionWithOptions(startExecutionRequest, runtime)
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var error = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      error = _t
    } else {
      error.Message = tea.String(tryErr.Error())
    }
    // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
    // 错误 message
    fmt.Println(tea.StringValue(error.Message))
    // 诊断地址
    var data interface{}
    d := json.NewDecoder(strings.NewReader(tea.StringValue(error.Data)))
    d.Decode(&data)
    if m, ok := data.(map[string]interface{}); ok {
      recommend, _ := m["Recommend"]
      fmt.Println(recommend)
    }
    _, _err = util.AssertAsString(error.Message)
    if _err != nil {
      return _err
    }
  }
  return _err
}


func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

SDK调用示例

您可以使用API级别的多语言SDK Demo进行调试。示例代码，请参见开发者门户OpenAPI Explorer。

上一篇：SDK概述下一篇：安装Java SDK
文档推荐