微信公众号开发,原来这么简单?[java框架]

微信公众号开发 专栏收录该内容
3 篇文章 0 订阅

终于有时间更新啦!!最新教程双手奉上!公众号开发之wx-tools+springboot应用实战-音乐爬虫推送[JAVA]

下面都是旧的教程,建议参考上面最新的教程~~


可能你不知道,有个框架叫wx-tools(小心翼翼地说)


Wx-tools是基于微信公众平台API的轻量级框架。 基于Wx-tools你可以开速开发一个订阅号/服务号的web应用后台。
博主最近终于有空!!已经更新到2.1.3啦!!
GitHub仓库
下载wx-tools-2.1.3.jar
wx-tools开发文档及demo
最近更新了开发文档,新增wx-tools接口代码写法。2017/4/14

据说看到文档最后的都是真爱粉!
不多说!讲讲使用wx-tools开发轻量级公众号到底有多简单?
简单到哭


就三步!

  1. 创建web工程,添加jar包及依赖
  2. 配置wx.properties
  3. 调用WxService来实现业务逻辑即可
    【WxService是实现了微信公众平台API入口所以调用非常简单】

如果有过开发过基于微信公众平台API项目的小伙伴们,很容易上手哦!没有也没关系,戳这里看看官方文档入门


先定个功能小目标:现在要实现一个答题小功能。

####一、 创建web工程,添加jar包及依赖

我这里使用的是maven构建项目,可以在eclipse创建web项目。
maven创建项目指令

mvn archetype:generate -DgroupId=wxtools.demo -DartifactId=demo -DarchetypeArtifactId=maven-archetype-webapp -DarchetypeCatalog=local

注意:此指令创建的web工程版本是2.3的,比较低。可以修改web.xml,变成3.0

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
  <display-name>demo</display-name>
</web-app>

也可以直接用eclipse创建maven工程哦~

创建完毕后,导入wx-tools-2.1.3.jar

  • 注意,导入后记得修改jar包的编码。window下默认读GBK,而框架本身是UTF-8。
    如果需要看源代码的务必手动修改编码。
    修改方式:在eclipse的工程下,对着jar包右键 –> Properties –> Encoding –> UTF-8

