支付宝订阅消息推送

源码资源网

支付宝订阅消息推送
1、前言

• 在小程序中用到了支付宝模板消息推送，本来支付宝那边有订阅消息的引导文档的，但是不太适合代码的复用，就把封装成了工具类(可能别的地方已经有了)，能够直接复用，有需要的可以借鉴一番
  

2、支付宝官方文档

• https://opendocs.alipay.com/mini/introduce/message
• 支付宝API代码示例
  
  1. AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
     
  2. AlipayOpenAppMiniTemplatemessageSendRequest request = new AlipayOpenAppMiniTemplatemessageSendRequest();
     
  3. request.setBizContent("{" +
     
  4. ""to_user_id":"2088102122458832"," +
     
  5. ""form_id":"2017010100000000580012345678"," +
     
  6. ""user_template_id":"MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM="," +
     
  7. ""page":"page/component/index"," +
     
  8. ""data":"{\\"keyword1\\": {\\"value\\" : \\"12:00\\"},\\"keyword2\\": {\\"value\\" : \\"20180808\\"},\\"keyword3\\": {\\"value\\" : \\"支付宝\\"}}"" +
     
  9. "  }");
     
  10. AlipayOpenAppMiniTemplatemessageSendResponse response = alipayClient.execute(request);
      
  11. if(response.isSuccess()){
      
  12. System.out.println("调用成功");
      
  13. } else {
      
  14. System.out.println("调用失败");
      
  15. }

  复制代码
  
  
• 可以看出，除了支付宝相关配置，最主要的是bizContent的设置，所以这边也是围绕bizContent去做封装
  

3、工具类封装3.1、MessageData

• 主要用于封装消息体（关键字）
  
  1. import com.alibaba.fastjson.JSON;
     
  2. import com.alibaba.fastjson.JSONObject;
     
  3. import lombok.Data;
     
  4. import org.apache.commons.lang3.StringUtils;
     
  5. 
     
  6. /**
     
  7. * @author cxq
     
  8. * @version : MessageData.java, v 0.1 2020年03月24日 6:57 下午 cxq Exp $
     
  9. */
     
  10. @Data
      
  11. public class MessageData {
      
  12.     private Keyword keyword1;
      
  13.     private Keyword keyword2;
      
  14.     private Keyword keyword3;
      
  15.     private Keyword keyword4;
      
  16.     private Keyword keyword5;
      
  17.     private Keyword keyword6;
      
  18.     private Keyword keyword7;
      
  19.     private Keyword keyword8;
      
  20.     private Keyword keyword9;
      
  21.     private Keyword keyword10;
      
  22. 
      
  23.     public void setKeyword1Value(String value) {
      
  24.         if (StringUtils.isNotBlank(value)) {
      
  25.             this.keyword1 = new Keyword(value);
      
  26.         }
      
  27.     }
      
  28. 
      
  29.     public void setKeyword2Value(String value) {
      
  30.         if (StringUtils.isNotBlank(value)) {
      
  31.             this.keyword2 = new Keyword(value);
      
  32.         }
      
  33.     }
      
  34. 
      
  35.     public void setKeyword3Value(String value) {
      
  36.         if (StringUtils.isNotBlank(value)) {
      
  37.             this.keyword3 = new Keyword(value);
      
  38.         }
      
  39.     }
      
  40. 
      
  41.     public void setKeyword4Value(String value) {
      
  42.         if (StringUtils.isNotBlank(value)) {
      
  43.             this.keyword4 = new Keyword(value);
      
  44.         }
      
  45.     }
      
  46. 
      
  47.     public void setKeyword5Value(String value) {
      
  48.         if (StringUtils.isNotBlank(value)) {
      
  49.             this.keyword4 = new Keyword(value);
      
  50.         }
      
  51.     }
      
  52. 
      
  53.     public void setKeyword6Value(String value) {
      
  54.         if (StringUtils.isNotBlank(value)) {
      
  55.             this.keyword5 = new Keyword(value);
      
  56.         }
      
  57.     }
      
  58. 
      
  59.     public void setKeyword7Value(String value) {
      
  60.         if (StringUtils.isNotBlank(value)) {
      
  61.             this.keyword7 = new Keyword(value);
      
  62.         }
      
  63.     }
      
  64. 
      
  65.     public void setKeyword8Value(String value) {
      
  66.         if (StringUtils.isNotBlank(value)) {
      
  67.             this.keyword8 = new Keyword(value);
      
  68.         }
      
  69.     }
      
  70. 
      
  71.     public void setKeyword9Value(String value) {
      
  72.         if (StringUtils.isNotBlank(value)) {
      
  73.             this.keyword9 = new Keyword(value);
      
  74.         }
      
  75.     }
      
  76. 
      
  77.     public void setKeyword10Value(String value) {
      
  78.         if (StringUtils.isNotBlank(value)) {
      
  79.             this.keyword10 = new Keyword(value);
      
  80.         }
      
  81.     }
      
  82. 
      
  83.     // 格式为{keyword1:xxxx, keyword2:xxxx}
      
  84.     public MessageData(String jsonStr) {
      
  85.         JSONObject jsonObject = JSON.parseObject(jsonStr);
      
  86.         this.setKeyword1Value((String) jsonObject.get("keyword1"));
      
  87.         this.setKeyword2Value((String) jsonObject.get("keyword2"));
      
  88.         this.setKeyword3Value((String) jsonObject.get("keyword3"));
      
  89.         this.setKeyword4Value((String) jsonObject.get("keyword4"));
      
  90.         this.setKeyword5Value((String) jsonObject.get("keyword5"));
      
  91.         this.setKeyword6Value((String) jsonObject.get("keyword6"));
      
  92.         this.setKeyword7Value((String) jsonObject.get("keyword7"));
      
  93.         this.setKeyword8Value((String) jsonObject.get("keyword8"));
      
  94.         this.setKeyword9Value((String) jsonObject.get("keyword9"));
      
  95.         this.setKeyword10Value((String) jsonObject.get("keyword10"));
      
  96.     }
      
  97. 
      
  98.     public MessageData() {
      
  99.     }
      
  100. 
       
  101.     @Data
       
  102.     public static class Keyword {
       
  103.         public Keyword(String value) {
       
  104.             this.value = value;
       
  105.         }
       
  106. 
       
  107.         private String value;
       
  108.     }
       
  109. 
       
  110. }

  复制代码
  
  
  

