-
包引入
<dependency> <groupId>me.hao0</groupId> <artifactId>wechat</artifactId> <version>1.8.0</version> </dependency>
-
依赖包,注意引入项目时是否需要exclude:
<dependency> <groupId>me.hao0</groupId> <artifactId>common</artifactId> <version>1.1.0</version> </dependency> <!-- 1.3.0之后引入 --> <dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>18.0</version> </dependency>
-
业务系统与微信公众号交互图阐述:
-
API基本用法:
Wechat wechat = WechatBuilder.newBuilder("appId", "appSecret") .conf1() // 其他可选配置 ... .build(); // 同步调用 wechat.module().api(); // 异步调用 wechat.module().api(Callback<T>);
-
Wechat已实现以下组件:
- 基础:
base()
- 用户:
user()
- 菜单:
menu()
- 多客服:
cs()
- 消息:
msg()
- 二维码:
qr()
- 素材:
material()
- JS调用相关:
js()
- 数据统计:
data()
- 基础:
-
API使用文档见这里
-
组件扩展: 如果想自己扩展组件,可以继承
Component
,调用register
:public class MyComponent extends Component { // ... } MyComponent myComp = new MyComponent(); wechat.register(myComp);
-
AccessToken管理:
由于微信服务器限制AccessToken请求次数,并且频繁请求AccessToken并不是一个明智之举,需要将获取的AccessToken保存下来,待过期时,再去请求新的AccessToken,所以以上API均提供了无accessToken版本,如:
List<String> ip(); List<String> ip(String accessToken);
-
实现
AccessTokenLoader
:public interface AccessTokenLoader { /** * 获取accessToken * @return accessToken,若""或NULL会重新从微信获取accessToken,并触发refresh方法 */ String get(); /** * 刷新accessToken,实现时需要保存一段时间,以免频繁从微信服务器获取 * @param token 从微信获取的新AccessToken */ void refresh(AccessToken token); }
-
默认的AccessTokenLoader实现(生产环境不推荐使用):
public class DefaultAccessTokenLoader implements AccessTokenLoader { private volatile AccessToken validToken; @Override public String get() { return (validToken == null || Strings.isNullOrEmpty(validToken.getAccessToken()) || System.currentTimeMillis() > validToken.getExpiredAt()) ? null : validToken.getAccessToken(); } @Override public void refresh(AccessToken token) { validToken = token; } }
-
Ticket管理: 同AccessToken类似,需自己实现接口
TicketLoader
:public interface TicketLoader { /** * 获取Ticket * @param type ticket类型 * @see me.hao0.wechat.model.js.TicketType * @return 有效的ticket,若返回""或null,则重新从微信请求Ticket,并触发refresh方法 */ String get(TicketType type); /** * 刷新Ticket * @param ticket 从微信获取的新Ticket */ void refresh(Ticket ticket); }
-
默认的TicketLoader实现(生产环境不推荐使用):
public class DefaultTicketLoader implements TicketLoader { private final Map<TicketType, Ticket> tickets = new ConcurrentHashMap<>(); @Override public String get(TicketType type) { Ticket t = tickets.get(type); return (t == null || Strings.isNullOrEmpty(t.getTicket()) || System.currentTimeMillis() > t.getExpireAt()) ? null : t.getTicket(); } @Override public void refresh(Ticket ticket) { tickets.put(ticket.getType(), ticket); } }
-
具体例子,可见测试用例。
-
历史版本
-
1.0.0:
- 基础功能实现。
-
1.1.0:
- 实现代码简化,个别类访问权限修改;
- 实现MATERIAL组件。
-
1.2.0:
- 废弃~~
Wechat.newWechat
~~构建方法,替换为WechatBuilder
方式。 *Loader
设置过期时刻。- 实现JSSDK组件。
- 废弃~~
-
1.3.0:
- 引入guava。
- API支持异步调用。
-
1.4.0:
- 组件懒加载。
- 改变组件访问方式,由
变量到方法。
-
1.5.0:
- 上传客服头像。
- 消息转发客服接口移至消息模块。
- 实现DATA组件。
-
1.6.0:
- 将通用工具类移入common组件。
-
1.6.1:
- 文档完善,类访问权限控制;
- 更新最新common包。
-
1.6.2:
- 参数严格校验。
-
1.6.3:
- 简化校验。
-
1.6.4:
- 更新最新common包。
-
1.6.5
- 升级common,去掉kfAccount校验。
-
1.6.6
- 修复respNews参数校验。
-
1.6.7
- 消息群发兼容msgId为Int时。
-
1.6.8
- 修复消息被动回复问题。
-
1.6.9
- 修复微信菜单事件类型判断。
-
1.6.10
- 修复User.unionId为String类型。
-
1.7.0
- 增加获取用户列表的接口
Users.getUsers()
。
- 增加获取用户列表的接口
-
1.8.0
- 增加通过场景字符串获取永久二维码的接口
QrCodes.getPermQrcodeBySceneStr()
。
- 增加通过场景字符串获取永久二维码的接口
-
-
微信相关文档
-
你是好人
bosioer / wechat Goto Github PK
View Code? Open in Web Editor NEWThis project forked from ihaolin/wechat
轻量的微信公众号组件(A Lightweight Wechat Component)
License: MIT License