spring-boot-route（二十三）开发微信公众号

清疚 2021-09-18 06:12 247阅读 0赞

在讲微信公众号开发之前，先来大概了解一下微信公众号。微信公众号大体上可以分为服务号和订阅号，订阅号和服务号的区别如下：

1.  服务号可以申请微信支付功能。
2.  服务号只能由企业申请，订阅号可以有企业或个人申请。
3.  订阅号和服务号每月推送消息次数不同，订阅号每天可以推送一次，服务号每月可以推送四次。
4.  服务号推送的消息会出现在用户的聊天列表中，而订阅号推送的消息显示在订阅号文件夹中。
5.  还有一些其他接口功能的区别和限制，总的来说服务号支持更高级的功能开发。

订阅号更加偏向于向用户传递咨询，一般各种技术类公众号都属于订阅号，订阅号的消息推送并不会有太显眼的提醒，如果你想让某个公众号的推送内容更加显眼，可以选择置为星标。置为星标后公众号会显示在所有订阅号的最顶部，同时收到消息后会有黄色五角星星标提醒。

## 一 公众号配置服务器 ##

微信官方提供了非常完善的接入文档，如果想了解文档的具体内容，直接浏览器搜索**微信开发文档**就可以了。但是为了方便开发，一般不会直接去根据微信开发文档进行开发，gitee上有许多开源项目对微信开发文档进行了封装，这里我使用`mica-weixin`开发包进行演示，`mica-weixin`是`jfinal-weixin`的boot版本。

配置服务器信息很简单，具体流程就是**微信服务发送请求一个请求给业务服务器，业务服务器验证请求后给微信服务一个响应**。

### 1.1 搭建业务服务 ###

本地搭建一个`spring-boot-weixin`的项目，使用内网穿透工具进行穿透，使其可以与外网进行通信。

#### 1.1.1 引入`mica-weixin`依赖 ####

<dependency>
        <groupId>net.dreamlu</groupId>
        <artifactId>mica-weixin</artifactId>
        <version>2.0.1</version>
    </dependency>

#### 1.1.2 配置公众号信息 ####

`mica-weixin`通过配置文件进行公众号信息的配置，如果你想通过数据库配置公众号信息，可以参考我以前写过的一篇文章[jfinal-weixin自定义配置支持多公众号][jfinal-weixin]。

dream:
      weixin:
        wx-configs:
        - appId: xxxxxx
          appSecret: xxxxxx
          token: javatrip
          encodingAesKey: xxxxxx

`appId`和`appSecret`可在公众号后台进行查看，具体位置在菜单**开发—>基本配置**中，其中`appSecret`要妥善保管，现在公众号已经不支持查看`appSecret`了，如果你忘了`appSecret`，只能进行重置。

#### 1.1.3 开发消息校验接口 ####

`mica-weixin`已经为我们提供好了消息校验接口，只需要继承`DreamMsgControllerAdapter`就可以了。

@WxMsgController("/weixin/wx")
    public class WeiXinMsgController extends DreamMsgControllerAdapter { 
        @Override
        protected void processInFollowEvent(InFollowEvent inFollowEvent) { 
        }
    
        @Override
        protected void processInTextMsg(InTextMsg inTextMsg) { 
        }
    
        @Override
        protected void processInMenuEvent(InMenuEvent inMenuEvent) { 
        }
    }

同时，需要开启缓存，由于`mica-weixin`的将`access_token`等信息放在了缓存中。在启动类上加`@EnableCaching`就开启了。

@SpringBootApplication
    @EnableCaching
    public class WeixinApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(WeixinApplication.class, args);
        }
    }

#### 1.1.4 公众号后台配置服务器信息 ####

使用内网穿透工具穿透内网地址，然后在公众号后台菜单**开发—>基本配置**中填写服务器配置信息。

![f0236da7bc1834c005f180cbdeaf60ec.png][]

填写完成后点击启用，这样就完成了微信服务器和业务服务器的关系配置。开启开发者配置后，自动回复、自定义菜单等功能都不能正常使用了。这时候就需要去调用对应的接口实现这些功能。

![343444dda4dec2b6aaad29af75b5ebbd.png][]

