微信公众号快速开发框架FastBootWeixin

微信小程序
编辑评级:
分享:

项目基本信息

开发协议 Apache
操作系统 Windows  Linux  OS X 
开发语言 Java
项目所有者 FastBootWeixin
收录时间 2017-09-18

项目介绍

FastBootWeixin 是一款基于 SpringBoot、Spring、SpringMVC 的微信快速开发框架。使用简单快捷,可以快速的完成一个微信公众号。

在使用本框架前建议对微信公众号开发文档有所了解,不过在不了解公众号文档的情况下使用本框架也能完成一个简单的微信公众号。

功能支持

1. Spring Boot风格的启动方式

与Spring Boot完美整合,如果自己没有SpringBoot项目,想直接使用该框架搭建公众号,可直接使用@WxApplication标记启动类,该注解支持参数:menuAutoCreate,默认为true。表示自动创建微信菜单,可以设置为false关闭自动创建菜单的行为。若已有Spring Boot项目,想引入此框架,只需在你的任意配置类上标记注解@EnableWxMvc即可,参数同上。

2. Spring Mvc风格的Mapping

共支持三种Mapping:

注意:

绑定所在类需声明为@WxController

3. Spring Mvc风格的参数绑定

支持以下类型参数:

参数绑定目前支持这几种,如果有更好的方案需要支持,也可以直接提出意见与建议,我会及时进行处理的。

4. Spring Mvc风格的返回值

返回值支持以下类型:

上面异步发送消息都是使用的WxMessageTemplate发送的,下面讲解。

5. Spring风格的消息发送

本框架提供WxMessageTemplate发送消息,同时在template中提供了WxMessageProcesser支持,作用是在消息发送前对消息做处理。

如同步返回消息时,需要写入fromUserName字段,而该字段是消息发送时的toUserName字段,没有必要让框架的使用者去处理这个字段,在WxCommonMessageProcesser处理器中就对该字段进行了处理,有兴趣的可以参考源码。

同时还支持以下转换:对于media类型的消息,可以直接使用mediaUrl或者mediaPath写入素材路径,消息转换器通过WxMediaManager自动管理素材获得必要的素材id。(关于WxMediaManager下面写)

注意:所有的消息处理文本消息,建议都使用WxMessage里的对应消息内容的builder来生成!

6. 素材自动管理

本框架提供WxMediaManager来管理素材,同时使用嵌入式数据库保存素材与本地文件的对应关系,目前这部分功能我虽然完成了,但是总感觉有很大的不妥,希望有人能帮我看看顺便提点意见。

上面消息发送中的媒体其实也是通过素材管理器来实现的。

7. 内置AccessToken管理

本框架提供WxTokenStore接口来存储token,并提供一个默认的基于内存的实现MemoryWxTokenStore,若有分布式需要可以自行实现该接口,并把实现类作为Bean注入Spring即可。

8. 微信接口调用与返回值自动处理

使用WxApiInvokeSpi接口与WxInvokerProxyFactory工厂类自动生成微信接口调用代理,只需要声明方法和注解即可,默认使用HttpComponent调用接口。有兴趣的小伙伴可以看看源码,我写的也不太好,有更好的建议欢迎提出。

同时对返回值做初步分析,如果接口返回内容的errorCode不为0,则会作为异常抛出。异常体系为WxException及其子类。

PS:你也可以使用这种方式任意生成自己的代理调用接口,后续我会加入文档,暂时懒。。。

9. 菜单自动生成与自动更新

可以通过开关开启与关闭,通过@WxButton注解生成菜单结构,并自动调用接口判断菜单是否改变,自动生成与更新菜单。

10. 内置微信接口认证

可以正确响应微信发送的Token验证,方便快捷。

11. 完全无侵入的MVC模式

使用本框架,不会对SpringMvc自己原生的Mapping产生任何影响,也不会占用任何独有的Mapping关系(除了认证请求)。在此框架存在的情况下,你可以使用任何SpringMvc的原生功能,包括根目录的请求,也不会被微信服务器独自占用。

12. 微信Web认证拦截器与URL自动转换

提供微信OAUTH2认证拦截,通过配置wx.mvc.interceptor.includePatterns和wx.mvc.interceptor.excludePatterns来配置拦截的目标地址,你可以提供一个WxOAuth2Callback接口的实现类作为Bean,在WxOAuth2Interceptor中会自动注入这个bean,并在微信Web认证通过后调用after(WxOAuth2Context context)方法把相关的context传递给该Bean的方法,你可以在该方法中获取到context了的WxWebUser,并通过WxUserManager把WxWebUser转换为WxUser。关系详细信息请参考:微信网页授权。

附加功能:自动判断消息中的url是否需要添加OAuth重定向,请参考WxRedirectUtils。


同类项目推荐

相似项目推荐

相关教程