payment-spring-boot/docs/quick_start.md

Maven 中央仓库坐标

<dependency>
    <groupId>cn.felord</groupId>
    <artifactId>payment-spring-boot-starter</artifactId>
    <version>1.0.21.RELEASE</version>
</dependency>

基于 Spring Boot 2.x

Spring Boot 版本适配

需要自行克隆项目，修改根目录下的pom.xml以下配置项：

    <properties>
        <!--  修改为你对应的Spring Boot版本号 -->
        <spring-boot.version>2.4.0</spring-boot.version>
    </properties>

然后安装使用

自行安装

以Spring Boot Starter的形式集成到项目中。从GitHub项目地址拉取release分支到本地后使用以下两种方式之一进行环境集成：

• mvn install 安装到本地
• mvn deploy部署到Maven仓库

然后引用Maven坐标，请注意${payment-spring-boot-starter.version}要同你安装的一致。

      <dependency>
            <groupId>cn.felord</groupId>
            <artifactId>payment-spring-boot-starter</artifactId>
            <version>${payment-spring-boot-starter.version}</version>
      </dependency>

配置

微信支付

在Spring Boot项目中的application.yaml中配置wechat.pay.v3相关参数。

wechat:
  pay:
    v3:
#    租户id  
     <tentantID>: 
#  应用appId  服务商模式下为服务商的appid 必填  
      app-id: xxxxxxxx
#  v2 api 密钥  1.0.5版本以后如果用到V2的接口时必填
      app-secret: xxxxxxxxxxx
#  api v3 密钥 必填
      app-v3-secret: xxxxxxxx
#  微信支付商户号 服务商模式下为服务商的mchid 必填
      mch-id: xxxxxxx
#  商户服务器域名 用于回调  需要放开回调接口的安全策略 必填
      domain: https://felord.cn
#  商户 api 证书路径 必填  填写classpath路径 位于 maven项目的resources文件下
      cert-path: apiclient_cert.p12
 

微信支付 tentantID 场景说明

当项目中需要同时支持微信App支付、微信公众号支付、微信小程序支付时，上述配置中的app-id可能为多个，因此我们需要进行路由标识以区分它们，所以这里需要你定义一个tentanID来进行标识。假如我们同时有App支付和微信小程序支付，我们应该这样配置：

wechat:
  pay:
    v3:
    # App租户租户标识为 mobile
     mobile:
      app-id: wx524534x423234
      app-secret: felord
      app-v3-secret: 0e5b123323h12234927e455703ec
      mch-id: 1603337223
      domain: https://felord.cn/mobile
      cert-path: mobile/apiclient_cert.p12
    # 微信小程序租户标识为 miniapp  
     miniapp:
      app-id: wx344123x3541223
      app-secret: felord
      app-v3-secret: 0e5b123323h12234927e455703ec
      mch-id: 1603337223
      domain: https://felord.cn/miniapp
      cert-path: miniapp/apiclient_cert.p12
      # 是否启用微信支付公钥
      enable-wechat-pay-public: true
      #微信公钥ID
      wechat-pay-public-key-id: PUB_KEY_ID_0116278111111115222222501
      #微信公钥
      wechat-pay-public-key-path: pub_key.pem
      wechat-pay-public-key-absolute-path: D:\\felord\\wechat\\cert\\pub_key.pem
      #是否启用从平台证书切换成微信支付公钥 不填默认为false，
      switch-verify-sign-method: true

❗注意：在一套系统中需要开发者保证tentanID唯一。

支付宝

在Spring Boot项目中的application.yaml中配置ali.pay.v1相关参数。证书细节参见【日常踩坑】

ali:
  pay:
    v1:
# 可以替换为沙箱
      server-url: https://openapi.alipaydev.com/gateway.do
# 蚂蚁开放平台申请并认证的应用appId
      app-id: 2016223700762343
      app-private-key-path: META-INF/app_rsa
      alipay-public-cert-path: META-INF/alipayCertPublicKey_RSA2.crt
      alipay-root-cert-path: META-INF/alipayRootCert.crt
      app-cert-public-key-path: META-INF/appCertPublicKey_2016102700769563.crt
      charset: utf-8
      format: json
      sign-type: RSA2

❗注意：只有ali.pay.v1.app-id设置了有效值才能启用支付宝API。

启用配置

配置完毕后需要启用@EnableMobilePay注解来开启支付功能：

@EnableMobilePay
@Configuration
public class PayConfig {
}

使用API

微信支付

微信支付V3开放接口都是通过WechatApiProvider引入的，当启用配置步骤完成后会被初始化并注入了Spring IoC，可通过如下形式引入：

    @Autowired
    WechatApiProvider wechatApiProvider;

WechatApiProvider需要开发者明确租户IDtenantID以初始化具体场景的Api。例如查询终端用户在租户mobile下的优惠券：

     // 查询商户下的优惠券
     @Test
     public void v3MchStocks() {
        // 配置文件中对应的tenantID:
        String tenantId =“mobile”;
        StocksQueryParams params = new StocksQueryParams();
        params.setOffset(0);
        params.setLimit(10);
        WechatResponseEntity<ObjectNode> objectNodeWechatResponseEntity = wechatApiProvider.favorApi(tenantId).queryStocksByMch(params);
        System.out.println("objectNodeWechatResponseEntity = " + objectNodeWechatResponseEntity);
     }

支付宝

当启用配置步骤完成后会初始化支付宝支付客户端接口AlipayClient并注入Spring IoC，可通过以下形式引入：

    @Autowired
    AlipayClient alipayClient;

调用，以现金红包为例：

    @SneakyThrows
    public void campaignCash() {
        AlipayMarketingCampaignCashCreateRequest request = new AlipayMarketingCampaignCashCreateRequest();
        request.setBizContent("{" +
                "\"coupon_name\":\"XXX周年庆红包\"," +
                "\"prize_type\":\"random\"," +
                "\"total_money\":\"10000.00\"," +
                "\"total_num\":\"1000\"," +
                "\"prize_msg\":\"XXX送您大红包\"," +
                "\"start_time\":\"2020-11-02 22:48:30\"," +
                "\"end_time\":\"2020-12-01 22:48:30\"," +
                "\"merchant_link\":\"http://www.weibo.com\"," +
                "\"send_freqency\":\"D3|L10\"" +
                "  }");

        AlipayMarketingCampaignCashCreateResponse execute = alipayClient.certificateExecute(request);

        System.out.println("execute = " + execute.getBody());
    }