## 二 实现各种消息接口 ##

### 2.1 关注消息 ###

在一步中，自定义类`WeiXinMsgController`中需要重写三个父类中的方法，其中`processInFollowEvent()`就是关注和取消关注的方法，取消关注后用户虽然不能收到消息，但是后台可以接收到用户取消关注的事件。

@Override
    protected void processInFollowEvent(InFollowEvent inFollowEvent) { 
    
        OutTextMsg defaultMsg = new OutTextMsg(inFollowEvent);
        // 关注
        if(InFollowEvent.EVENT_INFOLLOW_SUBSCRIBE.equals(inFollowEvent.getEvent())){ 
            // 可将关注用户录入db，此处可以获取到用户openid
            String openId = inFollowEvent.getFromUserName();
            // 查询db，根据响应消息类型封装消息体
            if("文本消息"){ 
                OutTextMsg otm = new OutTextMsg(inFollowEvent);
                otm.setContent("消息内容");
                render(otm);
                return;
            }else if("图片消息"){ 
                OutImageMsg oim = new OutImageMsg(inFollowEvent);
                // 这里需要调用微信提供的素材接口，将图片上传至素材库。
                oim.setMediaId("图片素材id");
                render(oim);
                return;
            }else if("图文消息"){ 
                OutNewsMsg onm = new OutNewsMsg(inFollowEvent);
                onm.addNews("标题","简介","图片地址","图文链接");
                render(onm);
                return;
            }else if("视频消息"){ 
                OutVideoMsg ovm = new OutVideoMsg(inFollowEvent);
                ovm.setTitle("标题");
                ovm.setDescription("简介");
                ovm.setMediaId("视频素材id");
                render(ovm);
                return;
            }else{ 
                defaultMsg.setContent("感谢关注");
            }
        }
        // 取消关注
        if(InFollowEvent.EVENT_INFOLLOW_UNSUBSCRIBE.equals(inFollowEvent.getEvent())){ 
            log.info("用户取消关注了");
            // 此处可以将取消关注的用户更新db
        }
    }

### 2.2 关键词消息 ###

响应内容跟关注消息一样，查询db去匹配关键词，然会根据消息内容封装对应的消息体进行返回，如果没匹配到关键词则回复统一的消息内容。`processInTextMsg()`方法就是用来回复关键词消息的。

@Override
    protected void processInTextMsg(InTextMsg inTextMsg) { 
    
        String content = inTextMsg.getContent();
        // 根据用户发送的content去查询db中的响应内容
        if("文本消息"){ 
            OutTextMsg otm = new OutTextMsg(inTextMsg);
            otm.setContent("消息内容");
            render(otm);
            return;
        }else if("图片消息"){ 
            OutImageMsg oim = new OutImageMsg(inTextMsg);
            // 这里需要调用微信提供的素材接口，将图片上传至素材库。
            oim.setMediaId("图片素材id");
            render(oim);
            return;
        }else if("图文消息"){ 
            OutNewsMsg onm = new OutNewsMsg(inTextMsg);
            onm.addNews("标题","简介","图片地址","图文链接");
            render(onm);
            return;
        }else if("视频消息"){ 
            OutVideoMsg ovm = new OutVideoMsg(inTextMsg);
            ovm.setTitle("标题");
            ovm.setDescription("简介");
            ovm.setMediaId("视频素材id");
            render(ovm);
            return;
        }else{ 
            OutTextMsg otm = new OutTextMsg(inTextMsg);
            otm.setContent("暂未查到关键词...");
        }
    }

### 2.3 菜单消息 ###

点击菜单后也是一样，通过`processInMenuEvent()`方法进行响应内容的回复。

