【Java项目】SpringBoot项目完成微信公众号收到用户消息自动回复功能附带视频(超详细)

叁歲伎倆 2024-03-24 14:17 14阅读 0赞

#### 文章目录 ####

*  视频讲解
 *  基础注册
 *  Java部分代码
 *  测试
 *  解析XML并取得需要的数据
 *  实现消息自动回复
 *  实测

## 视频讲解 ##

[视频讲解][Link 1]

## 基础注册 ##

首先你需要先注册一个你的微信公众号  
[微信公众号平台][Link 2]  
然后打开下面的自动回复功能  
![在这里插入图片描述][c82849b578fc4a859a962a1f89219ee2.png]  
![在这里插入图片描述][58040f945d0b4976b3313f0e828c49b8.png]  
之后进入到你的开发者中心  
[开发者中心基本配置][Link 3]  
![在这里插入图片描述][49ecc7b6ec604b4f9870ac1b2ee51134.png]  
然后生成你的开发者密码，开发者id，以及设置你的IP白名单。  
这里的IP白名单中的IP必须是一个公网IP，因为微信官方会把他们的请求发送到公网上，然后你接受到请求之后需要给这个请求做一个响应才能实现消息互通的功能。  
![在这里插入图片描述][717cd3ff95e2468797ea8ca241aeb80c.png]  
之后开始配置你的服务器信息  
![在这里插入图片描述][497d989b135a444fb0ee17ba2e1fa1b4.png]  
首先是URL，这里的URL需要填写的是  
http://ip:80/path（这里的path满足请求路径的格式即可）  
或者是  
https://ip:443/path  
![在这里插入图片描述][f71c9835c3044ceaad71c7313149df17.png]  
之后你的SpringBoot项目中就需要用到这些配置了

## Java部分代码 ##

我们首先对pom文件进行配置，因为微信的数据格式为xml，  
所以我们需要引入能解析xml和转换xml的依赖，如下  
这里我的springboot版本为2.7.7，但是这个影响应该不大，如果出现一些问题可以尝试换一下依赖版本

<dependency>
                <groupId>org.dom4j</groupId>
                <artifactId>dom4j</artifactId>
                <version>2.0.0</version>
            </dependency>
            
            <dependency>
                <groupId>com.thoughtworks.xstream</groupId>
                <artifactId>xstream</artifactId>
                <version>1.4.19</version>
            </dependency>
            <dependency>
                <groupId>com.github.liyiorg</groupId>
                <artifactId>weixin-popular</artifactId>
                <version>2.8.30</version>
            </dependency>
            <dependency>
                <groupId>com.github.binarywang</groupId>
                <artifactId>weixin-java-mp</artifactId>
                <version>3.7.0</version>
            </dependency>

之后在项目中配置你的这些微信官方给你的信息即可  
![在这里插入图片描述][1273a3f4e65149bda8560629bc86eb23.png]  
然后我刚才说过，微信会向公网上你刚才输入的地址发送请求，是一个get请求，并且会携带上一些参数，我们要做的就是解析这些参数，代码如下  
下面是Controller层的代码

import lombok.extern.java.Log;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.web.bind.annotation.*;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    @Log
    @RestController
    @RequestMapping("/wx")
    public class TokenCheckController {
        
        @Value("${wechat.mp.token}")
        private String token;
    	@GetMapping("/")
        public String index(HttpServletResponse response, HttpServletRequest request) throws Exception {
        
            String echostr = TokenCheckUtil.checkToken(request, token);
            return echostr;
        }
    }
       @PostMapping("/")
        public String chatGPTproxy(
                HttpServletResponse response,
                HttpServletRequest request,
                @RequestBody String requestBody, @RequestParam("signature") String signature,
                @RequestParam("timestamp") String timestamp, @RequestParam("nonce") String nonce,
                @RequestParam(name = "encrypt_type", required = false) String encType,
                @RequestParam(name = "msg_signature", required = false) String msgSignature) {
        
    
            System.out.println("requestbody:----"+requestBody);
            return requestBody;
    }

