Spring Boot 实现微信小程序订阅模板消息

谁借莪１个温暖的怀抱￠ 2022-09-02 11:55 447阅读 0赞

> **导语**  
>   有很多场景下，需要要对接微信小程序的开发，在使用的过程中，会出现各种各样的问题，本人总结了关于如何调用微信小程序模板订阅消息的相关实现总结如下

## [微信订阅消息官网][Link 1] ##

首先要求系统，在不同的场景下，发送不同的微信订阅消息。第一步需要实现的就是如何将订阅消息发送出去，通过官网上的描述，先编写了一个通用的请求方法。使用的最为传统的调用方法，当然也可以使用其他的方式进行优化对于Java 网络调用的优化。这里系统要求并不是太高，所以使用的最简单的方式来实现。

## 编写一个通用请求方法 ##

/** * http请求方法 * @param requestUrl * @param requestMethod * @param outputStr * @return */
        public static String httpsRequest(String requestUrl, String requestMethod, String outputStr) { 
            try { 
                URL url = new URL(requestUrl);
                HttpsURLConnection conn = (HttpsURLConnection) url.openConnection();
                conn.setDoOutput(true);
                conn.setDoInput(true);
                conn.setUseCaches(false);
                conn.setRequestMethod(requestMethod);
                conn.setRequestProperty("content-type", "application/x-www-form-urlencoded");
                if (outputStr != null) { 
                    OutputStream outputStream = conn.getOutputStream();
    
                    outputStream.write(outputStr.getBytes("UTF-8"));
                    outputStream.close();
                }
                InputStream inputStream = conn.getInputStream();
                InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "utf-8");
                BufferedReader bufferedReader = new BufferedReader(inputStreamReader);
                String str = null;
                StringBuffer buffer = new StringBuffer();
                while ((str = bufferedReader.readLine()) != null) { 
                    buffer.append(str);
                }
                bufferedReader.close();
                inputStreamReader.close();
                inputStream.close();
                conn.disconnect();
                return buffer.toString();
            } catch (ConnectException ce) { 
                System.out.println("连接超时：{}");
            } catch (Exception e) { 
                System.out.println("https请求异常：{}");
            }
            return null;
        }

## 获取Token ##

根据官网文档，调用接口之前首先要获取到access\_token的值，Token

public class Token
    { 
    
        private String accessToken;
        private int expiresIn;
        private long getTokenTime;
    
        public Token() { 
    
        }
    
        public Token(String accessToken, int expiresIn, long getTokenTime) { 
            this.accessToken = accessToken;
            this.expiresIn = expiresIn;
            this.getTokenTime = getTokenTime;
        }
    
        public long getGetTokenTime()
        { 
            return this.getTokenTime;
        }
    
        public void setGetTokenTime(long getTokenTime)
        { 
            this.getTokenTime = getTokenTime;
        }
    
        public String getAccessToken()
        { 
            return this.accessToken;
        }
    
        public void setAccessToken(String accessToken)
        { 
            this.accessToken = accessToken;
        }
    
        public int getExpiresIn()
        { 
            return this.expiresIn;
        }
    
        public void setExpiresIn(int expiresIn)
        { 
            this.expiresIn = expiresIn;
        }
    
    }

这里由于涉及到一个超时时间的问题，所以使用了一个简单的技巧将Token的操作进行了缓存，利用比较两个时间的方式来判断是否过期，需要重新请求Token，来减少Token调用的操作内容。

/** * 获取有效的token * @return */
        public static Token getToken() { 
            if (token != null) { 
                if (token.getGetTokenTime() + token.getExpiresIn() > new Date()
                        .getTime()) { 
                    return token;
                }
            }
            //记得补充上appid和appsecret
            String appid="appid";
            String secret="appsecret";
            String result = httpsRequest("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid="+appid+"&secret="+secret, "GET", null);
            //new JSONObject();
    
            JSONObject jsonObject = JSONObject.parseObject(result);
            if (jsonObject != null) { 
                try { 
                    token = new Token();
                    token.setGetTokenTime(new Date().getTime());
                    token.setAccessToken(jsonObject.getString("access_token"));
                    token.setExpiresIn(jsonObject.getInteger("expires_in"));
                } catch (JSONException e) { 
                    token = null;
                    log.error("获取token失败 errcode:{} errmsg:{}", Integer.valueOf(jsonObject.getInteger("errcode")), jsonObject.getString("errmsg"));
                }
            }
            return token;
        }

## 发送模板消息 ##

获取到Token就要开始发发送模板消息了

定义消息体

public class TemplateParam
    { 
    
        private String key;
        private String value;
    
        public TemplateParam(String key, String value){ 
            this.key=key;
            this.value=value;
        }
        public String getValue() { 
            return value;
        }
        public void setValue(String value) { 
            this.value = value;
        }
        public String getKey() { 
            return key;
        }
        public void setKey(String key) { 
            this.key = key;
        }
    }

public class Template
    { 
    
        private String touser;
        private String template_id;
        private String page;
        private List<TemplateParam> templateParamList;
    
    
        public String getTouser() { 
            return touser;
        }
    
        public void setTouser(String touser) { 
            this.touser = touser;
        }
    
        public String getTemplate_id() { 
            return template_id;
        }
    
        public void setTemplate_id(String template_id) { 
            this.template_id = template_id;
        }
    
        public String getPage() { 
            return page;
        }
    
        public void setPage(String page) { 
            this.page = page;
        }
    
    
    
        public String toJSON() { 
            StringBuffer buffer = new StringBuffer();
            buffer.append("{");
            buffer.append(String.format("\"touser\":\"%s\"", this.touser)).append(",");
            buffer.append(String.format("\"template_id\":\"%s\"", this.template_id)).append(",");
            buffer.append(String.format("\"page\":\"%s\"", this.page)).append(",");
            buffer.append("\"data\":{");
            TemplateParam param = null;
            for (int i = 0; i < this.templateParamList.size(); i++) { 
                param = templateParamList.get(i);
                // 判断是否追加逗号
                if (i < this.templateParamList.size() - 1){ 
                    buffer.append(String.format("\"%s\": {\"value\":\"%s\"},", param.getKey(), param.getValue()));
                }else{ 
                    buffer.append(String.format("\"%s\": {\"value\":\"%s\"}", param.getKey(), param.getValue()));
                }
            }
            buffer.append("}");
            buffer.append("}");
            return buffer.toString();
        }
    
        public List<TemplateParam> getTemplateParamList() { 
            return templateParamList;
        }
    
        public void setTemplateParamList(List<TemplateParam> templateParamList) { 
            this.templateParamList = templateParamList;
        }
    }

/** * 发送模板消息 * * @param template * @return */
        public static boolean sendTemplateMsg(Template template) { 
    
            boolean flag = false;
            String requestUrl = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send?access_token=ACCESS_TOKEN";
            requestUrl = requestUrl.replace("ACCESS_TOKEN", getToken().getAccessToken());
            System.out.println(template.toJSON());
            String Result = httpsRequest(requestUrl, "POST", template.toJSON());
            System.out.println(Result);
    
            JSONObject jsonResult =  JSONObject.parseObject(Result);
    
    
            if (jsonResult != null) { 
                int errorCode = jsonResult.getInteger("errcode");
                String errorMessage = jsonResult.getString("errmsg");
                if (errorCode == 0) { 
                    flag = true;
                } else { 
                    System.out.println("模板消息发送失败:" + errorCode + "," + errorMessage);
                }
            }
            return flag;
        }

## 封装内容 ##

public void signTemplate(SendTemplateMessageEvent sendTemplateMessageEvent) { 
            SignSuccessMeg source = (SignSuccessMeg) sendTemplateMessageEvent.getSource();
            List<TemplateParam> paras=new ArrayList<>();
            paras.add(new TemplateParam("thing1",source.getTitle()));
            paras.add(new TemplateParam("thing3", source.getContent()));
            paras.add(new TemplateParam("thing4", source.getUnit()));
            paras.add(new TemplateParam("time5",DateUtils.dateTimeNow("yyyy-MM-dd HH:mm:ss")));
            paras.add(new TemplateParam("thing6",source.getRemark()));
            WxgzhUtil.sendMessageUtils("ouIH35CLsIBqwsZMqxx30Tzu35AI","88IGBsWFJ5CJhNePmVb8H2ljXYeO5YA6cM2znFALXdY",paras);
        }

## 测试 ##

// 测试
        public static void sendMessageUtils(String openid,String temp_id,List<TemplateParam> paras) { 
            Template template=new Template();
            //这里填写模板ID
            template.setTemplate_id(temp_id);
            //这里填写用户的openid
            template.setTouser(openid);
            //这里填写点击订阅消息后跳转小程序的界面
            template.setPage("/pages/index/index");
    
            template.setTemplateParamList(paras);
            sendTemplateMsg(template);
        }

[Link 1]: https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html