SpringCloud(七) - 微信支付

1、开发文档

微信开发文档：


安全规范：

1. 1、签名算法
2. （签名校验工具）
3. 签名生成的通用步骤如下：
5. 第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串stringA。
7. 特别注意以下重要规则：
9. ◆ 参数名ASCII码从小到大排序（字典序）；
10. ◆ 如果参数的值为空不参与签名；
11. ◆ 参数名区分大小写；
12. ◆ 验证调用返回或微信主动通知签名时，传送的sign参数不参与签名，将生成的签名与该sign值作校验。
13. ◆ 微信接口可能增加字段，验证签名时必须支持增加的扩展字段
14. 第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。 注意：密钥的长度为32个字节。

复制代码

2、配置信息 和 工具类

2.1 核心配置文件

application.yml

1. #端口
2. server:
3.   port: 8096
5. #微信支付自定义配置参数
6. wechat:
7.   pay:
8.     app-id: xxxx # 公众账号ID
9.     mch-id: xxxx # 商户号ID
10.     mch-key: xxxxx # 商户密钥
11.     order-uri: https://api.mch.weixin.qq.com/pay/unifiedorder # 请求微信支付接口统一下单地址
12.     notify-uri: http://xxxxx.natappfree.cc/wxpay/notifyresult # 微信支付结果回调地址
13.     view-order-status-uri: https://api.mch.weixin.qq.com/pay/orderquery  #  查询订单状态地址

复制代码

注意：其中的回调地址，需要内网穿透；
2.2 自定义配置类

1. /**
2. * Created On : 3/11/2022.
3. * <p>
4. * Author : huayu
5. * <p>
6. * Description: 自定义配置类
7. */
8. @Data
9. @Component
10. @ConfigurationProperties(prefix = "wechat.pay")
11. public class WechatPayConfig {
13.     /*
14.         公众账号ID
15.      */
16.     private String appId;
18.     /*
19.         商户号ID
20.      */
21.     private String mchId;
23.     /*
24.         商户密钥
25.      */
26.     private  String mchKey;
28.     /*
29.         请求微信支付接口统一下单地址
30.      */
31.     private String orderUri;
33.     /*
34.         微信支付结果回调地址
35.      */
36.     private String notifyUri;
38.     /*
39.         主动查询订单状态地址
40.      */
41.     private String viewOrderStatusUri;
43. }

复制代码

2.3 常量类

1. /**
2. * Created On : 3/11/2022.
3. * <p>
4. * Author : huayu
5. * <p>
6. * Description: 微信支付常量类
7. */
8. public class WechatPayConstant {
10.     //系统交易订单号的浅醉标识符
11.     public static final String WECHAT_PAY_TRADE_ORDER_PREFIX ="kh";
13.     //系统格式化日期字符串，到秒
14.     public static final String WECHAT_PAY_TIME_PATTERN_ALL = "yyyyMMddHHmmss";
16.     //系统格式化日期字符串，到天
17.     public static final String WECHAT_PAY_TIME_PATTERN_DAY = "yyyyMMdd";
19.     //微信支付的交易类型：naive
20.     public static final String WECHAT_PAY_TRADE_NATIVE = "NATIVE";
22.     //微信支付的签名方式MD5
23.     public static final String WECHAT_PAY_SIGN_TYPE_MD5= "MD5";
25.     //微信支付的签名参数名
26.     public static final String WECHAT_PAY_FIELD_SIGN = "sign";
28.     //微信支付下单请求的字符集编码
29.     public static final String WECHAT_PAY_ENCODING_UTF8="UTF-8";
31.     //微信支付下单结果的成功状态码
32.     public static final String WECHAT_PAY_RESULT_SUCCESS = "SUCCESS";
34.     //微信支付结果异步回调的同步响应，成功
35.     public static final String WECHAT_PAY_NOTIFY_SUCCESS="<xml><return_code><![CDATA[SUCCESS]]></return_code><return_msg><![CDATA[OK]]></return_msg></xml>";
37.     //微信支付结果异步回调的同步响应，失败
38.     public static final String WECHAT_PAY_NOTIFY_FALL="<xml><return_code><![CDATA[FALL]]></return_code><return_msg><![CDATA[NOOK]]></return_msg></xml>";
40.     //订单查询 结果成功的状态码
41.     public static final String WECHAT_PAY_VIEW_ORDER_STATUS_SUCCESS = "SUCCESS";
43. }