建立基本的package,如图。
[外链图片转存失败(img-xWPiv84C-1562053209917)(https://antgan.gitbooks.io/wx-tools/content/wx.jpg)]

添加wx-tools依赖的jar包。

如果使用maven构建项目,可以直接添加如下坐标下载依赖jar。

<!-- 补全依赖 -->
    <!-- HttpClient -->
    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.3.6</version>
    </dependency>
    <!-- http://mvnrepository.com/artifact/org.apache.httpcomponents/httpmime -->
    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpmime</artifactId>
        <version>4.3.6</version>
    </dependency>

    <!-- JSON -->
    <dependency>
        <groupId>org.codehaus.jackson</groupId>
        <artifactId>jackson-mapper-asl</artifactId>
        <version>1.9.13</version>
    </dependency>
    <!-- XML -->
    <!-- http://mvnrepository.com/artifact/com.thoughtworks.xstream/xstream -->
    <dependency>
        <groupId>com.thoughtworks.xstream</groupId>
        <artifactId>xstream</artifactId>
        <version>1.4.7</version>
    </dependency>
    <!-- IO -->
    <!-- http://mvnrepository.com/artifact/commons-io/commons-io -->
    <dependency>
        <groupId>commons-io</groupId>
        <artifactId>commons-io</artifactId>
        <version>2.4</version>
    </dependency>

如果不是maven构建的项目,可以自行下载相应的jar包,放在WEB-INF/lib文件夹下
如果与项目中的jar包冲突或重复,只留一个就可以了~


####二、 配置wx.properties
wx.properties是存放微信公众平台相关配置的。如AppId等。

搭好项目基本框架后,在src/main/resources或者src/main/Java下新建wx.properties,如上图

#配置如下,不要填错了哦!注意大小写。
wx.appId=wxb1bff1627d37417bcc
wx.appSecret=dd037d9b9b4eea00fba14167a9f3c75abc
wx.token=antgan
wx.aesKey=f82PVzQsKG5d8en3DwnZ8VVEoGInkmsWz3X3HsreEqe
wx.mchId=
wx.apiKey=

####三、调用WxService来实现业务逻辑
这里有必要介绍一下wx-tools的四大组件。

  • WxMessageRouter 消息路由器
  • WxMessageMatcher(接口) 消息匹配器
  • WxMessageInterceptor (接口) 消息拦截器
  • WxMessageHandler (接口) 消息处理器

这四大组件构成了对微信服务器发送过来的消息进行拓展性的处理。
其中,以上三个是接口,开发者可实现并构建自己的匹配器,拦截器,处理器。
更多的详情可以查看开发文档,对组件解释比较清楚。

此外,还有几个类需要注意一下

  • WxConsts 类
    封装所有微信公众平台API的常量类型,包括接口请求路径,事件等。
  • WxConfig 类
    基本配置库。里面包含了AppId,AppSecret等信息。wx-tools已经提供了个基于内存管理的配置库。暂不支持自行拓展,如有需要持久化到数据库,需要自己实现。注意:配置库对于整个程序是单例的。
  • WxService 类
    微信统一的API Service入口,继承IService接口,所有接口都从这里调用。
  • WxErrorException 类
    微信异常
  • WxErrorExceptionHandler 接口
    开发者可自行实现该接口,处理微信异常

理清了关系后,开始创建自定义匹配器Matcher


1. 创建DemoMatcher.java 实现 WxMessageMatcher接口
目的:拦截消息,如果是答案(答案是smart),就允许通行。否则匹配失败。不允许通过。

/**
* Demo 简单的匹配器,可以用于更加复杂的消息验证操作
* @author antgan
*/
public class DemoMatcher implements WxMessageMatcher{
  //答案是smart,如果匹配smart返回true;反之,false。
  public boolean match(WxXmlMessage message) {
      if(message.getContent().equals("smart")){
        return true;
      }
      return false;
  }
}

**2. 创建DemoInterceptor.java 实现 WxMessageInterceptor接口 **
目的:拦截消息,验证用户条件,需要满足关注3天以上。

/**
 * Demo 拦截器,可以做身份验证,权限验证等操作。
 * @author antgan
 */
public class DemoInterceptor implements WxMessageInterceptor{
    public boolean intercept(WxXmlMessage wxMessage, Map<String, Object> context, IService wxService)
            throws WxErrorException {
        //可以使用wxService的微信API方法
        //可以在Handler和Interceptor传递消息,使用context上下文
        //可以实现自己的业务逻辑

        //这里就不编写验证关注三天以上的用户了
        if(/*用户关注时长大于3天*/){
            return true;
        }
        return false;
    }
}

**3. 创建类DemoHandler.java 实现 WxMessageHandler接口 **
目的:如果满足以上条件的用户消息,返回字符串“恭喜你中奖了”

/**
 * Demo 处理微信消息Handler
 * @author antgan
 */
public class DemoHandler implements WxMessageHandler {
    //wxMessage 消息 | context 上下文 | WxService API对象
    public WxXmlOutMessage handle(WxXmlMessage wxMessage, Map<String, Object> context, IService wxService) throws WxErrorException {
        WxXmlOutMessage xmlOutMsg = null;
        //必须以build()作为结尾,否则不生效。
        if(wxMessage.getMsgType().equals(WxConsts.XML_MSG_TEXT)){
            xmlOutMsg = WxXmlOutMessage.TEXT().content("恭喜你中奖了").toUser(wxMessage.getFromUserName()).fromUser(wxMessage.getToUserName()).build();
        }
        return xmlOutMsg;
    }
}

**4. 创建servlet,名为DemoServlet.java **
当然你也可以使用SpringMVC,是一样的。对应的是Controller【建议使用SpringMVC】
目的:接收微信服务器发来的消息,并传入指定路由器中。

/**
 * <pre>
 * Demo Servlet
 * 如果使用的是SpringMVC,也是类似这样的写法~
 * 
 * 注意:WxConfig请调用getInstance()
 * 因为对于全局是唯一的。采用单例模式。
 * </pre>
 * 
 * @author antgan
 * @date 2016/12/15
 *
 */
@WebServlet("/wx")
public class DemoServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
    // 实例化 统一业务API入口
    private IService iService = new WxService();

    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // 验证服务器的有效性
        PrintWriter out = response.getWriter();
        String signature = request.getParameter("signature");
        String timestamp = request.getParameter("timestamp");
        String nonce = request.getParameter("nonce");
        String echostr = request.getParameter("echostr");
        if (iService.checkSignature(signature, timestamp, nonce, echostr)) {
            out.print(echostr);
        }
    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        // 返回消息给微信服务器
        PrintWriter out = response.getWriter();

        // 创建一个路由器
        WxMessageRouter router = new WxMessageRouter(iService);
        try {
            // 微信服务器推送过来的是XML格式。
            WxXmlMessage wx = XStreamTransformer.fromXml(WxXmlMessage.class, request.getInputStream());
            System.out.println("消息:\n " + wx.toString());
            // 添加规则;这里的规则是所有消息都交给DemoMatcher处理,交给DemoInterceptor处理,交给DemoHandler处理
            // 注意!!每一个规则,必须由end()或者next()结束。不然不会生效。
            // end()是指消息进入该规则后不再进入其他规则。 而next()是指消息进入了一个规则后,如果满足其他规则也能进入,处理。
            router.rule().matcher(new DemoMatcher()).interceptor(new DemoInterceptor()).handler(new DemoHandler())
                    .end();
            // 把消息传递给路由器进行处理
            WxXmlOutMessage xmlOutMsg = router.route(wx);
            if (xmlOutMsg != null)
                out.print(xmlOutMsg.toXml());// 因为是明文,所以不用加密,直接返回给用户。
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            out.close();
        }
    }
}

