【SpringBoot】微信模板消息接口

微信官方文檔

申請(qǐng)測試號(hào)：http://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=sandbox/login
模板消息：http://mp.weixin.qq.com/debug/cgi-bin/readtmpl?t=tmplmsg/faq_tmpl

1.申請(qǐng)測試號(hào)，并記錄appID和appsecret

2.關(guān)注測試號(hào)

3.添加消息模板


{{topic.DATA}} 
用戶名： {{user.DATA}} 
單車編號(hào)：{{car.DATA}} 
鎖定時(shí)間：{{date.DATA}} 
{{remark.DATA}}

微信接口配置和代碼

1.添加微信配置文件

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "wechat")
public class WechatConf {
    // 獲取accessToken的接口
    public static final String GET_TOKEN_URL = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=%s&secret=%s";

    // 發(fā)送消息的接口
    public static final String PUSH_MESSAGE_URL = "https://api.weixin.qq.com/cgi-bin/message/template/send?access_token=%s";

    private String appId;

    private String appsecret;

    // 發(fā)送消息的接口的訪問憑證
    private String accessToken;

    public String getAppId() {
        return appId;
    }

    public void setAppId(String appId) {
        this.appId = appId;
    }

    public String getAppsecret() {
        return appsecret;
    }

    public void setAppsecret(String appsecret) {
        this.appsecret = appsecret;
    }

    public String getAccessToken() {
        return accessToken;
    }

    public void setAccessToken(String accessToken) {
        this.accessToken = accessToken;
    }

}

這里@ConfigurationProperties(prefix = "wechat")注解會(huì)報(bào)黃，需要導(dǎo)入依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

2.填寫配置文件application.yml

以下兩個(gè)值會(huì)被注入到WechatConf 中

wechat:
  app-id: wxc67a533f22dc2f9c
  appsecret: <your appsecret>

3.注入發(fā)送Http請(qǐng)求的對(duì)象

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class RestConf {
    @Bean
    public RestTemplate getRestTemplate() {
        return new RestTemplate();
    }
}

4.后臺(tái)調(diào)用微信接口憑證AccessToken的封裝類

import com.fasterxml.jackson.annotation.JsonProperty;

public class AccessToken {
    @JsonProperty("access_token")
    private String accessToken;
    
    @JsonProperty("expires_in")
    private Long expiresIn;

    public String getAccessToken() {
        return accessToken;
    }

    public void setAccessToken(String accessToken) {
        this.accessToken = accessToken;
    }

    public Long getExpiresIn() {
        return expiresIn;
    }

    public void setExpiresIn(Long expiresIn) {
        this.expiresIn = expiresIn;
    }
    
}

5.使用定時(shí)任務(wù)獲取后臺(tái)訪問微信接口的憑證AccessToken

注意：需在啟動(dòng)類上添加開啟定時(shí)任務(wù)的注解@EnableScheduling

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

import com.thy.common.AccessToken;
import com.thy.config.WechatConf;

@Component
public class MessageTask {
    @Autowired
    private RestTemplate restTemplate;
    @Autowired
    private WechatConf wechatConf;

    /**
     * initialDelay: 初始化2s后執(zhí)行第一次
     * fixedDelay:微信默認(rèn)Token過期時(shí)間為7200s,這里定時(shí)7100s執(zhí)行一次定時(shí)任務(wù)
     */
    @Scheduled(initialDelay = 2000, fixedDelay = 7100 * 1000)
    public void refreshToken() {
        // 請(qǐng)求方式: GET
        // URL：https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
        // 發(fā)起一個(gè)get請(qǐng)求，返回的數(shù)據(jù)json文本，使用json工具將json文本直接轉(zhuǎn)化為Class<?>
        AccessToken accessToken = restTemplate.getForObject(
                String.format(WechatConf.GET_TOKEN_URL, wechatConf.getAppId(), wechatConf.getAppsecret()),
                AccessToken.class);
        // 將獲取的accessToken注入wechatConf
        wechatConf.setAccessToken(accessToken.getAccessToken());
    }
}