复制代码

2.4 工具类

WechatPayUtil 和 WechatPayXmlUtil ：
HttpClient4Util http请求工具类：
3、请求微信统一下单接口，下单支付订单，返回支付链接

• 获取参数，放进map集合中并按key值，字典排序。
  
• 通过参数生成签名(生成的签名也放进map集合)。
  
• 将map集合转成xml字符串。
  
• 获取微信支付统一下单地址，xml参数字符串作为参数发送请求。
  

3.0 参数列表


3.1 接口

1. /**
2. * Created On : 3/11/2022.
3. * <p>
4. * Author : huayu
5. * <p>
6. * Description: 微信支付业务接口
7. */
8. public interface WechatPayService {
9.        /**
10.      * @author : huayu
11.      * @date   : 3/11/2022
12.      * @param  : []
13.      * @return : java.lang.String
14.      * @description : 生成请求微信支付接口的统一下单接口参数 ，返回xml格式字符串
15.      */
16.     String generateWxUnifyOrderXmlParams(String productBody,int totalFee) throws Exception;
18.     /**
19.      * @author : huayu
20.      * @date   : 3/11/2022
21.      * @param  : [unifyOrderXmlParams]
22.      * @return : java.util.Map<java.lang.String,java.lang.String>
23.      * @description : 请求微信支付统一下单
24.      */
25.     Map<String,String> getWchatPayUnifyOrderResult(String unifyOrderXmlParams) throws Exception;
26.    
27.    
28. }

复制代码

3.2 实现类

1. /**
2. * Created On : 3/11/2022.
3. * <p>
4. * Author : huayu
5. * <p>
6. * Description: 微信支付业务接口实现类
7. */
8. @Service
9. @Slf4j
10. public class WechatPayServiceImpl implements WechatPayService {
12.     @Autowired
13.     private WechatPayConfig wechatPayConfig;
15.     @Override
16.     public String generateWxUnifyOrderXmlParams(String productBody,int totalFee) throws Exception {
17.         //微信支付接口签名参数要求
18.         //特别注意一下要求规则：参数名ASCII码从小到大排序(字典排序)；如果参数值为空不参与签名；参数区分大小写；
20.         //定义微信支付解析参数集合：TreeMap（自动横距集合中key按照字典排序）
21.         TreeMap<String, String> paramsMap = new TreeMap<>();
23.         //公众账号ID  appid 必传参数 微信支付分配的公众账号ID（企业号corpid即为此appid）
24.         paramsMap.put("appid",wechatPayConfig.getAppId());
26.         //商户号 mch_id  微信支付分配的商户号
27.         paramsMap.put("mch_id",wechatPayConfig.getMchId());
29.         paramsMap.put("device_info","WEB");
31.         //随机字符串 nonce_str  随机字符串，长度要求在32位以内。推荐随机数生成算法
32.         paramsMap.put("nonce_str",WechatPayUtil.generateNonceStr());
34.         //商品描述 body  商品简单描述，该字段请按照规范传递，具体请见参数规定
35.         paramsMap.put("body",productBody);
37.         //附件数据 attach
38.         paramsMap.put("attach","课工场KH96");
40.         //商户订单号 out_trade_no 商户系统内部订单号，要求32个字符内（最少6个字符），只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号
41.         paramsMap.put("out_trade_no",WechatPayUtil.generateTradeOrderNo());
43.         //标价金额 total_fee 订单总金额，单位为分，详见支付金额
44.         paramsMap.put("total_fee",String.valueOf(totalFee));
46.         //终端IP spbill_create_ip 支持IPV4和IPV6两种格式的IP地址。用户的客户端IP
47.         paramsMap.put("spbill_create_ip","121.225.201.22");
49.         //通知地址  notify_url  body 异步接收微信支付结果通知的回调地址，通知url必须为外网可访问的url，不能携带参数。 公网域名必须为https，如果是走专线接入，使用专线NAT IP或者私有回调域名可使用http
50.         paramsMap.put("notify_url",wechatPayConfig.getNotifyUri());
52.         //交易类型 trade_type  NATIVE -Native 支付 JSAPI -JSAPI支付  NATIVE -Native支付  APP -APP支付
53.         paramsMap.put("trade_type", WechatPayConstant.WECHAT_PAY_TRADE_NATIVE);
55.         paramsMap.put("product_id","互联网架构师");
57.         //签名，传送的sign参数不参与签名，会将生成的签名与该sign值作校验。如果不一致，签名失败
58.         //切记：签名都是再确定好接口参数后，指定签名操作，并将签名的结果加入参数集合
59.         paramsMap.put("sign",WechatPayUtil.generateSignature(paramsMap,wechatPayConfig.getMchKey()));
61.         return WechatPayUtil.generateMapToXml(paramsMap);
62.     }
64.     @Override
65.     public Map<String, String> getWchatPayUnifyOrderResult(String unifyOrderXmlParams) throws Exception {
67.         //发送post请求，请求微信支付统一下单接口，下预支付订单，并获取下单结果
68.         String unifyOrderXmlResult = HttpClient4Util.getResponse4PostByString(wechatPayConfig.getOrderUri()
69.                                                 , unifyOrderXmlParams
70.                                                 , WechatPayConstant.WECHAT_PAY_ENCODING_UTF8);
72.         return WechatPayUtil.generateXmlToMap(unifyOrderXmlResult);
73.     }
74.    
75.    
76. }

