如何JavaSDK以及SDK调用示例 - 云工作流

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

前提条件

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

环境要求

最低要求Java 8。

步骤一：引入SDK

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

特化调用

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

访问云工作流 SDK。
在所有语言栏目中选择您需要的SDK语言。
选择您需要的安装方式，将代码复制到您的项目中。
在您的项目中载入该依赖包。

其Java语言的Maven依赖配置文件如下：

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>fnf20190315</artifactId>
  <version>1.1.2</version>
</dependency>

泛化调用

泛化调用方式不依赖任何一个产品的SDK，只依赖如下核心包com.aliyun.tea-openapi。其Java语言Maven依赖安装配置文件如下，最新版本请参见tea-openapi。

    <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>tea-openapi</artifactId>
      <version>0.2.8</version>
    </dependency>

步骤二：初始化Client

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

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

使用AK初始化

说明

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

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

更多认证信息配置方式，请参见管理访问凭据。
不同操作系统的环境变量配置方法不同，具体操作，请参见在Linux、macOS和Windows系统配置环境变量。

import com.aliyun.tea.*;

public class Sample {
    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化账号Client</p>
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.fnf20190315.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
                
        config.endpoint = "cn-hangzhou.fnf.aliyuncs.com";
        return new com.aliyun.fnf20190315.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.fnf20190315.Client client = Sample.createClient();
    }
}

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

说明

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

接口名称：CreateFlow

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

  // 创建请求对象
  com.aliyun.fnf20190315.models.CreateFlowRequest createFlowRequest = new com.aliyun.fnf20190315.models.CreateFlowRequest()
                // 您的流程名称
                .setName("your_flow_name")
                // 流程定义，遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。
                .setDefinition("旧版：
\"
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
\"")            
                // 流程描述
                .setDescription("my test flow")
                // 流程类型
                .setType("FDL");
        // 运行时配置        
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();

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

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化账号Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.fnf20190315.Client createClient() throws Exception {

        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = "cn-hangzhou.fnf.aliyuncs.com";
        return new com.aliyun.fnf20190315.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.fnf20190315.Client client = Sample.createClient();
        // 创建请求对象
        com.aliyun.fnf20190315.models.CreateFlowRequest createFlowRequest = new com.aliyun.fnf20190315.models.CreateFlowRequest()
                // 您的流程名称
                .setName("your_flow_name")
                // 流程定义，遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。
                .setDefinition("旧版：
\"
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
\"")            
                // 流程描述
                .setDescription("my test flow")
                // 流程类型
                .setType("FDL");
        // 运行时配置        
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // 复制代码运行请自行打印 API 的返回值
            client.createFlowWithOptions(createFlowRequest, runtime);
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}

接口名称：DescribeFlow

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

// 创建请求对象
com.aliyun.fnf20190315.models.DescribeFlowRequest describeFlowRequest = new com.aliyun.fnf20190315.models.DescribeFlowRequest()
                 // 您的流程名称
                .setName("your_flow_name");
        // 运行时配置        
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();

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

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化账号Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.fnf20190315.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
    
        config.endpoint = "cn-hangzhou.fnf.aliyuncs.com";
        return new com.aliyun.fnf20190315.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.fnf20190315.Client client = Sample.createClient();
        // 创建请求对象
        com.aliyun.fnf20190315.models.DescribeFlowRequest describeFlowRequest = new com.aliyun.fnf20190315.models.DescribeFlowRequest()
                 // 请求参数
                .setName("your_flow_name");
        // 运行时配置        
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // 复制代码运行请自行打印 API 的返回值
            client.describeFlowWithOptions(describeFlowRequest, runtime);
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}

接口名称：StartExecution

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

// 创建请求对象
com.aliyun.fnf20190315.models.StartExecutionRequest startExecutionRequest = new com.aliyun.fnf20190315.models.StartExecutionRequest()
                // 您的开始执行的流程名称
                .setFlowName("your_flow_name")
                // 执行名称
                .setExecutionName("your_exec_name")
                // 执行的输入
                .setInput("{\"key\":\"value\"}")
                // 流程执行结束后回调TaskToken相关任务
                .setCallbackFnFTaskToken("12");
        // 运行时配置        
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();

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

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化账号Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.fnf20190315.Client createClient() throws Exception {
 
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = "cn-hangzhou.fnf.aliyuncs.com";
        return new com.aliyun.fnf20190315.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.fnf20190315.Client client = Sample.createClient();
        // 创建请求对象
        com.aliyun.fnf20190315.models.StartExecutionRequest startExecutionRequest = new com.aliyun.fnf20190315.models.StartExecutionRequest()
                // 您的开始执行的流程名称
                .setFlowName("your_flow_name")
                // 执行名称
                .setExecutionName("your_exec_name")
                // 执行的输入
                .setInput("{\"key\":\"value\"}")
                // 流程执行结束后回调TaskToken相关任务
                .setCallbackFnFTaskToken("12");
        // 运行时配置        
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // 复制代码运行请自行打印 API 的返回值
            client.startExecutionWithOptions(startExecutionRequest, runtime);
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}

SDK调用示例

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