就是这么简单。通过可定制的Matcher,Interceptor,Handler可以实现更加复杂的业务需求。

对于一条来自微信服务器发来的消息,Interceptor和Handler其实定义多个来同时处理。更加灵活好用。更多详情还是得看wx-tools文档。讲得详细。


最后效果图。
这里写图片描述


###博主有话说
大学的尾巴悄悄来临,我也顺利找到了实习和工作。闲暇期间,想起wx-tools的问题还没解决。
(舍友写项目用了我的wx-tools出现了线程爆炸,难以使用,文档不全等现象。但忙于找工作就放着wx-tools不管了)
终于有时间了,静下心来。看看别人优秀的源代码。心想着我的wx-tools就应该是简单易用,轻量级可拓展。于是,wx-tools-2.1.0.jar又诞生了。

相比之前的wx-tools。这个版本比较大的变化如下:

  • 更简化的配置(wx.properties文件来配置)。
  • 更加简单简约的使用方法(链式编程!酷炫!)
  • 去掉了线程池。(就是这玩意导致舍友项目爆炸了)
  • 去掉了鸡肋的重复消息检查器(Checker)。(当初为什么要加检查重复消息呢?黑人问号???)
  • jssdk的支持。(不支持微信小店)

哎!其实对比了几个微信公众平台开发框架,wx-tools走的路线完全不同。不知道大家喜不喜欢呢~ 喜欢希望你给我star咯~wx-tools Github戳这里!!给星星!爱你么么哒!

我也创了个QQ群(一群:570937047【已满】,二群:577984291),欢迎大家加入,讨论JAVA开发或者对酒当歌。

最后!欢迎大家提BUG或者pull request!小弟能力不足!就这样了!


博主建议使用最新版的jar。同时更新了开发文档–接口用法

  • 新增群发接口及模板消息接口。
  • 支付接口测试阶段。不建议使用。

更新与2017/4/14


啊啊啊官方把用户组变成了用便签管理了,wx-tools近期会更新。跟上组织的步伐。

– 更新与2017/6/20

phpWechat 是由一个具有多年行业开发经验的前端 UI 设计师、PHP开发工程师组成的团队设计、研发的一套的微信公众平台管理系统,您可以瞬间完成一个公共或者PC站或者两者皆有的平台搭建。 phpWeChat 微信+网站开发框架功能亮点: 1、100%开源,没有任何加密文件 phpWeChat核心文件100%开源,没有任何加密文件,开发者可以放心使用而无需担心留有后门程序等。 2、程序轻量级,一天读完所有代码 核心框架压缩包只有2.66M,十分利于开发者迅速阅读全部代码。 3、代码严谨,结构清晰 phpWeChat使用MVC开发模式,各个功能模块之间独立并目录结构统一。开发者可迅速掌握phpWeChat的框架结构。 4、二次开发文档十分完善 我们提供了完善的phpWeChat二次开发文档,便于开发者学习与查阅。 5、高度集成微信接口 phpWeChat高度集成了微信公共的自动回复、菜单管理、素材管理、模板消息、粉丝管理、微信支付等常用接口,您只需一个函数或2/3行代码即可实现原本需要很费时费力才能开发的功能。 6、phpWeChat也是一个PC(网站)开发框架和CMS 慢慢您会发现,phpWeChat是一个更接近CMS功能的框架。 7、高度封装常用开发功能 只需一两行固定的代码,您便可以写出列表分页、微信支付、文件上传、邮件发送、短信发送等功能。 8、数据结构合理,负载强劲 phpWeChat集成了常见的内存级缓存(MemCache)、文件缓存处理方案,使得系统更符合大数据、大并发的公共或网站使用。 9、集成应用市场,功能拓展一瞬间 phpWeChat集成了应用市场并在线安装应用的功能,您可以在一瞬间安装完成其他开发开发的功能模块。 phpWeChat安装方法: 将下载的程序压缩包(zip格式)解压后,将全部文件和文件夹上传至网站根目录。然后输入域名/install.php 即可进入安装程序。 注意:安装phpWeChat前请先创建好phpWeChat所需的数据库。 phpWeChat 目录结构: addons 功能模块目录 admin 公用后台目录 api 插件目录 data 数据缓存目录 install 安装程序目录,安装后请改名或删除 include 公用操作类目录 statics 静态文件目录 template 视图(模板)目录 upload 上传文件存放目录 phpWeChat 更新日志: 新版v1.0.3发布: phpWeChat PC+微信公众号开发核心框架v1.0.3针对v1.0.2版本出现的问题,主要修复了和增加了以下功能: 1、优化自定义模块操作; 2、优化安装过程; 3、修复一处在线支付的PHP版本兼容问题; 4、修复一处自定义模块的问题; 5、修复后台模块管理显示未知版本的bug; 6、修复粉丝行为IP报错的Bug; 7、删除一些冗余代码; 8、修复消息模板不存在时,一直提示[同步中]的bug。
©️2021 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值