复制代码

3.3 请求方法

1. /**
2. * Created On : 3/11/2022.
3. * <p>
4. * Author : huayu
5. * <p>
6. * Description: 微信支付接口对接测试入口
7. */
8. @Slf4j
9. @RestController
10. public class WechatPagController {
12.     @Autowired
13.     private WechatPayService wechatPayService;
15.     /**
16.      * @author : huayu
17.      * @date   : 3/11/2022
18.      * @param  : []
19.      * @return : com.kgc.scd.uitl.RequestResult<java.util.Map<java.lang.String,java.lang.String>>
20.      * @description : 请求微信统一下单接口，下单支付订单，返回支付链接
21.      */
22.     @PostMapping("/wxpay/unifyOrder")
23.     public RequestResult<Map<String,String>> wechatPagUnifyOrder(@RequestParam String productBody,
24.                                                                 @RequestParam int totalFree) throws Exception {
26.         //调用业务接口，生成微信支付接口，统一下单的完整参数，xml格式(微信支付的接口要求，交互参数必须是xml)
27.         String unifyOrderXmlParams = wechatPayService.generateWxUnifyOrderXmlParams(productBody, totalFree);
29.         log.info("------ 1.请求微信支付统一下单参数：{} -------",unifyOrderXmlParams);
31.         //调用业务接口，请求微信支付统一下单接口，获取下单结果
32.         Map<String, String> unifyOrderMapResult = wechatPayService.getWchatPayUnifyOrderResult(unifyOrderXmlParams);
34.         log.info("------ 2.请求微信支付统一下订单接口返回：{} --------",unifyOrderMapResult);
36.         //定义当前接口返回的map集合
37.         Map<String, String> resultMap = new HashMap<>();
39.         if(WechatPayConstant.WECHAT_PAY_RESULT_SUCCESS.equals(unifyOrderMapResult.get("return_code"))
40.             && WechatPayConstant.WECHAT_PAY_RESULT_SUCCESS.equals(unifyOrderMapResult.get("result_code"))){
41.             // 微信支付统一下单成功，省略签名校验
43.             // 获取成功的结果
44.             // 交易类型
45.             resultMap.put("trade_type", unifyOrderMapResult.get("trade_type"));
47.             // 预支付交易会话标识
48.             resultMap.put("prepay_id", unifyOrderMapResult.get("prepay_id"));
50.             resultMap.put("code_url", unifyOrderMapResult.get("code_url"));
52.             // 返回统一下预支付单成功
53.             return ResultBuildUtil.success(resultMap);
55.         }
56.         // 统一下预支付单失败
57.         return ResultBuildUtil.fail(unifyOrderMapResult.get("return_code"), unifyOrderMapResult.get("return_msg"));
59.     }
60.    
61. }

