文档

集成SDK

更新时间:
一键部署

集成阿里云SDK主要有三步:设置访问凭据、引入阿里云SDK、编写调用代码。本文将以Java语言调用短信服务 SMS(Short Message Service)的发送短信接口为例,讲解完整的集成步骤。

环境要求

Java版本 >= 1.8。

第一步:设置访问凭据

调用阿里云OpenAPI通常需要设置访问密钥(AccessKey),详情参见凭据。为了避免凭据泄露,常见的方案是将其写入到环境变量中,更多安全方案请参见凭据的安全使用方案。本案例以设置环境变量为例:

配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET

  • Linux和macOS系统配置方法

    命令行终端执行以下命令:

    export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>

    <access_key_id>需替换为已准备好的AccessKey ID,<access_key_secret>替换为AccessKey Secret。

  • Windows系统配置方法

    1. 新建环境变量文件,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。

第二步:引入SDK

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

特化调用

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

  1. 访问短信服务SDK

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

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

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

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

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>dysmsapi20170525</artifactId>
  <version>2.0.24</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>

第三步:调用OpenAPI

您可以根据快速开始文档下载示例代码。接下来我们以特化调用代码为例,讲解调用过程。如果您选择泛化调用方案,请打开Common模式生成示例的开关,更多信息请参见泛化调用与特化调用

初始化请求客户端

方法一:使用AK初始化

import com.aliyun.teaopenapi.models.Config;
import com.aliyun.dysmsapi20170525.Client;

public static void createClient() throws Exception {
    com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
        // 必填,您的 AccessKey ID
        .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
        // 必填,您的 AccessKey Secret
        .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
    // Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
    config.endpoint = "dysmsapi.aliyuncs.com";
    // 特化请求客户端
    com.aliyun.dysmsapi20170525.Client dysmsapiClient = new com.aliyun.dysmsapi20170525.Client(config);
}

方法二:使用STS Token初始化

import com.aliyun.teaopenapi.models.Config;
import com.aliyun.dysmsapi20170525.Client;

public static void createClient() throws Exception {
    com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
        // 必填,您的 AccessKey ID
        .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
        // 必填,您的 AccessKey Secret
        .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
        // 必填,您的 STS Token
        .setSecurityToken(System.getenv("ALIBABA_CLOUD_SECURITY_TOKEN"));
    // Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
    config.endpoint = "dysmsapi.aliyuncs.com";
    // 特化请求客户端
    com.aliyun.dysmsapi20170525.Client dysmsapiClient = new com.aliyun.dysmsapi20170525.Client(config);
}

方法三:使用Credentials工具初始化

import com.aliyun.credentials.Client;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.dysmsapi20170525.Client;

public static void createClient() throws Exception {
    // 使用默认凭证初始化Credentials Client。
    com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
    com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
    // 使用Credentials配置凭证。
    config.setCredential(credentialClient);
    // 若接入dysmsapi即短信服务,则初始化dysmsapi产品包的Client类
    config.endpoint = "dysmsapi.aliyuncs.com";
    // 特化请求客户端
    com.aliyun.dysmsapi20170525.Client dysmsapiClient = new com.aliyun.dysmsapi20170525.Client(config);
}

创建请求对象&运行时配置

通常您需要根据业务的实际需要传入参数,您也可自定义运行时配置。

// 创建请求对象并设置入参
com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest()
    .setPhoneNumbers("<YOUR_VALUE>")
    .setSignName("<YOUR_VALUE>");
// 创建运行时配置对象
com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();

发起请求

