集成SDK
集成阿里云SDK主要有三步:设置访问凭据、引入阿里云SDK、编写调用代码。本文将以Java
语言调用短信服务 SMS(Short Message Service)的发送短信接口为例,讲解完整的集成步骤。
环境要求
Java版本 >= 1.8。
第一步:设置访问凭据
调用阿里云OpenAPI通常需要设置访问密钥(AccessKey),详情参见凭据。为了避免凭据泄露,常见的方案是将其写入到环境变量中,更多安全方案请参见凭据的安全使用方案。以设置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
为例:
Linux和macOS系统配置方法
创建
.bash_profile
文件说明如果是第一次配置环境变量,可以使用
touch ~/.bash_profile
创建一个配置文件,如果已经存在配置文件,则使用vim ~/.bash_profile
命令。touch .bash_profile vim ~/.bash_profile
配置
.bash_profile
文件# 将以下命令中的<ACCESS_KEY_ID>和<ACCESS_KEY_SECRET>替换为您自己的AccessKey ID和AccessKey Secret。 # 变量名称可以根据实际情况进行替换,例如OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET。 export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID> export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>
编辑完成后保存退出。
使用
.bash_profile
文件# 使配置文件生效 source ~/.bash_profile # 显示配置是否生效 echo $ALIBABA_CLOUD_ACCESS_KEY_ID
若返回正确的AccessKey,则说明配置成功。
重启IDE(不重启可能会出现无法读取环境变量的情况)。
说明如果是Linux系统,以上命令将仅作为临时环境变量作用于当前命令行,仅对本命令行运行的程序生效。例如,Maven程序可通过
mvn package
命令将程序打包成jar文件,然后通过java -jar <jarfilepath>
在当前命令行运行jar文件。
Windows系统配置方法
以设置环境变量
ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
为例:通过图形用户界面GUI设置阿里云AccessKey环境变量
操作步骤
以下为Windows 10中通过图形用户界面设置环境变量的步骤。
在桌面右键单击此电脑,选择属性>高级系统设置>环境变量>系统变量/用户变量>新建,完成以下配置:
变量
示例值
AccessKey ID
变量名:ALIBABA_CLOUD_ACCESS_KEY_ID
变量值:LTAI4GDty8ab9W4Y1D****
AccessKey Secret
变量名:ALIBABA_CLOUD_ACCESS_KEY_SECRET
变量值:IrVTNZNy5yQelTETg0cZML3TQn****
测试配置是否成功
单击开始(或快捷键:Win+R)> 运行(输入 cmd)> 确定(或按 Enter 键),打开命令提示符,执行
echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%
命令。若返回正确的AccessKey,则说明配置成功。
通过命令行提示符CMD设置阿里云AccessKey环境变量
操作步骤
打开命令提示符(以管理员身份),并使用以下命令在系统中新增环境变量。
setx ALIBABA_CLOUD_ACCESS_KEY_ID3 LTAI4GDty8ab9W4Y1D**** /M setx ALIBABA_CLOUD_ACCESS_KEY_SECRET IrVTNZNy5yQelTETg0cZML3TQn**** /M
其中
/M
表示系统级环境变量,设置用户级环境变量时可以不携带该参数。测试配置是否成功
单击开始(或快捷键:Win+R)> 运行(输入 cmd)> 确定(或按 Enter 键),打开命令提示符,执行
echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%
命令。若返回正确的AccessKey,则说明配置成功。
通过Windows PowerShell设置阿里云AccessKey环境变量
在PowerShell中,设置新的环境变量(对所有新会话有效):
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::User) [System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::User)
为所有用户设置环境变量(需要管理员权限):
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::Machine)
设置临时的环境变量(仅当前会话有效):
$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "LTAI4GDty8ab9W4Y1D****" $env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "IrVTNZNy5yQelTETg0cZML3TQn****"
在PowerShell中,执行
Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID
、Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET
命令。若返回正确的AccessKey,则说明配置成功。
第二步:引入SDK
阿里云SDK支持泛化与特化两种方式调用OpenAPI,详情参见泛化调用与特化调用,不同的调用方式需要引入的SDK也不同。
特化调用
您可以访问OpenAPI门户网站,搜索您需要的产品,查看产品支持的SDK语言及安装方法,然后在您的项目中引入SDK。本案例的SDK获取步骤如下:
访问短信服务SDK。
在所有语言栏目中选择您需要的SDK语言。
选择您需要的安装方式,将代码复制到您的项目中。
在您的项目中载入该依赖包。
其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)