下面是TokenCheckUtil工具包的代码

import javax.servlet.http.HttpServletRequest;
    import java.security.NoSuchAlgorithmException;
    import java.util.Arrays;
    
    import static cn.hutool.crypto.SecureUtil.sha1;
    
    /**
     * @author: 张锦标
     * @date: 2023/4/2 15:10
     * TokenCheckUtil类
     */
    public class TokenCheckUtil {
        
        public static String checkToken(HttpServletRequest request, String token) throws NoSuchAlgorithmException {
        
            String method = request.getMethod();
            //微信token验证get请求
            if ("GET".equals(method)) {
        
                //微信加密签名
                String echostr = request.getParameter("echostr");//时阅鲛
                String signature = request.getParameter("signature");//随机宁符串
                String timestamp = request.getParameter("timestamp");//随机数
                String nonce = request.getParameter("nonce");
                String[] str = {
        token, timestamp, nonce};
                //字典排序
                Arrays.sort(str);
                String bigStr = str[0] + str[1] + str[2];// SHA1加密
                String digest = sha1(bigStr);//对比签名
                if (digest.equals(signature)) {
        
                    return echostr;
                } else {
        
                    return "";
                }
            }
            return "";
        }
    }

上面两个完成之后，只要你点击测试，微信就会向这个接口发送一个Get请求，并且其请求参数如上代码，需要对这些参数进行校验对比之后返回一个echostr，代码只需要直接按照上面的照抄即可。  
然后继续看controller层的代码，有一个post请求，微信官方会将接收到的用户消息发送到这个post请求上，你只需要把get请求改为post，路径不变即可。  
其请求数据在请求体中，因此需要使用的是@RequestBody注解

## 测试 ##

这里我们先简单的做一个测试，把项目使用maven进行打包，然后部署到你的云服务器上面去  
[微信公众号测试号管理][Link 4]  
这里由于只是先做了一个测试，所以使用的是测试号管理，这里就不需要端口一定设定为80了，但是等真的变成上线了，那么就需要使用80端口，不过，你可以进行一下代理，比如使用nginx  
![在这里插入图片描述][d87f2d7a367443d29d412533a6c3d51c.png]  
之后你就可以点击提交，然后如果说按照上面的步骤的话，是没有问题的，就会出现如下情况  
![在这里插入图片描述][4c6a1ad4ba8047d282aa66a2445f958b.png]  
上面的URL配置成功之后，就可以让你的朋友去扫你的测试号二维码然后让他们关注后给你发消息了。  
![在这里插入图片描述][a1803472fab64c2796d0c36a0d83c469.png]  
当他们给你发消息之后，你会接收到如下的消息，其格式为XML  
首先你会收到一个订阅公众号的消息，可以看到有一个Event标签，然后当用户给你发送消息的时候，你还会收到一个Content标签，其中的内容就是用户给你发送的内容  
![在这里插入图片描述][05112f5f5c5146a89edbbac3a9bf2a57.png]  
那么此时你需要做的就是去解析XML并且获得你需要的数据

## 解析XML并取得需要的数据 ##

Java实体类，用于接受请求并且封装

import lombok.Data;
    
    
    /**
     * @author: 张锦标
     * @date: 2023/4/2 15:03
     * ReceiveMessage类
     */
    @Data
    public class ReceiveMessage {
        
        /**
         * 开发者微信号
         */
        private String ToUserName;
        /**
         * 发送方账号(一个openid）
         */
        private String FromUserName;
        /**
         * 消息创建时间（整形）
         */
        private String CreateTime;
        /**
         * 消息类型
         */
        private String MsgType;
        /**
         * 文本消息内容
         */
        private String Content;
        /**
         * 消息ID 64位
         */
        String MsgId;
        /**
         * 消息的数据ID 消息来自文章才有
         */
        private String MsgDataId;
        /**
         * 多图文时第几篇文章，从1开始 消息如果来自文章才有
         */
        private String Idx;
        /**
         * 订阅事件 subscribe订阅 unsbscribe取消订阅
         */
        private String Event;
    }

