1
- Weixin Java Tools 微信公众号/ 企业号开发Java SDK
2
- =====================================
1
+ 微信支付、公众号& 企业号开发Java SDK
2
+ ---------------------------------
3
3
[ ![ Maven Central] ( https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent/badge.svg )] ( https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent )
4
- [ ![ Build Status] ( https://travis-ci.org/wechat-group/weixin-java-tools.svg?branch=develop )] ( https://travis-ci.org/wechat-group/weixin-java-tools )
5
-
6
- ### 注意:
7
- 1 . *** 本项目Fork自chanjarster/weixin-java-tools,但由于原项目已停止维护,故单独维护和发布,且发布到maven上的groupId也会不同,详细信息见下文。***
8
- 1 . *** 自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。***
9
- 1 . 本SDK要求的最低JDK版本是7,为满足少量还在使用JDK6的用户的需求,特意抽出独立的代码分支项目,请参考 https://github.com/binarywang/weixin-java-tools-for-jdk6 ,其他更早的JDK版本则需要自己改造实现;
10
- 1 . 最新更新:2016-11-30 发布2.4.0正式版!
11
-
12
- ===========
13
-
14
- ## 开发交流方式及注意事项:
15
- 1 . QQ群:343954419(推荐点击按钮入群: [ ![ Join QQ Group] ( http://pub.idqqimg.com/wpa/images/group.png )] ( http://shang.qq.com/wpa/qunwpa?idkey=731dc3e7ea31ebe25376cc1a791445468612c63fd0e9e05399b088ec81fd9e15 ) 或 [ ![ Join QQ Group] ( http://pub.idqqimg.com/wpa/images/group.png )] ( http://jq.qq.com/?_wv=1027&k=40lRskK ) ,如果无反应,可以自行搜索群号进行添加 )
4
+ [ ![ Build Status] ( https://travis-ci.org/Wechat-Group/weixin-java-tools.svg?branch=develop )] ( https://travis-ci.org/Wechat-Group/weixin-java-tools )
5
+
6
+ ### 注意事项:
7
+ 1 . 声明: *** 本项目Fork自chanjarster/weixin-java-tools,但由于原项目已停止维护,故单独维护和发布,且发布到maven上的groupId也会不同,详细信息见下文。***
8
+ 1 . ** 新手请注意,本项目仅是一个开发工具包(即SDK),未提供Web实现,建议使用maven或gradle引用本项目即可使用本SDK提供的各种功能,详情可参考下文中提到的Demo项目或本项目中的部分单元测试代码;如果没有贡献代码的意愿,不建议下载项目的源码自行编译,因为如果想看源码使用maven也是可以下载源码的** ;
9
+ 1 . 最新更新:** 2017-2-12 发布[ 【2.5.0正式版】] ( https://github.com/Wechat-Group/weixin-java-tools/releases ) ** !
10
+ 1 . 开源中国网站的本项目介绍的首页链接地址:https://www.oschina.net/p/weixin-java-tools-new
11
+ 1 . 自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。
12
+ 1 . SDK详细开发文档请查阅 [ 【Wiki】] ( https://github.com/wechat-group/weixin-java-tools/wiki ) ,部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。
13
+ 1 . 各个模块的Javadoc可以在线查看(有可能是最新的测试版本的,请注意观察版本号):[ weixin-java-mp] ( https://binarywang.github.io/weixin-java-mp-javadoc/ ) 、[ weixin-java-common] ( https://binarywang.github.io/weixin-java-common-javadoc/ ) 、[ weixin-java-cp] ( https://binarywang.github.io/weixin-java-cp-javadoc/ )
14
+ 1 . 本SDK要求的最低JDK版本是7,还在使用JDK6的用户请参考[ 【此项目】] ( https://github.com/binarywang/weixin-java-tools-for-jdk6 ) ,而其他更早的JDK版本则需要自己改造实现。
15
+ 1 . 如有新功能需求,发现BUG,或者由于微信官方接口调整导致的代码问题,可以直接在[ 【Issues】] ( https://github.com/Wechat-Group/weixin-java-tools/issues ) 页提出issue,便于讨论追踪问题;
16
+ 1 . 如果想贡献代码,请阅读[ 【代码贡献指南】] ( CONTRIBUTION.md ) ;
17
+ 1 . 捐助渠道已开通,如有意向请前往托管于码云的项目首页(具体地址见下文)的页面评论区上方,可以找到“捐助”按钮,非常感谢各位捐助的同学!
18
+
19
+ ---------------------------------
20
+ ## SDK使用交流方式说明:
21
+ 1 . QQ群: [ ![ 加入QQ群] ( https://img.shields.io/badge/QQ群-343954419-blue.svg )] ( http://shang.qq.com/wpa/qunwpa?idkey=731dc3e7ea31ebe25376cc1a791445468612c63fd0e9e05399b088ec81fd9e15 ) 或 [ ![ 加入QQ群] ( https://img.shields.io/badge/QQ群-343954419-blue.svg )] ( http://jq.qq.com/?_wv=1027&k=40lRskK ) ,推荐点击按钮入群,当然如果无法成功操作,请自行搜索群号343954419进行添加 )
16
22
1 . 由于群容量有限,即将爆满,故开启付费入群模式以保证只有真实交流需求的人进入,并为保证群的活跃度,将不定期清理长时间不活跃的同学;
17
23
1 . 微信群: 因微信群已达到100人限制,故如有想加入微信群的,请入QQ群后联系管理员,提供微信号以便邀请加入;
18
24
1 . 新手提问前,请先阅读此文章:http://t.cn/RV93MRB
19
25
1 . 寻求帮助时需贴代码或大长串异常信息的,请利用http://paste.ubuntu.com
20
- 1 . 有功能需求或由于微信官方接口调整导致的代码问题,可以直接提出issue,便于讨论追踪问题;
21
- 1 . 详细开发文档请看 [ Wiki] ( https://github.com/wechat-group/weixin-java-tools/wiki ) ,部分文档可能未能及时更新,如有发现,可以及时上报或者自行修改。
22
- 1 . 微信公众号官方文档入口地址:http://mp.weixin.qq.com/wiki (注意,从网上搜到的文档有的虽然地址前面跟这个一样,但明显左侧菜单不一致,是旧的文档,注意不要看错文档)。
23
- 1 . 各个模块的Javadoc可以在线查看:[ weixin-java-mp] ( https://binarywang.github.io/weixin-java-mp-javadoc/ ) 、[ weixin-java-common] ( https://binarywang.github.io/weixin-java-common-javadoc/ ) 、[ weixin-java-cp] ( https://binarywang.github.io/weixin-java-cp-javadoc/ )
24
-
25
- ===========
26
26
27
+ ---------------------------------
27
28
## 版本说明
28
- 1 . 本项目定为每两个月发布一次正式版 ,版本号格式为X.X.0(如2.1.0,2.2.0等),月底发布新版本 ,遇到重大问题需修复会及时提交新版本,欢迎大家随时提交Pull Request;
29
- 1 . BUG修复和新特性一般会先发布成小版本作为临时版本 (如2.0.1 ,2.0.2等 ,即尾号不为0,以区别于正式版);
29
+ 1 . 本项目定为大约每两个月发布一次正式版 ,版本号格式为X.X.0(如2.1.0,2.2.0等),遇到重大问题需修复会及时提交新版本,欢迎大家随时提交Pull Request;
30
+ 1 . BUG修复和新特性一般会先发布成小版本作为临时测试版本 (如2.4.5.BETA ,2.4.6.BETA等 ,即尾号不为0,并添加BETA字样 ,以区别于正式版);
30
31
1 . 目前最新版本号为 [ ![ Maven Central] ( https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent/badge.svg )] ( https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent ) ,也可以通过访问链接 [ 【公众号】] ( http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.github.binarywang%22%20AND%20a%3A%22weixin-java-mp%22 ) 、[ 【企业号】] ( http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.github.binarywang%22%20AND%20a%3A%22weixin-java-cp%22 )
31
32
分别查看所有最新的版本。
32
33
33
- ## Maven & Gradle
34
+ ---------------------------------
35
+ #### 本项目在几个著名的代码托管网站同步更新,地址分别是:
36
+ * 码云:http://git.oschina.net/binary/weixin-java-tools
37
+ * GitHub: https://github.com/wechat-group/weixin-java-tools
38
+ * Bitbucket:https://bitbucket.org/binarywang/weixin-java-tools
39
+ * Coding: https://git.coding.net/binarywang/weixin-java-tools.git
40
+
41
+ ---------------------------------
42
+ ## 可参考的Demo项目
43
+ #### 欢迎提供更多的Demo供新手参考:
44
+ * https://github.com/wechat-group/weixin-java-mp-demo (公众号Demo,使用Spring MVC实现)
45
+ * https://github.com/wechat-group/weixin-java-mp-multi-demo (支持多公众号)
46
+ * https://github.com/wechat-group/weixin-java-tools-springmvc (公众号Demo,内含部分微信支付代码)
47
+ * https://github.com/wechat-group/weixin-java-mp-demo-springboot (公众号Demo,使用Spring Boot实现)
48
+ * https://github.com/wechat-group/weixin-java-cp-demo (企业号demo,筹备中)
49
+ * https://github.com/wechat-group/weixin-java-pay-demo (微信支付demo,完善中)
50
+
51
+ ---------------------------------
52
+ ## Maven & Gradle 最新正式版本
34
53
35
- * 公众号(订阅号、服务号 ):
54
+ * 公众号(订阅号、服务号及微信支付 ):
36
55
37
56
maven:
38
57
``` xml
39
58
<dependency >
40
59
<groupId >com.github.binarywang</groupId >
41
60
<artifactId >weixin-java-mp</artifactId >
42
- <version >2.4 .0</version >
61
+ <version >2.5 .0</version >
43
62
</dependency >
44
63
```
45
64
gradle:
46
65
``` groovy
47
- compile 'com.github.binarywang:weixin-java-mp:2.4 .0'
66
+ compile 'com.github.binarywang:weixin-java-mp:2.5 .0'
48
67
```
49
68
50
69
* 企业号:
@@ -54,60 +73,11 @@ maven:
54
73
<dependency >
55
74
<groupId >com.github.binarywang</groupId >
56
75
<artifactId >weixin-java-cp</artifactId >
57
- <version >2.4 .0</version >
76
+ <version >2.5 .0</version >
58
77
</dependency >
59
78
```
60
79
gradle:
61
80
``` groovy
62
- compile 'com.github.binarywang:weixin-java-cp:2.4 .0'
81
+ compile 'com.github.binarywang:weixin-java-cp:2.5 .0'
63
82
```
64
83
65
- ===========
66
-
67
- #### 本项目主要存放在github上,地址为 :
68
- * https://github.com/wechat-group/weixin-java-tools
69
- * ===========但同时会在其他几个网站同步更新,地址分别是:
70
- * https://bitbucket.org/binarywang/weixin-java-tools
71
- * http://git.oschina.net/binary/weixin-java-tools
72
- * https://git.coding.net/binarywang/weixin-java-tools.git
73
-
74
- ===========
75
- ## 可参考的Demo项目
76
- #### 目前都是公众号的,风格不同,欢迎提供更多的demo供新手参考:
77
- 1 . https://github.com/wechat-group/weixin-mp-demo
78
- 1 . https://github.com/wechat-group/weixin-mp-multi-demo (支持多公众号)
79
- 1 . https://github.com/wechat-group/weixin-java-tools-springmvc
80
- 1 . https://github.com/wechat-group/weixin-mp-demo-springboot
81
-
82
-
83
- ===========
84
- ## 关于代码贡献
85
- 1 . 非常欢迎和感谢对本项目发起Pull Request的同学,本项目代码风格为使用2个空格代表一个Tab,因此在提交代码时请注意一下,否则很容易在IDE格式化代码后与原代码产生大量diff,这样会给其他人阅读代码带来极大的困扰。
86
- 1 . 为了便于设置,本项目引入editorconfig插件,请使用eclipse的同学在贡献代码前安装相关插件,IntelliJ IDEA则自带支持,无需额外安装插件。
87
- 1 . 本项目可以采用两种方式接受代码贡献:
88
- * 第一种就是基于[ Git Flow] ( https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow ) 开发流程,因此在发起Pull Request的时候请选择develop分支,详细步骤参考后文。
89
- * 另外一种贡献代码的方式就是加入SDK Developers开发组,前提是对自己的代码足够自信就可以申请加入,加入之后可以随时直接提交代码,但要注意对所做的修改或新增的代码进行单元测试,保证提交代码没有明显问题,具体加入方式,请咨询QQ群管理员[ ![ 点击这里给我发消息] ( http://wpa.qq.com/pa?p=2:1211415707:51 )] ( http://wpa.qq.com/msgrd?v=3&uin=1211415707&site=qq&menu=yes ) 。
90
-
91
- ## PR方式贡献代码步骤
92
- * 在 GitHub 上 ` fork ` 到自己的仓库,如 ` my_user/weixin-java-tools ` ,然后 ` clone ` 到本地,并设置用户信息。
93
- ```
94
- $ git clone [email protected] :my_user/weixin-java-tools.git
95
- $ cd weixin-java-tools
96
- $ git config user.name "yourname"
97
- $ git config user.email "your email"
98
- ```
99
- * 修改代码后提交,并推送到自己的仓库。
100
- ```
101
- $ #do some change on the content
102
- $ git commit -am "Fix issue #1: change something"
103
- $ git push
104
- ```
105
- * 在 GitHub 网站上提交 Pull Request。
106
- * 定期使用项目仓库内容更新自己仓库内容。
107
- ```
108
- $ git remote add upstream https://github.com/wechat-group/weixin-java-tools
109
- $ git fetch upstream
110
- $ git checkout develop
111
- $ git rebase upstream/develop
112
- $ git push -f origin develop
113
- ```
0 commit comments