使用 Spring Boot Starter 封装 微信 SDK

微信对外提供了很多 API,但是这些 API 使用起来非常不方便,用户需要实现非常底层的操作;所以我以 spring-boot-starter 的形式对其做了一次封装,形成了 wechat-spring-boot-starters 这个项目,尽量做到“零”配置运行;目前实现了消息部分的封装,完成所有类型消息的统一处理,自动执行消息加解密而无需用户参与。以下将介绍 wechat-spring-boot-starters 的基本情况。

配置

前提

  • 此项目基于 Spring Boot,所以要使用本项目,必须引入 Spring Boot 的相关依赖
  • JDK 1.8 及以上

引入 maven 依赖

<dependency>
    <groupId>me.javaroad.openapi.wechat</groupId>
    <artifactId>wechat-spring-boot-starters</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

因为目前是 snapshot 版本,所以还需要引入 snapshot repository :

<repositories>
  <repository>
      <snapshots />
      <id>sonatype snapshots</id>
      <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
  </repository>
</repositories>

基础配置

在 application.yml 中新增以下配置:

weixin:
  mp:
    endpoint:
      # 微信回调地址,默认为 /weixin/callback,如需自定义,请修改以下配置项
      callback-url: /weixin/callback
    security:
      # 微信后台配置的 token
      token: 1234567890
      # 微信后台配置的消息加解密 aeskey
      encodingAesKey: abcdefghijklmnopqrstuvwxyz0123456789ABCDEFG
      # #############################################################
      # 微信 access token 过期刷新阈值,计算方法:
      # 当前时间 - (获得token时间 + token 有效期 + 阈值) < 0 则刷新 token
      # 默认为 token 失效前 5 分钟刷新
      # #############################################################
      refresh-token-threshold: 300
    auth:
      # APPID
      appid: appid
      # APP secret
      secret: secret

关于消息加密解密

系统会自动判断微信服务器推送给用户的消息是否经过加密,如果经过加密,将会自动解密,并在用户服务器返回给微信服务器时自动加密数据,这个过程不需要用户做任何操作。

消息处理 - MessageHandler

当系统接收到微信服务器推送的消息之后,做了两件事情:

  1. 发布了 ReceiveMessageEvent 类型的事件
  2. 将收到的消息分发到 MessageHandler

所以用户可以通过以上两种方式获取微信服务器推送的消息。

第一种方式:

@Component
public class ReceiveMessageEventListener implements ApplicationListener<ReceiveMessageEvent> {

    @Async
    @Override
    public void onApplicationEvent(ReceiveMessageEvent event) {
        System.out.println(event.getSource());
    }
}

这里是通过监听系统事件获取对应的消息,此处 强烈建议 以异步的方式处理消息,如需同步处理消息,请参考第二种方式。

第二种方式

@Component
public class TextMessageHandler extends AbstractMessageHandler<TextMessage> {

    public TextMessageHandler(MessageHandlerFactory messageHandlerFactory) {
        super(messageHandlerFactory);
    }

    @Override
    public ResponseMessage handleMessage(TextMessage message) {
        // 此处根据业务对收到的消息做处理,注意,处理时间不能超过 5s,否则会导致微信对用户给出严重错误的提示
        // 如果时间很可能超过 5s, 需要在新线程中处理
        // 如果不需要对用户返回任何消息,则请在此处返回 EmptyResponseMessage
        return new TextResponseMessage();
    }

}

这种方式会同步执行,所以处理时间必须不能超过 5 s .

系统中提供了以下类型的消息,其中 普通消息事件推送消息 是微信服务器推送给用户服务器的消息,它将作为 MessageHandler 的参数传给对应的 Handler, 被动回复消息特殊消息 为用户服务器返回给微信服务器的消息, 它将作为 MessageHandler 的返回值。

普通消息

  • TextMessage 文本消息

  • ImageMessage 图片消息

  • VoiceMessage 语音消息

  • VideoMessage 视频消息

  • ShortVideoMessage 小视频消息

  • LocationMessage 地理位置消息

  • LinkMessage 链接消息

事件推送消息

  • SubscribeEventMessage 关注/取消关注 事件
  • QrCodeEventMessage 扫二维码事件
  • CustomMenuEventMessage 自定义菜单事件
  • LocationEventMessage 上报地理位置事件

被动回复消息

  • TextResponseMessage 文本消息

  • ImageResponseMessage 图片消息

  • VoiceResponseMessage 语音消息

  • VideoResponseMessage 视频消息

  • MusicResponseMessage 音乐消息

  • NewsResponseMessage 图文消息

特殊消息

  • EmptyResponseMessage 这个消息仅用于被动回复用户时,如果接收了用户的消息而不希望给用户回复的话,请返回此消息

结语

以上就是目前实现的消息管理的部分接口,后续会继续完善。

最后附上源码:GitHub

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容