@Override
    protected void processInMenuEvent(InMenuEvent inMenuEvent) { 
        String eventKey = inMenuEvent.getEventKey();
        // 根据用户发送的content去查询db中的响应内容
        if("文本消息"){ 
            OutTextMsg otm = new OutTextMsg(inMenuEvent);
            otm.setContent("消息内容");
            render(otm);
            return;
        }else if("图片消息"){ 
            OutImageMsg oim = new OutImageMsg(inMenuEvent);
            // 这里需要调用微信提供的素材接口，将图片上传至素材库。
            oim.setMediaId("图片素材id");
            render(oim);
            return;
        }else if("图文消息"){ 
            OutNewsMsg onm = new OutNewsMsg(inMenuEvent);
            onm.addNews("标题","简介","图片地址","图文链接");
            render(onm);
            return;
        }else if("视频消息"){ 
            OutVideoMsg ovm = new OutVideoMsg(inMenuEvent);
            ovm.setTitle("标题");
            ovm.setDescription("简介");
            ovm.setMediaId("视频素材id");
            render(ovm);
            return;
        }else{ 
            OutTextMsg otm = new OutTextMsg(inMenuEvent);
            otm.setContent("无效链接，请重试...");
        }
    }

### 三 接口API调用 ###

目前，微信提供的接口对订阅号的限制比较大，未认证的订阅号基本上只有接收消息的几个功能接口。

调用接口的时候需要传递`token`，获取token需要在微信后台中配置业务服务器的白名单。如下：

![14076010c0cf8dd06cea29e36072ab16.png][]

如果需要配置多个白名单ip，使用回车键将多个ip分隔开。

`mica-weixin`提供了所有的接口封装，具体可参考它的官方文档，如果要获取微信菜单，可以这样写：

@WxApi("weixin/api")
    public class WeiXinApiController { 
        @GetMapping("menu")
        @ResponseBody
        public String getMenu(){ 
            ApiResult menu = MenuApi.getMenu();
            return menu.getJson();
        }
    }

`@WxApi`这个是它的自定义注解，其实就是包含了`@RequestMapping`和`@Controller`。

## 四 其他事项 ##

### 4.1 多公众号配置 ###

`mica-weixin`提供了多公众号配置的功能，使用`ThreadLocal`和`appid`进行绑定。只需要简单配置即可实现多公众号配置。

dream:
      weixin:
        wx-configs:
          - appId: xxxxxx
            appSecret: xxxxxx
            token: javatrip
            encodingAesKey: xxxxxx
          - appId: xxxxxx
            appSecret: xxxxxx
            token: javatrip
            encodingAesKey: xxxxxx

### 4.2 redis配置 ###

`access_token`的有效期是2小时，并且该接口有调用次数限制，`mica-weixin`将`access_token`存储在redis中，避免每次调用接口都去获取`access-token`，因此项目需要配置redis。

spring:
      redis:
        host: localhost
        port: 6379

### 4.3 手动选择ThreadLocal ###

如果想要开发微信公众号的后台管理功能，多公众号的时候就需要手动去指定当前线程使用哪个公众号信息。如下：

ApiConfigKit.setThreadLocalAppId(appid);

至此，SpringBoot开发微信公众号就算完成了，由于订阅号开放的接口太少了，好多功能不能正常演示。还有`mica-weixin`也许不是最好的选择，如果想试着开发微信公众号，可以在gitee上找一下开发包。至于我为什么会使用`mica-weixin`，是因为我曾用过一段时间的`jfinal`框架，与之配套的微信开发包就是`jfinal-weixin`，也就是jfinal版的`mica-weixin`。

--------------------

#### 本文示例代码已上传至[github][]，点个`star`支持一下！ ####

## Spring Boot系列教程目录 ##

[spring-boot-route（一）Controller接收参数的几种方式][spring-boot-route_Controller]

[spring-boot-route（二）读取配置文件的几种方式][spring-boot-route]

[spring-boot-route（三）实现多文件上传][spring-boot-route 1]

[spring-boot-route（四）全局异常处理][spring-boot-route 2]

[spring-boot-route（五）整合swagger生成接口文档][spring-boot-route_swagger]

[spring-boot-route（六）整合JApiDocs生成接口文档][spring-boot-route_JApiDocs]

[spring-boot-route（七）整合jdbcTemplate操作数据库][spring-boot-route_jdbcTemplate]

[spring-boot-route（八）整合mybatis操作数据库][spring-boot-route_mybatis]

[spring-boot-route（九）整合JPA操作数据库][spring-boot-route_JPA]

[spring-boot-route（十）多数据源切换][spring-boot-route 3]

[spring-boot-route（十一）数据库配置信息加密][spring-boot-route 4]