升级版 SDK 中每个产品的 Client 包含了所有的 OpenAPI,所以可以指定 OpenAPI 请求方法来请求,其方法名对应 OpenAPI 首字母小写,一般有三个:

  • <接口名称>:使用默认的运行时配置发起接口调用,可以不用传入运行参数的请求方法。

    import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
    import com.google.gson.Gson;
     
    public class Sample {
        public static void main(String[] args) throws Exception {
            // 初始化 SDK 客户端
            com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
            
            com.aliyun.teaopenapi.models.Config smsConfig = new com.aliyun.teaopenapi.models.Config();
            smsConfig.setCredential(credentialClient);
            smsConfig.setRegionId("<regionId>");
            com.aliyun.dysmsapi20170525.Client smsClient = new com.aliyun.dysmsapi20170525.Client(smsConfig);
            // 构造请求对象
            com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest();
            // 获取响应对象
            SendSmsResponse sendSmsResponse = smsClient.sendSms(sendSmsRequest);
            // response 包含服务端响应的 body 和 headers
          	System.out.println(new Gson().toJson(sendSmsResponse.body));
            System.out.println(new Gson().toJson(sendSmsResponse.headers));
        }
    }
  • <接口名称>WithOptions:可配置自定义运行时参数发起接口调用,更多运行时参数配置请参见进阶配置

    import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
    import com.google.gson.Gson;
    
    public class Sample {
        public static void main(String[] args) throws Exception {
            // 初始化 SDK 客户端
            com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
    
            com.aliyun.teaopenapi.models.Config smsConfig = new com.aliyun.teaopenapi.models.Config();
            smsConfig.setCredential(credentialClient);
            smsConfig.setRegionId("<regionId>");
            com.aliyun.dysmsapi20170525.Client smsClient = new com.aliyun.dysmsapi20170525.Client(smsConfig);
            // 构造运行时参数对象
            com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
            // 读取超时
            runtime.readTimeout=10000;
            // 连接超时
            runtime.connectTimeout=5000;
            // 是否自动重试
            runtime.autoretry=false;
            // 构造请求对象
            com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest();
            // 将运行时参数配置到请求中,将作用于本次调用
            SendSmsResponse sendSmsResponse = smsClient.sendSmsWithOptions(sendSmsRequest,runtime);
            // response 包含服务端响应的 body 和 headers
            System.out.println(new Gson().toJson(sendSmsResponse.body));
            System.out.println(new Gson().toJson(sendSmsResponse.headers));
        }
    }
  • <接口名称>Advance:专门用于应对直接上传Object 的场景,该方法默认需要传入运行时参数。下述示例以视觉智能开放平台人体人脸产品为例介绍SDK如何使用本地文件上传调用 API。

    <!--    视觉智能开放平台人体人脸产品依赖-->
        <dependency>
          <groupId>com.aliyun</groupId>
          <artifactId>facebody20191230</artifactId>
          <version>3.0.7</version>
        </dependency>
    import com.aliyun.facebody20191230.models.DetectBodyCountAdvanceRequest;
    import com.aliyun.facebody20191230.models.DetectBodyCountResponse;
    import com.aliyun.teautil.models.RuntimeOptions;
    import com.google.gson.Gson;
    import java.io.File;
    import java.io.FileInputStream;
    import java.io.InputStream;
     
    public class Sample {
        public static void main(String[] args) throws Exception {
            // 初始化 SDK 客户端
            com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
            com.aliyun.teaopenapi.models.Config facebodyConfig = new com.aliyun.teaopenapi.models.Config();
            facebodyConfig.setCredential(credentialClient);
            facebodyConfig.setRegionId("<regionId>");
            com.aliyun.facebody20191230.Client facebodyClient = new com.aliyun.facebody20191230.Client(facebodyConfig);
            RuntimeOptions runtimeOptions = new RuntimeOptions();
            // 读取文件并实例化文件流
            File f = new File("<YOUR-FILE-PATH>");
            InputStream in = new FileInputStream(f);
     
            DetectBodyCountAdvanceRequest request = new DetectBodyCountAdvanceRequest();
            // 将文件流配置给SDK请求对象
            request.setImageURLObject(in);
            // 调用本地文件上传方法,将文件上传
            DetectBodyCountResponse resp = facebodyClient.detectBodyCountAdvance(request, runtimeOptions);
            // response 包含服务端响应的 body 和 headers
            System.out.println(new Gson().toJson(resp.body));
            System.out.println(new Gson().toJson(resp.headers));
        }
    }

  • 本页导读 (1)
文档反馈