XML工具包

import com.towelove.file.domain.wechat.ReceiveMessage;
    import com.towelove.file.domain.wechat.ReplyMessage;
    import org.dom4j.Document;
    import org.dom4j.DocumentHelper;
    import org.dom4j.Element;
    
    import javax.servlet.http.HttpServletRequest;
    import java.io.BufferedReader;
    import java.io.InputStream;
    import java.io.InputStreamReader;
    import java.io.StringWriter;
    import java.io.StringWriter;
    import org.dom4j.Document;
    import org.dom4j.DocumentHelper;
    import org.dom4j.Element;
    import org.dom4j.io.XMLWriter;
    /**
     * @author: 张锦标
     * @date: 2023/4/2 15:13
     * XMLUtil类
     */
    public class XMLUtil {
        
        public static void main(String[] args) {
        
            String str = "" +
                    "<xml><ToUserName><![CDATA[gh_71a0837d69a6]]></ToUserName>\n" +
                    "<FromUserName><![CDATA[oy__X6O4BjH9QyyOcQaj55-O5Awo]]></FromUserName>\n" +
                    "<CreateTime>1680533388</CreateTime>\n" +
                    "<MsgType><![CDATA[text]]></MsgType>\n" +
                    "<Content><![CDATA[123]]></Content>\n" +
                    "<MsgId>24059451823534879</MsgId>\n" +
                    "</xml>";
            System.out.println(XMLUtil.XMLTOModel(str));
        }
        public  static ReceiveMessage XMLTOModel(String str) {
        
            ReceiveMessage receiveMessage = new ReceiveMessage();
            try {
        
                Document document = DocumentHelper.parseText(String.valueOf(str));
                Element root = document.getRootElement();
                receiveMessage.setToUserName(root.elementText("ToUserName"));
                receiveMessage.setFromUserName(root.elementText("FromUserName"));
                receiveMessage.setMsgType(root.elementText("MsgType"));
                receiveMessage.setContent(root.elementText("Content"));
                receiveMessage.setCreateTime(root.elementText("CreateTime"));
                receiveMessage.setMsgId(root.elementText("MsgId"));
                //receiveMessage.setMsgDataId(root.elementText("MsgDataId"));
                //receiveMessage.setIdx(root.elementText("Idx"));
                关注
                //receiveMessage.setEvent(root.elementText("Event"));
            } catch (Exception e) {
        
                System.out.println(e);
            }
            return receiveMessage;
        }
    
        public static String ObjToXml(ReplyMessage obj) throws Exception {
        
            Document document = DocumentHelper.createDocument();
            Element root = document.addElement(obj.getClass().getSimpleName());
            convertObjectToXml(obj, root);
            StringWriter stringWriter = new StringWriter();
            XMLWriter writer = new XMLWriter(stringWriter);
            writer.write(document);
            writer.close();
            return stringWriter.toString();
        }
        private static void convertObjectToXml(Object obj, Element element) throws Exception {
        
            Class<?> clazz = obj.getClass();
            for (java.lang.reflect.Field field : clazz.getDeclaredFields()) {
        
                field.setAccessible(true);
                Element child = element.addElement(field.getName());
                Object value = field.get(obj);
                if (value != null) {
        
                    if (value.getClass().isPrimitive() || value.getClass() == java.lang.String.class) {
        
                        child.setText(value.toString());
                    } else {
        
                        convertObjectToXml(value, child);
                    }
                }
            }
        }
    }

然后我们使用测试方法来测试一下这段解析代码是否有效  
![在这里插入图片描述][a822e472ae5f4abe8de251163b69816b.png]  
![在这里插入图片描述][815dd68a508e427bb63968e7de83e0a0.png]

