原模板消息接口,微信已经废弃。改为统一服务消息接口,需要用户手动订阅,后端才能发送。
需要注意的是,这个接口的能力是公众号(仅认证服务号)的能力,(原)模板消息需要在公众号配置。
小程序端订阅时,需要输入模板id,请先自行在公众号管理后台进行配置。
开始
我们这边来使用微信开发者联盟的包github地址来进行开发,他们里面都封装好了调用(重试啊,报错啊什么的,都处理过了,不需要咱担心),用起来比较方便。
maven引入
<dependency>
<groupId>com.github.binarywang</groupId>
<artifactId>weixin-java-mp</artifactId>
<version>4.0.0</version>
</dependency>
注意哦,引用公众号(包括订阅号和服务号):weixin-java-mp这个模块
公众号对外部服务器有验证步骤的,所以我们需要新增一个restController去处理微信的验证
这个类WxPortalController在Demo包里有,这边就不贴了。
真正的调用步骤也就这一步,发送模板消息Wiki文档
//封装的request对象类,发送给微信方的格式就是这样
WxMpTemplateMessage templateMessage = WxMpTemplateMessage.builder()
.toUser(...)
.templateId(...)
.url(...)
.build();
//输入模板消息每行的参数,内容,以及样式
templateMessage.addData(new WxMpTemplateData(name1, value1, color2));
templateMessage.addData(new WxMpTemplateData(name2, value2, color2));
//调用发送,获取模板消息模块,发送模板消息
wxMpService.getTemplateMsgService().sendTemplateMsg(templateMessage);
但是我们需要对wxMpService进行配置,这就是一个封装的接口类,里面就是对微信文档里各种接口的调用。里面先分了模块,然后再分具体调用的方法。
贴一下配置类
依托springboot
微信公众号属性
@Data
@ConfigurationProperties(prefix = "wx.mp")
public class WxMpProperties {
/**
* 设置微信公众号的appid
*/
private String appId;
/**
* 设置微信公众号的app secret
*/
private String secret;
/**
* 设置微信公众号的token
*/
private String token;
/**
* 设置微信公众号的EncodingAESKey
*/
private String aesKey;
}
yml文件里加上配置,格式自己调一下空格位置
wx:
mp:
appId: #公众号appid
secret: #微信公众号的app secret
token: #微信公众号的token
aesKey: #微信公众号的EncodingAESKey
configure引入
import com.google.common.collect.Maps;
import me.chanjar.weixin.mp.api.WxMpMessageRouter;
import me.chanjar.weixin.mp.api.WxMpService;
import me.chanjar.weixin.mp.api.impl.WxMpServiceImpl;
import me.chanjar.weixin.mp.config.impl.WxMpDefaultConfigImpl;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import java.util.HashMap;
import java.util.Map;
//注入配置
@Configuration
//这个跟上面的@ConfigurationProperties是配套使用的,意思是注入一下这个类
@EnableConfigurationProperties(WxMpProperties.class)
public class WxMpConfig {
//这个可以不要,这个是用来接收微信发送给服务器的回调消息的
private static Map<String, WxMpMessageRouter> routers = Maps.newHashMap();
//类所属属性,每个实例都通用的
private static HashMap<String,WxMpService> mpServices=Maps.newHashMap();
public static void init(WxMpProperties properties){
WxMpDefaultConfigImpl configStorage = new WxMpDefaultConfigImpl();
configStorage.setAppId(properties.getAppId());
configStorage.setSecret(properties.getSecret());
configStorage.setToken(properties.getToken());
configStorage.setAesKey(properties.getAesKey());
WxMpService service = new WxMpServiceImpl();
service.setWxMpConfigStorage(configStorage);
routers.put(properties.getAppId(), newRouter(service));
mpServices.put(properties.getAppId(),service);
}
public static Map<String, WxMpMessageRouter> getRouters() {
return routers;
}
public static HashMap<String,WxMpService> getMpServices() {
return mpServices;
}
private static WxMpMessageRouter newRouter(WxMpService wxMpService) {
final WxMpMessageRouter newRouter = new WxMpMessageRouter(wxMpService);
return newRouter;
}
}
我们需要调用WxMpConfig.init方法
使用springboot的类周期来进行调用,对mpServices进行注入
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
/**
* 初始化配置
* @author Kevin
* @date 2019-01-16 14:39
*/
@Component
public class WxConfig implements InitializingBean {
private final static Logger logger = LoggerFactory.getLogger(WxConfig.class);
@Autowired
private WxMpProperties wxMpProperties;
@Override
public void afterPropertiesSet() throws Exception {
initWxConfig();
}
/**
* 初始化公众号配置
* @param
* @return void
* @author lotus
* @date 2021-03-3 15:01:00
*/
public void initWxConfig(){
//只有一个公众号配置对应
WxMpConfig.init( wxMpProperties );
logger.info( "========================================");
logger.info( "加载公众号配置成功");
logger.info( "========================================");
}
}
至此,我们就可以使用模板消息发送
@Slf4j
public class WxTemplate {
// 模板消息字体颜色
private static final String TEMPLATE_FRONT_COLOR = "#32CD32";
public void sendTemplate(String appId,String openId,String templateId,String url) {
WxMpTemplateMessage resultTemplate = WxMpTemplateMessage.builder().build();
//设置接受者的openId
resultTemplate.setToUser(openId);
//设置模板id
resultTemplate.setTemplateId(templateId);
//模板消息跳转页面
resultTemplate.setUrl(url);
//设置模板消息样式以及内容
// WxMpTemplateData firstData = new WxMpTemplateData("first", "订单状态更新", TEMPLATE_FRONT_COLOR);
// WxMpTemplateData orderMoneySumData = new WxMpTemplateData("OrderSn", request.getParameter("OrderSn"), TEMPLATE_FRONT_COLOR);
// WxMpTemplateData orderProductNameData = new WxMpTemplateData("OrderStatus", request.getParameter("OrderStatus"), TEMPLATE_FRONT_COLOR);
// WxMpTemplateData remarkData = new WxMpTemplateData("remark", request.getParameter("remark"), TEMPLATE_FRONT_COLOR);
// orderPaySuccessTemplate.addData(firstData)
// .addData(orderMoneySumData)
// .addData(orderProductNameData)
// .addData(remarkData);
try {
WxMpService wxMpService= WxMpConfig.getMpServices().get(appId);
wxMpService.getTemplateMsgService()
.sendTemplateMsg(resultTemplate);
} catch (WxErrorException e) {
log.info(e.getMessage());
}
}
}