[spring-boot-route（十二）整合redis做为缓存][spring-boot-route_redis]

[spring-boot-route（十三）整合RabbitMQ][spring-boot-route_RabbitMQ]

[spring-boot-route（十四）整合Kafka][spring-boot-route_Kafka]

[spring-boot-route（十五）整合RocketMQ][spring-boot-route_RocketMQ]

[spring-boot-route（十六）使用logback生产日志文件][spring-boot-route_logback]

[spring-boot-route（十七）使用aop记录操作日志][spring-boot-route_aop]

[spring-boot-route（十八）spring-boot-adtuator监控应用][spring-boot-route_spring-boot-adtuator]

[spring-boot-route（十九）spring-boot-admin监控服务][spring-boot-route_spring-boot-admin]

[spring-boot-route（二十）Spring Task实现简单定时任务][spring-boot-route_Spring Task]

[spring-boot-route（二十一）quartz实现动态定时任务][spring-boot-route_quartz]

[spring-boot-route（二十二）实现邮件发送功能][spring-boot-route 5]

[spring-boot-route（二十三）开发微信公众号][spring-boot-route 6]

[spring-boot-route（二十四）分布式session的一致性处理][spring-boot-route_session]

[spring-boot-route（二十五）两行代码实现国际化][spring-boot-route 7]

[spring-boot-route（二十六）整合webSocket][spring-boot-route_webSocket]

[jfinal-weixin]: https://mp.weixin.qq.com/s?__biz=MzU5NjA3MjQ5MA==&mid=2247484188&idx=1&sn=4d84845ca7dacf1aaff0076e19c2e583&chksm=fe690259c91e8b4f36f6aef4ad368349e4992fb81f2e3568bfa9dabd82427aaafa3e3f7c4113&token=894770771&lang=zh_CN#rd
[f0236da7bc1834c005f180cbdeaf60ec.png]: /images/20210918/f7d38d7bb747456e988ff474a49e9c00.png
[343444dda4dec2b6aaad29af75b5ebbd.png]: /images/20210918/db963a9734a04e79920464a90fa0d386.png
[14076010c0cf8dd06cea29e36072ab16.png]: /images/20210918/99ef02c6c2414f828b8a0a25e32e0997.png
[github]: https://github.com/binzh303/spring-boot-route
[spring-boot-route_Controller]: https://javatip.cn/archives/66
[spring-boot-route]: https://javatip.cn/archives/72
[spring-boot-route 1]: https://javatip.cn/archives/74
[spring-boot-route 2]: https://javatip.cn/archives/79
[spring-boot-route_swagger]: https://javatip.cn/archives/90
[spring-boot-route_JApiDocs]: https://javatip.cn/archives/91
[spring-boot-route_jdbcTemplate]: https://javatip.cn/archives/92
[spring-boot-route_mybatis]: https://javatip.cn/archives/93
[spring-boot-route_JPA]: https://javatip.cn/archives/94
[spring-boot-route 3]: https://javatip.cn/archives/95
[spring-boot-route 4]: https://javatip.cn/archives/113
[spring-boot-route_redis]: https://javatip.cn/archives/114
[spring-boot-route_RabbitMQ]: https://javatip.cn/archives/115
[spring-boot-route_Kafka]: https://javatip.cn/archives/116
[spring-boot-route_RocketMQ]: https://javatip.cn/archives/117
[spring-boot-route_logback]: https://javatip.cn/archives/118
[spring-boot-route_aop]: https://javatip.cn/archives/119
[spring-boot-route_spring-boot-adtuator]: https://javatip.cn/archives/120
[spring-boot-route_spring-boot-admin]: https://javatip.cn/archives/121
[spring-boot-route_Spring Task]: https://javatip.cn/archives/122
[spring-boot-route_quartz]: https://javatip.cn/archives/123
[spring-boot-route 5]: https://javatip.cn/archives/124
[spring-boot-route 6]: https://javatip.cn/archives/125
[spring-boot-route_session]: https://javatip.cn/archives/284
[spring-boot-route 7]: https://javatip.cn/archives/256
[spring-boot-route_webSocket]: https://javatip.cn/archives/255