## 实现消息自动回复 ##

那么按照上面的逻辑，我们就已经大概知道微信给我们发送的到底是什么样子的数据了，那么我们只要按照微信官方定义的，在post方法里面把请求返回回去即可，我们先来看一下官方文档  
[官方文档][Link 5]  
![在这里插入图片描述][93d97013983940ac89f6a5e31ea05c4a.png]  
这里需要主要，此时的ToUserName和FromUserName就得改变了。  
因为上面的xml中，ToUserName就是我们自己，FromUserName就是用户，而此时我们要做的是给用户返回数据，所以此时ToUserName是用户，FromUserName是我们自己。  
所以先修改一下代码  
![在这里插入图片描述][ec6dad8adb52426aa3ddacdeba20b723.png]  
然后我们来使用一个main函数来做一下测试

public static void main(String[] args) {
        
            try {
        
                // 创建document对象
                Document document = DocumentHelper.createDocument();
                // 创建根节点bookRoot
                Element xml = document.addElement("xml");
                // 向根节点中添加第一个节点
                Element toUserName = xml.addElement("ToUserName");
                // 向子节点中添加属性
                toUserName.addCDATA("oy__X6JbTiLxEVG85ABtAawsc_qw");
                Element fromUserName = xml.addElement("FromUserName");
                fromUserName.addCDATA("gh_71a0837d69a6");
                Element createTime = xml.addElement("CreateTime");
                createTime.addCDATA(String.valueOf(System.currentTimeMillis()));
                Element msgType = xml.addElement("MsgType");
                msgType.addCDATA("text");
                Element content = xml.addElement("Content");
                content.addCDATA("hello呀，我是张锦标");
    
    
                System.out.println(document.getRootElement().asXML());
    
                // 设置生成xml的格式
                OutputFormat of = OutputFormat.createPrettyPrint();
                // 设置编码格式
                of.setEncoding("UTF-8");
                // 生成xml文件
                File file = new File("D:\\desktop\\student.xml");
                if (file.exists()){
        
                    file.delete();
                }
                //创建一个xml文档编辑器
                XMLWriter writer = new XMLWriter(new FileOutputStream(file), of);
                //把刚刚创建的document放到文档编辑器中
                writer.write(document);
                writer.close();
            } catch (Exception e) {
        
                e.printStackTrace();
            }
        }

最终的格式如下  
![在这里插入图片描述][e4035ee868dd4a8daed81ec79ce95a8d.png]  
既然可以了，那么我们开始修改post里面的代码  
所以post请求体中的代码修改如下

@PostMapping("/")
        public String chatGPTproxy(
                HttpServletResponse response,
                HttpServletRequest request,
                @RequestBody String requestBody, @RequestParam("signature") String signature,
                @RequestParam("timestamp") String timestamp, @RequestParam("nonce") String nonce,
                @RequestParam(name = "encrypt_type", required = false) String encType,
                @RequestParam(name = "msg_signature", required = false) String msgSignature) {
        
    
            System.out.println("requestbody:----"+requestBody);
            ReceiveMessage receiveMessage = XMLUtil.XMLTOModel(requestBody);
            return parseMsgToXML(receiveMessage);
        }

最终结果如下  
![在这里插入图片描述][22728510f66540beb52451d3dc1d1dea.png]  
![在这里插入图片描述][9d307b3e19e84523a3ad5f9f94f5984b.jpeg]  
对了，特别注意，如果你的消息回复的时间会超过5s，那么这次的自动回复会失败，所以如果说你的消息查询特别久，那么就需要用客服回复，之后我会继续完成这个功能的。

## 实测 ##

上面的测试功能已经成功了，那么我们把项目的端口换为80，然后在试一下  
记住项目要放到云服务器上哦  
![在这里插入图片描述][278818a5a27d41748995a26f49f15787.png]  
![在这里插入图片描述][b18f5aefb7404a939953ed7c02977d2d.png]

