[](https://mvnrepository.com/artifact/com.alipay.sdk/alipay-sdk-java)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Falipay%2Falipay-sdk-java-all?ref=badge_shield)
[](https://www.codacy.com/manual/antopen/alipay-sdk-java-all?utm_source=github.com&utm_medium=referral&utm_content=alipay/alipay-sdk-java-all&utm_campaign=Badge_Grade)
[](https://www.travis-ci.org/alipay/alipay-sdk-java-all)
[](https://codecov.io/gh/alipay/alipay-sdk-java-all)
欢迎使用 Alipay SDK for Java 。
Alipay SDK for Java让您不用复杂编程即可访支付宝开放平台开放的各项能力，SDK可以自动帮您满足能力调用过程中所需的证书校验、加签、验签、发送HTTP请求等非功能性要求。
这里向您介绍如何获取 Alipay SDK for Java 并开始调用。
如果您在使用 Alipay SDK for Java 的过程中遇到任何问题，欢迎在当前 GitHub [提交 Issues](https://github.com/alipay/alipay-sdk-java-all/issues/new)。
## 环境要求
1. Alipay SDK for Java 需要配合`JKD 1.6`或其以上版本。
2. 使用 Alipay SDK for Java 之前 ，您需要先前往[支付宝开发平台-开发者中心](https://openhome.alipay.com/platform/developerIndex.htm)完成开发者接入的一些准备工作，包括创建应用、为应用添加功能包、设置应用的接口加签方式等。
3. 准备工作完成后，注意保存如下信息，后续将作为使用SDK的输入。
* 加签模式为公钥证书模式时（推荐）
`AppID`、`应用的私钥`、`应用的公钥证书文件`、`支付宝公钥证书文件`、`支付宝根证书文件`
* 加签模式为公钥模式时
`AppId`、`应用的私钥`、`应用的公钥`、`支付宝公钥`
## 安装依赖
推荐通过Maven来管理项目依赖，您只需在项目的`pom.xml`文件中声明如下依赖
```xml
com.alipay.sdk
alipay-sdk-java
4.39.60.ALL
```
## 快速使用
以下这段代码示例向您展示了使用Alipay SDK for Java调用一个API的3个主要步骤：
1. 创建DefaultAlipayClient实例并初始化。
2. 创建API请求对象并设置Model参数。
3. 发起请求并处理响应或异常。
```java
import com.alipay.api.AlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.domain.AlipayOpenOperationOpenbizmockBizQueryModel;
import com.alipay.api.request.AlipayOpenOperationOpenbizmockBizQueryRequest;
import com.alipay.api.response.AlipayOpenOperationOpenbizmockBizQueryResponse;
public class Main {
public static void main(String[] args) {
try {
// 1. 创建AlipayClient实例
AlipayClient alipayClient = new DefaultAlipayClient(getClientParams());
// 2. 创建使用的Open API对应的Request请求对象
AlipayOpenOperationOpenbizmockBizQueryRequest request = getRequest();
// 3. 发起请求并处理响应
AlipayOpenOperationOpenbizmockBizQueryResponse response = alipayClient.certificateExecute(request);
if (response.isSuccess()) {
System.out.println("调用成功。");
} else {
System.out.println("调用失败，原因：" + response.getMsg() + "，" + response.getSubMsg());
}
} catch (Exception e) {
System.out.println("调用遭遇异常，原因：" + e.getMessage());
throw new RuntimeException(e.getMessage(), e);
}
}
private static CertAlipayRequest getClientParams() {
CertAlipayRequest certParams = new CertAlipayRequest();
certParams.setServerUrl("https://openapi.alipay.com/gateway.do");
//请更换为您的AppId
certParams.setAppId("2019091767145019");
//请更换为您的PKCS8格式的应用私钥
certParams.setPrivateKey("MIIEvQIBADANB ... ...");
//请更换为您使用的字符集编码，推荐采用utf-8
certParams.setCharset("utf-8");
certParams.setFormat("json");
certParams.setSignType("RSA2");
//请更换为您的应用公钥证书文件路径
certParams.setCertPath("/home/foo/appCertPublicKey_2019091767145019.crt");
//请更换您的支付宝公钥证书文件路径
certParams.setAlipayPublicCertPath("/home/foo/alipayCertPublicKey_RSA2.crt");
//更换为支付宝根证书文件路径
certParams.setRootCertPath("/home/foo/alipayRootCert.crt");
return certParams;
}
private static AlipayOpenOperationOpenbizmockBizQueryRequest getRequest() {
// 初始化Request，并填充Model属性。实际调用时请替换为您想要使用的API对应的Request对象。
AlipayOpenOperationOpenbizmockBizQueryRequest request = new AlipayOpenOperationOpenbizmockBizQueryRequest();
AlipayOpenOperationOpenbizmockBizQueryModel model = new AlipayOpenOperationOpenbizmockBizQueryModel();
model.setBizNo("test");
request.setBizModel(model);
return request;
}
}
```
## 快速排查
当response.isSuccess()返回false时，您可通过日志查看trace_id。trace_id可提供给支付宝技术支持用于问题的快速排查
## 文档
[SDK文档首页](https://docs.open.alipay.com/54/103419/)
## 公告
经监测，开源的Java开发组件Fastjson存在远程代码执行漏洞，攻击者可利用上述漏洞远程执行任意代码。Java SDK（alipay-sdk-java）在4.34.0版本之前使用了存在漏洞的Fastjson版本（详见：[关于Fastjson漏洞预警的公告](https://opendocs.alipay.com/rules/03f7dr) ）。
建议将上述SDK升级至 4.34.0 及以上版本（如已是更新版本请忽略，无需任何操作），以免出现风险或损失。
升级说明：
请将项目中对Java SDK的Maven依赖的版本号更新到`4.34.0.ALL`或以上，如下所示：
```xml
com.alipay.sdk
alipay-sdk-java
4.39.60.ALL
```
温馨提示：
1）强烈建议开发者在升级后进行业务功能的回归验证，以免出现不可预见的兼容性问题影响业务正常运行。
2）如若遇到特殊情况导致升级失败，请进行代码回滚，修改POM引用的原版本。
## 问题
不管您在使用SDK的过程中遇到任何问题，欢迎前往 [支付宝开放社区](https://forum.alipay.com/mini-app/channel/1100001) 发帖与支付宝工作人员和其他开发者一起交流。
注：为了提高开发者问题的响应时效，github本身的issue功能已关闭，支付宝开放社区中发帖的问题，通常会在2小时内响应。
## 变更日志
每个版本的详细更改记录在[变更日志](./CHANGELOG)中。
注：版本号最末一位修订号的增加（比如从`4.8.62.ALL`升级为`4.8.74.ALL`），意味着SDK的功能没有发生任何变化，仅仅是集成了更多的API的Request、Response、Model类，此类变更默认不记录在变更日志中。
## 相关
* [支付宝开放平台](https://open.alipay.com/platform/home.htm)
* [支付宝开放平台文档中心](https://docs.open.alipay.com/catalog)
* [最新源码](https://github.com/alipay/alipay-sdk-java-all)
## 许可证
[](https://app.fossa.com/projects/git%2Bgithub.com%2Falipay%2Falipay-sdk-java-all?ref=badge_large)