使用 Java SDK 快速开始

更新时间:2023.08.17

在本教程中,你将简要了解微信支付的 Java SDK。在学习过程中,你将

  • 掌握如何安装 Java SDK
  • 了解请求微信支付需要哪些密钥和证书
  • 了解如何使用 Java SDK 请求微信支付

# 环境要求

  • Java 1.8+

# 安装

使用包管理系统,例如 Maven、Gradle,快速添加微信支付官方 SDK。

如果你使用的 Gradle (opens new window),请在 build.gradle 中加入:

1implementation 'com.github.wechatpay-apiv3:wechatpay-java:${VERSION}'

如果你使用的 Maven (opens new window),请在 pom.xml 中加入:

1<dependency>
2 <groupId>com.github.wechatpay-apiv3</groupId>
3 <artifactId>wechatpay-java</artifactId>
4 <version>${VERSION}</version>
5</dependency>

你可以在 GitHub 找到 Java SDK (opens new window) 的源代码、使用说明和最新版本信息。

# 必需的证书和密钥

运行 SDK 必需以下的商户身份信息,用于构造请求的签名和验证应答的签名:

# 发起请求

以 Native 支付为例,向微信支付发起你的第一个请求:

1package com.wechat.pay.java.service;
2
3import com.wechat.pay.java.core.Config;
4import com.wechat.pay.java.core.RSAAutoCertificateConfig;
5import com.wechat.pay.java.service.payments.nativepay.NativePayService;
6import com.wechat.pay.java.service.payments.nativepay.model.Amount;
7import com.wechat.pay.java.service.payments.nativepay.model.PrepayRequest;
8import com.wechat.pay.java.service.payments.nativepay.model.PrepayResponse;
9
10/** Native 支付下单为例 */
11public class QuickStart {
12
13 /** 商户号 */
14 public static String merchantId = "190000****";
15 /** 商户API私钥路径 */
16 public static String privateKeyPath = "/Users/yourname/your/path/apiclient_key.pem";
17 /** 商户证书序列号 */
18 public static String merchantSerialNumber = "5157F09EFDC096DE15EBE81A47057A72********";
19 /** 商户APIV3密钥 */
20 public static String apiV3key = "...";
21
22 public static void main(String[] args) {
23 // 使用自动更新平台证书的RSA配置
24 // 建议将 config 作为单例或全局静态对象,避免重复的下载浪费系统资源
25 Config config =
26 new RSAAutoCertificateConfig.Builder()
27 .merchantId(merchantId)
28 .privateKeyFromPath(privateKeyPath)
29 .merchantSerialNumber(merchantSerialNumber)
30 .apiV3Key(apiV3key)
31 .build();
32 // 构建service
33 NativePayService service = new NativePayService.Builder().config(config).build();
34 // request.setXxx(val)设置所需参数,具体参数可见Request定义
35 PrepayRequest request = new PrepayRequest();
36 Amount amount = new Amount();
37 amount.setTotal(100);
38 request.setAmount(amount);
39 request.setAppid("wxa9d9651ae******");
40 request.setMchid("190000****");
41 request.setDescription("测试商品标题");
42 request.setNotifyUrl("https://notify_url");
43 request.setOutTradeNo("out_trade_no_001");
44 // 调用下单方法,得到应答
45 PrepayResponse response = service.prepay(request);
46 // 使用微信扫描 code_url 对应的二维码,即可体验Native支付
47 System.out.println(response.getCodeUrl());
48 }
49}

# 联系 SDK 团队获取帮助

# 接下来阅读

通过这个快速介绍,你已经安装了 Java SDK 并学习了一些基础知识。接下来,你可以: