使用java发布订阅消息
之前接到了一个需求,要求我使用java发布订阅消息。那么首先,我要知道订阅消息是个什么,他能完成什么功能
一.什么是订阅消息
我直接去官网查看订阅消息的相关文档说明:
https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message.html
然后我注意到了一些东西
1.
- 订阅消息推送位置:服务通知
- 订阅消息下发条件:用户自主订阅
- 订阅消息卡片跳转能力:点击查看详情可跳转至该小程序的页面
订阅消息包括两种:
一次性订阅消息:
一次性订阅消息用于解决用户使用小程序后,后续服务环节的通知问题。用户自主订阅后,开发者可不限时间地下发一条对应的服务消息;每条消息可单独订阅或退订。
长期订阅消息:
一次性订阅消息可满足小程序的大部分服务场景需求,但线下公共服务领域存在一次性订阅无法满足的场景,如航班延误,需根据航班实时动态来多次发送消息提醒。为便于服务,我们提供了长期性订阅消息,用户订阅一次后,开发者可长期下发多条消息。
目前长期性订阅消息仅向政务民生、医疗、交通、金融、教育等线下公共服务开放,后期将逐步支持到其他线下公共服务业务。
这两个地方透露出一个很关键的信息。订阅消息需要用户许可才能发放,一次性订阅消息要用户许可一次,服务器才能发送一次,直接发送会被拒绝;而长期订阅消息是有行业限制的,申请门槛比较高。
2 接着我去到获取发送权限的接口文档寻找相关信息:
https://developers.weixin.qq.com/miniprogram/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.html
总是保持以上选择,不再询问简单点说,这个选项目的是为了让用户不需要多次点击允许申请这个按钮,简化用户操作,前端通过使用getSetting这个方法去判断是不是要弹出这个申请框,如果不需要,执行方法requestSubscriMessage方法,后端才能够去发送消息。也就是对于一次性订阅消息来说,执行一次requestSubscribeMessage方法,后端才能发送一条消息,如果想要做到使用订阅消息去由后端自发的通知用户,那是行不通的,只能去申请长期订阅消息,或者使用服务号的消息模板。
二.发放订阅消息的提前准备
1.获取appId和appSecret
登录微信公众平台
2.新建一个模板并获取一个模板id
3.获取发放用户的openId
查看微信文档,看下openId是如何获取的
https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html
也就是我要调用wx.login这个方法获取code,这个code只能用一次,然后调用auth.code2Session这个方法去获取openId,对于一个公众平台来说,openId是唯一的.
wx.login这个方法的调用我通过测试小程序去完成
去公众平台下载一个微信开发者工具,公众平台推荐的那三个都可以,然后用appId新建一个项目。用控制台打印出code信息
在res=>{}中写console.log(wx.code),直接编译就可以看到code了
然后就是使用SpringBoot的RestTemplate去给微信发请求调用它的auth.code2Session方法了。看官方文档可以看到请求地址
https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
这是一个get请求,要传appid,secret和code。grant_type写死就好
@GetMapping("/getOpenId")public String getOpenId() {RestTemplate restTemplate = new RestTemplate();Map<String,String> params = new HashMap<>();params.put("APPID","");params.put("APPSECRET","");params.put("JSCODE","");ResponseEntity<String> responseEntity = restTemplate.getForEntity("https://api.weixin.qq.com/sns/jscode2session?appid={APPID}&secret={APPSECRET}&js_code={JSCODE}&grant_type=authorization_code",String.class,params);String body = responseEntity.getBody();JSONObject jsonObject = JSON.parseObject(body);String openId = jsonObject.getString("openid");return openId;}
用postman或者swagger去调用这个方法都行
4.然后我们看看发送的接口需要什么东西
https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html
可以看到需要一个接口调用凭证access_token,这个东西是全局唯一的,所有接口调用都要这个凭证,过期时间为2小时,多次向微信获取access_token更改access_token的值,所以如果多人协作开发的话要确定使用同一个access_token。
下面是access_token的请求地址
https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
也是一个get请求,需要appid和secret,思路还是用RestTemplate获取其他工具类向微信发送请求
@GetMapping("/getAccessToken")public String getAccessToken() {RestTemplate restTemplate = new RestTemplate();Map<String,String> params = new HashMap<>();params.put("APPID","");params.put("APPSECRET","");ResponseEntity<String> responseEntity = restTemplate.getForEntity("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid={APPID}&secret={APPSECRET}",String.class,params);String body = responseEntity.getBody();JSONObject jsonObject = JSON.parseObject(body);String accessToken = jsonObject.getString("access_token");return accessToken;}
看一些微信官方文档的请求示例
{"touser": "OPENID","template_id": "TEMPLATE_ID","page": "index","miniprogram_state":"developer","lang":"zh_CN","data": {"number01": {"value": "339208499"},"date01": {"value": "2015年01月05日"},"site01": {"value": "TIT创意园"} ,"site02": {"value": "广州市新港中路397号"}}
}
miniprogram_state和lang是选填的,值得注意的是data,data包裹了2层,所以定义请求实体的时候,data应该要设置为Map<String,Map<String,String>>或者Map<String,Object>,Object是你自己封装的类型,里面至少要包含一个data属性,这里我为了省事就直接封装一个类型了
@Data
public class MyTemplate {private String touser;//用户openidprivate String template_id;//订阅消息模版id,这里不要写成templateId,微信无法识别的private String page = "";//点击跳转页面,小程序上线后才能跳转private Map<String, DataValue> data;//推送文字,根据模板设置,DataValue是我封装的实体类
}@Data
public class DataValue {private String value;//public TemplateData(String value) {this.value = value;}
}
这里我用了lombok,如果不用就自己写get和set方法,然后就可以直接写请求了,进去公众平台看看模板的值需要如何设置
(https://note.youdao.com/yws/res/10603/WEBRESOURCEd838eae3339b5bdfaccee7381bd07695)]
@GetMapping("/send")public String send(String openid) {RestTemplate restTemplate = new RestTemplate();String accessToken = "" //根据上面的方法自行获取,这里我填空字符串,不要直接cvString url = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send?access_token=" + accessTokenMyTemplate t = new MyTemplate();t.setTouser(openid);//根据上面我写的方法自行获取t.setTemplate_id("");//订阅消息模板idt.setPage(null);Map<String, TemplateData> m = new HashMap<>();m.put("thing2", new DataValue("测试1"));m.put("thing3", new DataValue("测试2"));t.setData(m);ResponseEntity<String> responseEntity =restTemplate.postForEntity(url, t, String.class);return responseEntity.getBody();}
- 然后就可以开始发送了
首先我们还是要用小程序开发工具调用requestSubscriMessage方法获取许可
点击按钮后就可以调用发送接口,就可以显示发送成功了
说明:前端的方法是我cv其他人的,直接用应该没问题。后端的方法我整理笔记的时候手动编辑过,去掉了一些工具类还有其他信息,直接cv可能运行会失败,建议仅作为思路交流。