复制代码

3.4 请求测试

3.4.1 发送请求




4、接收用户支付成功后，微信异步回调支付结果

• 支付后，微信官方，通过回调地址，返回用户信息通过数据流。
  
• 解析回调数据流。
  
• 解析异步回调的支付结果。
  
• 同步给微信官方响应结果。
  

4.1接口

1. /**
2. * @author : huayu
3. * @date   : 3/11/2022
4. * @param  : [wxpayNotifyXmlResult]
5. * @return : java.lang.String
6. * @description : 调用业务接口，解析异步回调的支付结果，并获取通知微信官方的结果
7. */
8. String getNotifyWechatXmlResult(String wxpayNotifyXmlResult) throws Exception;

复制代码

4.2 实现类

1. @Override
2. public String getNotifyWechatXmlResult(String wxpayNotifyXmlResult) throws Exception {
4.     //将微信支付结果通知的xml格式字符串，转换位map集合，方便处理
5.     Map<String, String> wxpayNotifyXmlForMapResult = WechatPayUtil.generateXmlToMap(wxpayNotifyXmlResult);
7.     //解析回调结果
8.     if(WechatPayConstant.WECHAT_PAY_RESULT_SUCCESS.equals(wxpayNotifyXmlForMapResult.get("return_code"))){
9.         //官方提醒：商户系统对于支付结果通知的内容一定要做签名验证,并校验返回的订单金额是否与商户侧的订单金额一致，防止数据泄露导致出现“假通知”，造成资金损失。
10.         if(WechatPayUtil.isSignatureValid(wxpayNotifyXmlForMapResult,wechatPayConfig.getMchKey())){
11.             // 签名校验成功，说明回调结果是可信的，就可以进行业务处理，如果签名失败，说明回调来源不可信，不能进行业务处理
12.             // TODO 真实业务中，收到正确回调，就要进行对应的业务处理，比如修改订单状态，发送主题消息，给定用户加积分，给物流生成物流单等等
13.             // 业务处理成功后，需要同步给微信响应结果-成功
15.             //成功
16.             return WechatPayConstant.WECHAT_PAY_NOTIFY_SUCCESS;
18.         }
20.     }
22.     // 同步给微信响应结果-失败
23.     return  WechatPayConstant.WECHAT_PAY_NOTIFY_FALL;
24. }

复制代码

4.3 请求方法

1. /**
2. * @author : huayu
3. * @date   : 3/11/2022
4. * @param  : [request, response]
5. * @return : void
6. * @description : 接收用户支付成功后，微信异步回调支付结果
7. */
8. @RequestMapping("/wxpay/notifyresult")
9. public void receiveWechatPayNotifyResult(HttpServletRequest request, HttpServletResponse response){
11.     //支付完成后，微信会把相关支付结果及用户信息通过数据流的形式发送给商户，商户需要接收处理，并按文档规范返回应答。
13.     try(InputStream inputStream = request.getInputStream()){
15.         //解析回调数据流
16.         BufferedReader brf = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8));
18.         //定义可变字符对象，保存返回的xml格式支付结果
19.         StringBuilder wxpayNotifyXmlResult = new StringBuilder();
21.         //逐行解析
22.         String readline = null;
23.         while ((readline = brf.readLine()) != null){
24.             wxpayNotifyXmlResult.append(readline);
25.         }
27.         log.info("------ 3.微信支付结果异步回调内容：{} ------",wxpayNotifyXmlResult);
29.         //调用业务接口，解析异步回调的支付结果，并获取通知微信官方的结果
30.         String respWechatXmlResult = wechatPayService.getNotifyWechatXmlResult(wxpayNotifyXmlResult.toString());
32.         //同步给微信官方响应结果
33.         PrintWriter out = response.getWriter();
34.         out.write(respWechatXmlResult);
35.         out.flush();
36.         out.close();
38.         log.info("------ 4、微信支付异步回调处理后，响应结果：{} ------",respWechatXmlResult);
40.     }catch (Exception e){
42.         log.info("------ 微信支付结果异步回调处理异常，异常信息：{} ------", e.getMessage());
44.     }
46. }