![在这里插入图片描述][656c94690faa4c50ae026054638d49f5.png]  
![在这里插入图片描述][edc5578116b64fba9cf86cef8137223e.png]  
![在这里插入图片描述][b20e855999e341d1b6c5278d0edf52e2.png]  
![在这里插入图片描述][54f1aa72d0e14c36959a0972b17ce638.jpeg]

[Link 1]: https://www.bilibili.com/video/BV1Bm4y1q7Uw/
[Link 2]: https://mp.weixin.qq.com/advanced/autoreply?action=autoreply&t=ivr/reply&token=2070316348&lang=zh_CN
[c82849b578fc4a859a962a1f89219ee2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/ba485eaba76b4b6dbf8d11078f69c561.png
[58040f945d0b4976b3313f0e828c49b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/69b650882d75444ab591e498d2ac4bc4.png
[Link 3]: https://mp.weixin.qq.com/advanced/advanced?action=dev&t=advanced/dev&token=2070316348&lang=zh_CN
[49ecc7b6ec604b4f9870ac1b2ee51134.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/61f39996465b483e998be7b96d986577.png
[717cd3ff95e2468797ea8ca241aeb80c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/95dbc456251e4689bcc6555e9c7d2a35.png
[497d989b135a444fb0ee17ba2e1fa1b4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/aef56f64de3f4b909cc775589479d81f.png
[f71c9835c3044ceaad71c7313149df17.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/394c01e40ce74c9bb24abb8d13234108.png
[1273a3f4e65149bda8560629bc86eb23.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/59808104d36e409a8c156f10ea2e88c4.png
[Link 4]: https://mp.weixin.qq.com/debug/cgi-bin/sandboxinfo?action=showinfo&t=sandbox/index
[d87f2d7a367443d29d412533a6c3d51c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/57a376f7028f46a7a22c069da909fdf0.png
[4c6a1ad4ba8047d282aa66a2445f958b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/1eb2d6bd4a4d4eb4a2332e54de560687.png
[a1803472fab64c2796d0c36a0d83c469.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/099e946374674ffba954bc7b452ff5a6.png
[05112f5f5c5146a89edbbac3a9bf2a57.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/0df3070d984d4eadb6a61acb618ef48d.png
[a822e472ae5f4abe8de251163b69816b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/f9497cc39caa4ecebd6e0ed827bafc33.png
[815dd68a508e427bb63968e7de83e0a0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/ef5d9e1ef49b48f892c43ee6a9c940c8.png
[Link 5]: https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Passive_user_reply_message.html
[93d97013983940ac89f6a5e31ea05c4a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/93e07f62f74c41ba957dbfd4c9aaa43a.png
[ec6dad8adb52426aa3ddacdeba20b723.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/17481da3787f4b0f81ae1c2c49c481bb.png
[e4035ee868dd4a8daed81ec79ce95a8d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/f31697ac51004ebdb2ea47f82a445967.png
[22728510f66540beb52451d3dc1d1dea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/588af72d6f16401aa8c10b94214631b9.png
[9d307b3e19e84523a3ad5f9f94f5984b.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/1d49d5afd72146dd90270929bc865bba.png
[278818a5a27d41748995a26f49f15787.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/ae4367b32a7947e3a2e3477c0b5f1cad.png
[b18f5aefb7404a939953ed7c02977d2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/30e6381aeaba4c09aeae8370748bb91a.png
[656c94690faa4c50ae026054638d49f5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/ad20cc14c26e47129b08e6eb0bc557a0.png
[edc5578116b64fba9cf86cef8137223e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/b1762603119442e08783356d074e1fee.png
[b20e855999e341d1b6c5278d0edf52e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/1c804846386f427c83e14137fd480506.png
[54f1aa72d0e14c36959a0972b17ce638.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/1636bfbd97cf4bcc86a899e2e8a9c2cf.png