3.2、获取订阅消息相关数据

• 小程序相关信息
  
  1. @Override
     
  2.     public AlipayOpenAppMiniTemplatemessageSendResponse appMiniTemplateMsgPush(String clubCode, String alipayUid,
     
  3.                                                                                String userTemplateId, String page, MessageData data) {
     
  4. 
     
  5.         AlipayConfig alipayConfig = this.getAlipayConfigByClub(clubCode);
     
  6.         MiniTemplateMessage miniTemplateMessage = new MiniTemplateMessage();
     
  7.         miniTemplateMessage.setTemplateId(userTemplateId);
     
  8.         miniTemplateMessage.setUid(alipayUid);
     
  9.         miniTemplateMessage.setPage(page);
     
  10.         miniTemplateMessage.setData(data);
      
  11. 
      
  12.         return alipayOpenApiClient.appMiniTemplateMsgPush(miniTemplateMessage, alipayConfig);
      
  13.     }

  复制代码
  
  
  

3.3、支付宝API工具类

• 可封装到支付宝工具类中
  
  1. /**
     
  2.      * 模板消息推送
     
  3.      *
     
  4.      * @param miniTemplateMessage 推送内容
     
  5.      * @param alipayInfo
     
  6.      * @return
     
  7.      */
     
  8.     public AlipayOpenAppMiniTemplatemessageSendResponse appMiniTemplateMsgPush(MiniTemplateMessage miniTemplateMessage,
     
  9.                                                                                AlipayConfig alipayInfo) {
     
  10.         AlipayOpenAppMiniTemplatemessageSendRequest request = new AlipayOpenAppMiniTemplatemessageSendRequest();
      
  11.         String bizContent = JSON.toJSONString(miniTemplateMessage);
      
  12.         request.setBizContent(bizContent);
      
  13.         return executeRequest(request, alipayInfo);
      
  14.     }
      
  15. 
      
  16. 
      
  17.     private <T extends AlipayResponse> T executeRequest(AlipayRequest request, AlipayConfig alipayInfo) throws AlipayOpenApiException {
      
  18.         return executeRequest(request, null, alipayInfo);
      
  19.     }
      
  20. 
      
  21.     private <T extends AlipayResponse> T executeRequest(AlipayRequest request,
      
  22.                                                         String accessToken, AlipayConfig alipayInfo) throws AlipayOpenApiException {
      
  23.         AlipayClient alipayClient = alipayClientFactory.getAlipayClient(alipayInfo);
      
  24. 
      
  25.         AlipayResponse response;
      
  26.         try {
      
  27.             response = null == accessToken ? alipayClient.execute(request) : alipayClient.execute(request, accessToken);
      
  28.             if (!response.isSuccess()) {
      
  29.                 throw new AlipayOpenApiException(response, String.format("请求接口(%s),执行失败(%s)",
      
  30.                         request.getApiMethodName(), response.getMsg()));
      
  31.             }
      
  32.             return (T) response;
      
  33.         } catch (AlipayApiException e) {
      
  34.             log.error(String.format("请求接口(%s)，出现错误!", request.getApiMethodName()), e);
      
  35.             throw new AlipayOpenApiException(null, String.format("请求接口(%s)，出现错误!", request.getApiMethodName()));
      
  36.         }
      
  37.     }

  复制代码
  
  
  

3.4、测试

1. @PostMapping("")
   
2.     public Boolean testMsgPush(@RequestBody Parameter parameter) {
   
3.         log.info("parameter is {}", parameter);
   
4.         // 推送内容：活动名称、中奖号、开奖时间
   
5.         MessageData data = new MessageData();
   
6.         data.setKeyword1Value(parameter.getKeyword1());
   
7.         data.setKeyword2Value(parameter.getKeyword2());
   
8.         data.setKeyword3Value(parameter.getKeyword3());
   
9.         data.setKeyword4Value(parameter.getKeyword4());
   
10. 
    
11.         AlipayOpenAppMiniTemplatemessageSendResponse response
    
12.                 = alipayService.appMiniTemplateMsgPush("manchester", parameter.getAlipayUid(),
    
13.                 "xxx", "xxx", data);
    
14.         log.info("response is {}", response.getSubMsg());
    
15. 
    
16.         return true;
    
17.     }
    
18. 
    
19. 
    
20. @Data
    
21. @ToString
    
22. class Parameter {
    
23.     private String keyword1;
    
24.     private String keyword2;
    
25.     private String keyword3;
    
26.     private String keyword4;
    
27.     private String alipayUid;
    
28. }

复制代码

3.5、消息截图

支付宝订阅消息推送

支付宝订阅消息推送