复制代码

4.4 请求测试(微信官方回调)


5、查看用户订单状态

• 获取参数，放进map集合中并按key值，字典排序。
  
• 通过参数生成签名(生成的签名也放进map集合)。
  
• 将map集合转成xml字符串。
  
• 获取订单状态查询地址，xml参数字符串作为参数发送请求。
  
• 返回订单状态信息。
  

5.0 参数列表


5.1 接口

1. /**
2. * @author : huayu
3. * @date   : 3/11/2022
4. * @param  : [orderNo]
5. * @return : java.lang.String
6. * @description : 通过订单好查询订单状态
7. */
8. Map<String, String> getOrderStatus(String orderNo) throws Exception;

复制代码

5.2 实现类

1. @Override
2. public Map<String, String> getOrderStatus(String orderNo) throws Exception {
4.     log.info("++++++  获取查询订单状态的参数 ++++++");
6.     //参数集合
7.     TreeMap<String, String> paramsMap = new TreeMap<>();
9.     //公众账号ID  appid
10.     paramsMap.put("appid",wechatPayConfig.getAppId());
12.     //商户号 mch_id
13.     paramsMap.put("mch_id",wechatPayConfig.getMchId());
15.     //商户订单号 out_trade_no
16.     paramsMap.put("out_trade_no",orderNo);
18.     //随机字符串 nonce_str
19.     paramsMap.put("nonce_str",WechatPayUtil.generateNonceStr());
21.     //签名        sign
22.     paramsMap.put("sign",WechatPayUtil.generateSignature(paramsMap,wechatPayConfig.getMchKey()));
24.     //将map集合的参数转换成xml格式的字符串
25.     String paramsMapToXml = WechatPayUtil.generateMapToXml(paramsMap);
27.     log.info("++++++  查询订单状态的参数：{} ++++++",paramsMapToXml);
29.     //发送post请求，获取订单状态 xml格式字符串
30.     String orderStatusXmlResult = HttpClient4Util.getResponse4PostByString(wechatPayConfig.getViewOrderStatusUri()
31.                                                                            , paramsMapToXml
32.                                                                            , WechatPayConstant.WECHAT_PAY_ENCODING_UTF8);
34.     log.info("++++++发送post请求，获取订单状态 xml格式字符串 orderStatusXmlResult:  ++++++\n{}",orderStatusXmlResult);
36.     //将xml格式结果字符串转化成 map 集合
37.     Map<String, String> orderStatusXmlResultToMap = WechatPayUtil.generateXmlToMap(orderStatusXmlResult);
39.     //判断返回结果
40.     //交易成功判断条件： return_code、result_code和trade_state都为SUCCESS
41.     if(WechatPayConstant.WECHAT_PAY_VIEW_ORDER_STATUS_SUCCESS.equals(orderStatusXmlResultToMap.get("return_code"))
42.        && WechatPayConstant.WECHAT_PAY_VIEW_ORDER_STATUS_SUCCESS.equals(orderStatusXmlResultToMap.get("result_code"))
43.        && WechatPayConstant.WECHAT_PAY_VIEW_ORDER_STATUS_SUCCESS.equals(orderStatusXmlResultToMap.get("trade_state"))
44.       ){
45.         
46.         //返回订单信息
47.         return orderStatusXmlResultToMap;
49.     }
51.     return null;
52. }

复制代码

5.3 请求方法

1. /**
2. * @author : huayu
3. * @date   : 3/11/2022
4. * @param  : [orderNo]
5. * @return : void
6. * @description : 查看用户订单状态
7. */
8. @RequestMapping("/wxpay/viewOrderStatus")
9. public RequestResult<String> viewOrderStatus(@RequestParam String orderNo) throws Exception {
11.     //调用业务层 查询订单状态
12.     String orderStatus = wechatPayService.getOrderStatus(orderNo);
14.                 if(orderStatusInfoMap != null){
15.             return ResultBuildUtil.success(orderStatusInfoMap);
16.         }
18.         return ResultBuildUtil.fail(null);
20. }

复制代码

5.4 请求测试

5.4.1 发起请求



5.4.2 请求结果