6.發(fā)送消息接口的請(qǐng)求參數(shù)的封裝類

import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonProperty;

public class MessageTemplate {
    @JsonProperty("touser")
    private String toUser;

    @JsonProperty("template_id")
    private String templateId;

    private String url;
    
    private Map<String,String> miniprogram;

    private Map<String, Map<String, String>> data = new HashMap<>();

    public static Map<String, String> initData(String value, String color) {
        HashMap<String, String> data = new HashMap<String, String>();
        data.put("value", value);
        data.put("color", color);
        return data;
    }

    public String getToUser() {
        return toUser;
    }

    public void setToUser(String toUser) {
        this.toUser = toUser;
    }

    public String getTemplateId() {
        return templateId;
    }

    public void setTemplateId(String templateId) {
        this.templateId = templateId;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public Map<String, String> getMiniprogram() {
        return miniprogram;
    }

    public void setMiniprogram(Map<String, String> miniprogram) {
        this.miniprogram = miniprogram;
    }

    public Map<String, Map<String, String>> getData() {
        return data;
    }

    public void setData(Map<String, Map<String, String>> data) {
        this.data = data;
    }

}

7.發(fā)送消息接口的返回值的封裝類

public class Result {
    private Integer errcode;
    private String errmsg;
    private Long msgid;

    public Integer getErrcode() {
        return errcode;
    }

    public void setErrcode(Integer errcode) {
        this.errcode = errcode;
    }

    public String getErrmsg() {
        return errmsg;
    }

    public void setErrmsg(String errmsg) {
        this.errmsg = errmsg;
    }

    public Long getMsgid() {
        return msgid;
    }

    public void setMsgid(Long msgid) {
        this.msgid = msgid;
    }

}

8.消息發(fā)送接口

import java.text.SimpleDateFormat;
import java.util.Date;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import com.thy.common.MessageTemplate;
import com.thy.common.Result;
import com.thy.config.WechatConf;
import com.thy.pojo.UserCarInfo;

@RestController
public class MessageController {
    @Autowired
    private RestTemplate restTemplate;
    @Autowired
    private WechatConf wechatConf;

    @RequestMapping("/sendMessage")
    public Object sendMessage(@RequestBody UserCarInfo userCarInfo) {
        MessageTemplate messageTemplate = new MessageTemplate();
        // 設(shè)置模板id
        messageTemplate.setTemplateId("othsG1ZD5w9ywTGyV6XCECnY1Q1oAIY5e-NvF94fzAI");
        // 設(shè)置接收用戶openId
        messageTemplate.setToUser("oUbk_1bVlUGqhMzQHMC_jbkysMgY");
        //點(diǎn)擊詳情跳轉(zhuǎn)的地址
        messageTemplate.setUrl("http://www.baidu.com");
        
        //設(shè)置模板dada參數(shù)
        messageTemplate.getData().put("topic", MessageTemplate.initData("您的單車已經(jīng)鎖定成功，騎行請(qǐng)注意安全！\n", ""));
        messageTemplate.getData().put("user", MessageTemplate.initData(userCarInfo.getUserName(), "#0000EE"));
        messageTemplate.getData().put("car", MessageTemplate.initData(userCarInfo.getCarSn(), "#00CD00"));
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        messageTemplate.getData().put("date", MessageTemplate.initData(simpleDateFormat.format(new Date())+"\n", ""));
        messageTemplate.getData().put("remark", MessageTemplate.initData("點(diǎn)擊詳情可查看您的租車信息", ""));
        //調(diào)用微信接口，發(fā)送模板消息
        Result result = restTemplate.postForObject(String.format(WechatConf.PUSH_MESSAGE_URL, wechatConf.getAccessToken()),
                messageTemplate, Result.class);
        return result;
    }
}

測試

1.運(yùn)行項(xiàng)目，發(fā)送請(qǐng)求

2.接收到微信提醒消息

碼云地址

https://gitee.com/gnliscream/wechat-message-demo.git

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容