全部产品
云市场

安装新版 Java SDK

更新时间:2019-05-31 14:46:54

SDK 的文件名通常以 aliyun-XXXX-sdk 开头,后面跟上产品名称如 bssopenapi,组成如 aliyun-java-sdk-bssopenapi 的包名。其中有一个核心包 aliyun-java-sdk-core,其中封装了所有产品的 SDK 都会用到的一些类,如 IClientProfile 类、 IAcsClient 类、异常类等。产品相关的类均以产品为单位打包成不同名称的 Jar 包。

您需要准备好您的 AccessKey,用于输出到 创建 Profile 中。

Java SDK 使用方法示例

以 BssOpenApi Java SDK 查询订单详情的方法 GetOrderDetail 为例,介绍 SDK 使用的完整流程,其中 IClientProfile 和 IAcsClient 两个类包含在 aliyun-java-sdk-core 包中,其他的类均包含在 aliyun-java-sdk-bssopenapi 包中。

  1. 创建 Profile。生成 IClientProfile 的对象 profile,该对象存放 AccessKeyID 和 AccessKeySecret 和默认的地域信息,阿里云中国站的用户调用,统一设置为唯一值 cn-hangzhou。
    1. //给BssOpenApi产品添加默认region路由信息
    2. DefaultProfile.addEndpoint("cn-hangzhou","cn-hangzhou","BssOpenApi",
    3. "business.aliyuncs.com");
    4. // ak 是您的 AccessKey,aks 是您的 AccessKeySecret
    5. IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", ak, aks);
  2. 创建 Client。从 IClientProfile 类中再生成 IAcsClient 的对象 client,后续获得 response 都需要从 IClientProfile 中获得。
    1. IAcsClient client = new DefaultAcsClient(profile);
  3. 创建 Request。创建一个对应方法的 Request,类的命名规则一般为 API 的方法名加上 Request,如查询订单详情的 API 方法名为 GetOrderDetail ,那么对应的请求类名就是 GetOrderDetailRequest,直接使用构造函数生成一个默认的类 request。
    1. GetOrderDetailRequest request = new GetOrderDetailRequest();
    设置 Request 的参数。请求类生成好之后需要通过 Request 类的 setXxx 方法设置必要的信息,即 API 参数中必须要提供的信息, GetOrderDetail 的 API 方法必须要提供的参数为 OrderId,该值表示要查询的具体订单号。
    1. request.setRequestId("123");
    参数设置完毕后,通过 IAcsClient 对象获得对应 Request 的响应。
    1. GetOrderDetailResponse response = client.getAcsResponse(request);
    在 Response 中获得返回的参数值。接着可以调用 response 中对应的 getXxx 方法获得返回的参数值了。至此,一个完整的调用就完成了。