weixin-java-tools/README.md

82 lines
5.1 KiB
Markdown
Raw Normal View History

2016-07-29 10:03:29 +08:00
# Weixin Java Tools 微信公众号/企业号开发Java SDK
2016-09-21 11:17:45 +08:00
## [![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badge/) ![Maven Central](https://img.shields.io/maven-central/v/com.github.binarywang/weixin-java-parent.svg) [![Build Status](https://travis-ci.org/wechat-group/weixin-java-tools.svg?branch=develop)](https://travis-ci.org/wechat-group/weixin-java-tools)
2016-07-07 09:20:57 +08:00
2015-02-12 09:42:52 +08:00
2016-09-27 20:06:47 +08:00
### 注意:
1. ***本项目Fork自chanjarster/weixin-java-tools但由于原项目已停止维护故单独维护和发布且发布到maven上的groupId也会不同详细信息见下文。***
2016-09-30 17:35:04 +08:00
1. ***自2.0.0版本以来,公众号的接口调整比较大,主要是为了解决主接口类过于庞大不方便管理的问题,将接口实现代码按模块进行拆分。***
2016-10-18 00:13:53 +08:00
1. 本SDK要求的最低JDK版本是7为满足少量还在使用JDK6的用户的需求特意抽出独立的代码分支项目请参考 https://github.com/binarywang/weixin-java-tools-for-jdk6 其他更早的JDK版本则需要自己改造实现
2016-09-30 16:56:40 +08:00
1. 最新更新2016-09-30 发布2.2.0正式版!
2016-08-09 09:59:41 +08:00
===========
2016-09-28 10:09:40 +08:00
## 开发交流方式:
1. ***入群须知为保证入群成员质量请申请入群前先Star本项目然后在申请入群时输入您的Github帐号ID以便管理员核对ID即你的github主页地址https://github.com/XXXX 中最后的部分XXXX的内容或者在github网页右上角点击头像后查看Signed in as后方内容。***
1. QQ群343954419 [![Join QQ Group](http://pub.idqqimg.com/wpa/images/group.png)](http://shang.qq.com/wpa/qunwpa?idkey=078f7a153d243853e24cf2b542e7a6ccbf2a592bc138080f84d11297f736ec46)
2016-09-28 10:11:26 +08:00
1. 微信群: 因二维码有时间限制如有想加入微信群的请入QQ群后咨询获取最新入群二维码
1. 有功能需求或由于微信官方接口调整导致的代码问题可以直接提出issue便于讨论追踪问题
2016-09-28 10:09:40 +08:00
1. 详细开发文档请看 [Wiki](https://github.com/wechat-group/weixin-java-tools/wiki)。
2016-09-28 10:11:26 +08:00
2015-11-20 10:07:26 +08:00
===========
2016-07-31 12:36:51 +08:00
## 版本说明
2016-10-07 14:07:22 +08:00
1. 本项目定为每月发布一次正式版版本号格式为X.X.0如2.1.02.2.0等月初或月底发布新版本遇到重大问题需修复会及时提交新版本欢迎大家随时提交Pull Request
2016-10-01 14:51:17 +08:00
1. BUG修复和新特性一般会先发布成小版本作为临时版本如2.0.12.0.2等即尾号不为0以区别于正式版
2016-10-07 14:07:22 +08:00
1. 目前最新版本号为 ![Maven Central](https://img.shields.io/maven-central/v/com.github.binarywang/weixin-java-parent.svg) ,也可以通过访问链接 [【公众号】](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)
2016-09-26 18:43:30 +08:00
分别查看所有最新的版本。
2014-10-22 13:03:19 +08:00
2016-08-30 19:37:10 +08:00
## Maven & Gradle
2014-10-22 13:03:19 +08:00
2016-08-30 19:37:10 +08:00
* 公众号(订阅号、服务号):
2016-09-26 18:43:30 +08:00
maven
2014-10-22 13:03:19 +08:00
```xml
<dependency>
<groupId>com.github.binarywang</groupId>
2014-10-22 13:03:19 +08:00
<artifactId>weixin-java-mp</artifactId>
2016-09-30 16:56:40 +08:00
<version>2.2.0</version>
2014-10-22 13:03:19 +08:00
</dependency>
```
2016-09-26 18:43:30 +08:00
gradle
2016-08-30 19:37:10 +08:00
```groovy
2016-09-30 16:56:40 +08:00
compile 'com.github.binarywang:weixin-java-mp:2.2.0'
2016-08-30 19:37:10 +08:00
```
2014-10-22 13:03:19 +08:00
2016-08-30 19:37:10 +08:00
* 企业号:
2016-09-26 18:43:30 +08:00
maven
2014-10-22 13:03:19 +08:00
```xml
<dependency>
<groupId>com.github.binarywang</groupId>
2014-10-22 13:03:19 +08:00
<artifactId>weixin-java-cp</artifactId>
2016-09-30 16:56:40 +08:00
<version>2.2.0</version>
2014-10-22 13:03:19 +08:00
</dependency>
```
2016-09-26 18:43:30 +08:00
gradle
2016-08-30 19:37:10 +08:00
```groovy
2016-09-30 16:56:40 +08:00
compile 'com.github.binarywang:weixin-java-cp:2.2.0'
2016-08-30 19:37:10 +08:00
```
2016-10-07 14:07:22 +08:00
===========
2016-08-30 19:38:53 +08:00
#### 本项目主要存放在github上地址为 :
* https://github.com/wechat-group/weixin-java-tools
* ===========但同时会在其他几个网站同步更新,地址分别是:
* https://bitbucket.org/binarywang/weixin-java-tools
* http://git.oschina.net/binary/weixin-java-tools
* https://git.coding.net/binarywang/weixin-java-tools.git
2016-10-07 14:07:22 +08:00
===========
2016-10-11 11:27:57 +08:00
## 目前可参考的Demo项目有两个目前都是公众号的风格不同欢迎提供更多的demo供新手参考:
2016-09-26 18:43:30 +08:00
1. https://github.com/wechat-group/weixin-mp-demo
1. https://github.com/wechat-group/weixin-java-tools-springmvc
2016-08-30 19:38:53 +08:00
2016-10-07 14:07:22 +08:00
===========
2016-08-11 09:22:07 +08:00
## 关于代码贡献
2016-10-01 14:51:17 +08:00
1. 非常欢迎和感谢对本项目发起Pull Request的同学本项目代码风格为使用2个空格代表一个Tab因此在提交代码时请注意一下否则很容易在IDE格式化代码后与原代码产生大量diff这样会给其他人阅读代码带来极大的困扰。
1. 为了便于设置本项目引入editorconfig插件请使用eclipse的同学在贡献代码前安装相关插件IntelliJ IDEA则自带支持无需额外安装插件。
1. 本项目可以采用两种方式接受代码贡献:
2015-07-22 08:50:12 +08:00
2016-10-01 14:51:17 +08:00
1. 第一种就是基于[Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)开发流程因此在发起Pull Request的时候请选择develop分支。
1. 另外一种贡献代码的方式就是加入SDK Developers开发组前提是对自己的代码足够自信就可以申请加入加入之后可以随时直接提交代码但要注意对所做的修改或新增的代码进行单元测试保证提交代码没有明显问题具体加入方式请咨询管理员。