java微信开发框架wechat4j入门教程

wechat4j

What is wechat4j?

wechat develop framework for java(微信开发框架JAVA版，最简单易用微信开发框架)

wechat4j能够用来干什么？

wechat4j是一个帮助你开发微信应用的jar包，使用它，你开发微信公众号应用只须要几秒钟的时间，彻底不用关注太细节的东西。

wechat4j快速开始

能够去下载wechat4j示例项目，而后在其基础之上修改便可。若是你要本身搭建，那么使用wechat4j只须要两步就能够搭建微信开发环境。

1. 建立一个web工程，导入jdk和相关的web工程jar包。
2. 下载wechat4j.jar包，下载地址wechat4j下载。
3. 建立wechat4j配置文件，在src目录下（java根目录）建立wechat4j.properties文件，配置你微信公众号的相关信息。内容以下：

#you server url
wechat.url=
#you wechat token
wechat.token=token
#message secret key,if don't set then message is cleartext
wechat.encodingaeskey=

#wechat appid
wechat.appid=appid
#wechat app secret
wechat.appsecret=secret

#wechat access token server ,when you save in db,must implement you server class
#this class must extend org.sword.wechat4j.token.DbAccessTokenServer
#if no this property,then token server is default memery accesstoken server()
wechat.accessToken.server.class=

#jsapi_ticket customer server class name,
#this class must extend org.sword.wechat4j.token.server.CustomerServer
#if no this property,then ticket server is default memery ticket server
wechat.ticket.jsapi.server.class=

你也能够在jar包的META-INF目录下找到wechat4j.properties.sample文件，复制到src目录下修更名称便可。wechat4j.properties配置文件的配置项意义参见wechat4j配置文件解读

经过以上步骤，你的微信工程就彻底搭好了。

wechat4j 运行环境

wechat4j要求的最低java运行环境是jdk1.6

wechat4j.jar的依赖jar包

• commons-codec.jar 1.3以上
• commons-lang3.jar
• log4j.jar 1.2以上
• fastjson-1.2.0.jar
• fluent-hc-4.3.6.jar（httpclient依赖）
• httpclient-4.3.6.jar
• httpcore-4.3.3.jar （httpclient依赖）
• servlet-api.jar 若是你是web工程，导入支持web工程的包就会包括，例如tomcat包

开发本身的微信应用

wechat4j开发环境搭好以后，就能够开始开发本身的微信应用了。好比我有一个微信号的token是lejian,下面就以她为例子来讲明。

建立本身公众号服务类

建立本身的微信公众号服务类，须要继承wechat4j的WechatSupport类，而后实现其抽象方法便可，下面以文本消息处理为例子

public class Lejian extends WechatSupport{
public Lejian(HttpServletRequest request, String token) {
super(request, token);
}

@Override
protected void onText() {
this.wechatRequest.getFromUserName();
String content = "test ok";
responseText(content);
}
}

上面代码中的onText()是WechatSupport的抽象方法，须要你本身的类来实现，表示对文本消息的处理，示例中是接收到用户的消息以后，返回给用户“test ok”文本消息。

建立微信服务地址

建立微信服务地址（微信公众平台中配置的本身服务器地址）servlet类。若是是springmvc则建立对应的controller，若是是struts则建立对应的action类。servlet类示例以下：

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
Lejian lejian = new Lejian(request, TOKEN);
String result = lejian.execute();
response.getOutputStream().write(result.getBytes());
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
Lejian lejian = new Lejian(request, TOKEN);
String result = lejian.execute();
response.getOutputStream().write(result.getBytes());

}

经过上面两步你的微信服务就能够运行了

如何获得微信的请求参数

继承了WechatSupport类以后，你能够经过wechatRequest.getFromUserName()相似的方法来获得微信服务器请求的参数。详细信息请阅读微信请求参数

如何设置响应参数

继承了WechatSupport类以后，你能够经过wechatResponse.setFromUserName(fromUser)相似的方法来设置给微信服务器的响应参数。详细信息请阅读响应微信服务器参数

如何响应用户信息

以文本信息为例，响应文本信息只须要在你的onText方法中使用responseText(content)便可（参见上面的代码例子）

wechat4j示例项目

• wechat4jDemo

若是你有好的demo项目，请邮件或者修改本文件而后pull request给我，我会列在上面。

技术支持

• wechat4j技术交流QQ群 423134346
• 支持邮件 sword_org@163.com
• wechat4j暂不管坛，欢迎开通论坛交流版块，若是开通请邮件，我会添加到这里。

贡献代码

1. 若是你以为本项目不错，但愿你可以点击一下右上角的star
2. 若是你但愿参与改进本项目，那么请点击右上角的fork，修改以后pull request便可。若是你的贡献不错，你就会收到加入sword开源社区的邀请。
3. 若是你发现了一个bug，请你建立一个issue来报告。
   很是很是欢迎你可以参与本项目的建设，每人作出一点点贡献，对整个项目来讲就是一个很是大的贡献，但愿集合众人的力量，让项目走的更好，可以为更多的人服务。

贡献者列表

• @chengn
• @truecn