mirror of
https://gitee.com/binary/weixin-java-tools.git
synced 2025-05-06 21:57:48 +08:00
Merge branch 'master' into develop
This commit is contained in:
Binary Wang
commit
07e8ffabda
BIN
alipay_qrcode.jpg
Normal file
BIN
alipay_qrcode.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
@ -1,10 +1,11 @@
|
||||
# 代码贡献指南
|
||||
1. 非常欢迎和感谢对本项目发起Pull Request的同学，本项目代码风格为使用2个空格代表一个Tab，因此在提交代码时请注意一下，否则很容易在IDE格式化代码后与原代码产生大量diff，这样会给其他人阅读代码带来极大的困扰。为了便于设置，本项目引入editorconfig插件，请使用eclipse的同学在贡献代码前安装相关插件，IntelliJ IDEA新版本自带支持，如果没有可自行安装插件。
|
||||
1. 首先非常欢迎和感谢对本项目发起Pull Request的同学。
|
||||
1. 本项目代码风格为使用2个空格代表一个Tab，因此在提交代码时请注意一下，否则很容易在IDE格式化代码后与原代码产生大量diff，这样会给其他人阅读代码带来极大的困扰。
|
||||
1. 为了便于设置，本项目引入editorconfig支持，请使用Eclipse的同学在贡献代码前安装相关插件，而IntelliJ IDEA新版本自带支持，如果没有可自行安装插件。
|
||||
1. **提交代码前，请检查代码是否已经格式化，并且保证新增加或者修改的方法都有完整的参数说明，而public方法必须拥有相应的单元测试并通过测试。**
|
||||
1. 本项目可以采用两种方式接受代码贡献：
|
||||
* 第一种就是基于[Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)开发流程，因此在发起Pull Request的时候请选择develop分支，详细步骤参考后文，推荐使用此种方式贡献代码。
|
||||
* （***暂停此种方式，请使用第一种***）另外一种贡献代码的方式就是加入SDK Developers开发组，前提是对自己的代码足够自信就可以申请加入，加入之后可以随时直接提交代码，但要注意对所做的修改或新增的代码进行单元测试，保证提交代码没有明显问题。
|
||||
1. 另外，提交代码前请检查代码是否已经格式化，并且保证新增加或者修改的方法都有完整的参数说明，而public方法必须拥有相应的单元测试并通过测试。
|
||||
|
||||
- 第一种就是基于[Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)开发流程，因此在发起Pull Request的时候请选择develop分支，详细步骤参考后文，推荐使用此种方式贡献代码。
|
||||
- （***暂停此种方式，请使用第一种***）另外一种贡献代码的方式就是加入SDK Developers开发组，前提是对自己的代码足够自信就可以申请加入，加入之后可以随时直接提交代码，但要注意对所做的修改或新增的代码进行单元测试，保证提交代码没有明显问题。
|
||||
|
||||
### PR方式贡献代码步骤
|
||||
* 在 GitHub 上 `fork` 到自己的仓库，如 `my_user/weixin-java-tools`，然后 `clone` 到本地，并设置用户信息。
|
||||
|
||||
44
readme.md
44
readme.md
@ -1,21 +1,33 @@
|
||||
微信支付、公众号&企业号开发Java SDK
|
||||
微信支付、小程序、公众号&企业号开发Java SDK
|
||||
---------------------------------
|
||||
[](https://maven-badges.herokuapp.com/maven-central/com.github.binarywang/weixin-java-parent)
|
||||
[](https://travis-ci.org/Wechat-Group/weixin-java-tools)
|
||||
|
||||
### 注意事项：
|
||||
1. 声明： ***本项目Fork自chanjarster/weixin-java-tools，但由于原项目已停止维护，故单独维护和发布，且发布到maven上的groupId也会不同，详细信息见下文。***
|
||||
1. **新手请注意，本项目仅是一个开发工具包（即SDK），未提供Web实现，建议使用maven或gradle引用本项目即可使用本SDK提供的各种功能，详情可参考下文中提到的Demo项目或本项目中的部分单元测试代码；如果没有贡献代码的意愿，不建议下载项目的源码自行编译，因为如果想看源码使用maven也是可以下载源码的**；
|
||||
#### 声明： ***本项目Fork自chanjarster/weixin-java-tools，但由于原项目已停止维护，故单独维护和发布，且发布到maven上的groupId也会不同，详细信息见下文。***
|
||||
|
||||
***新人提示：本项目仅是一个开发工具包（即SDK），未提供Web实现，建议使用maven或gradle引用本项目即可使用本SDK提供的各种功能，详情可参考下文中提到的Demo项目或本项目中的部分单元测试代码；另外微信开发新手请务必阅读wiki首页的常见问题部分，可以少走很多弯路，节省不少时间。***
|
||||
|
||||
## Demo项目列表
|
||||
* https://github.com/wechat-group/weixin-java-miniapp-demo （微信小程序Demo）
|
||||
* https://github.com/wechat-group/weixin-java-pay-demo （微信支付Demo）
|
||||
* https://github.com/wechat-group/weixin-java-cp-demo （企业号Demo）
|
||||
* https://github.com/wechat-group/weixin-java-mp-demo （公众号Demo，使用Spring MVC实现）
|
||||
* https://github.com/wechat-group/weixin-java-mp-demo-springboot （公众号Demo，使用Spring Boot实现）
|
||||
* https://github.com/wechat-group/weixin-java-tools-springmvc （公众号Demo，内含部分微信支付代码）
|
||||
* https://github.com/wechat-group/weixin-java-mp-multi-demo (支持多公众号)
|
||||
|
||||
---------------------------------
|
||||
### 其他信息：
|
||||
1. 最新更新：**2017-4-13 发布[【2.6.0正式版】](https://github.com/Wechat-Group/weixin-java-tools/releases)**！
|
||||
1. 开源中国网站的本项目介绍的首页链接地址：https://www.oschina.net/p/weixin-java-tools-new
|
||||
1. 自2.0.0版本以来，公众号的接口调整比较大，主要是为了解决主接口类过于庞大不方便管理的问题，将接口实现代码按模块进行拆分。
|
||||
1. 自2.6.0版本开始，微信支付相关功能抽出独立为一个模块，详细使用方式请参考相关demo；
|
||||
1. SDK详细开发文档请查阅 [【Wiki】](https://github.com/wechat-group/weixin-java-tools/wiki)，部分文档可能未能及时更新，如有发现，可以及时上报或者自行修改。***另外微信开发新手请务必阅读wiki首页的常见问题部分，可以少走很多弯路，节省不少时间。***
|
||||
1. SDK详细开发文档请查阅 [【Wiki】](https://github.com/wechat-group/weixin-java-tools/wiki)，部分文档可能未能及时更新，如有发现，可以及时上报或者自行修改。
|
||||
1. 各个模块的Javadoc可以在线查看（有可能是最新的测试版本的，请注意观察版本号）：[weixin-java-pay](https://binarywang.github.io/weixin-java-pay-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/)
|
||||
1. 本SDK要求的最低JDK版本是7，还在使用JDK6的用户请参考[【此项目】]( https://github.com/binarywang/weixin-java-tools-for-jdk6) ，而其他更早的JDK版本则需要自己改造实现。
|
||||
1. 如有新功能需求，发现BUG，或者由于微信官方接口调整导致的代码问题，可以直接在[【Issues】](https://github.com/Wechat-Group/weixin-java-tools/issues)页提出issue，便于讨论追踪问题；
|
||||
1. 如果想贡献代码，请阅读[【代码贡献指南】](contribution.md)；
|
||||
1. 捐助渠道已开通，如有意向请前往托管于码云的项目首页（具体地址见下文）的页面评论区上方，可以找到“捐助”按钮，非常感谢各位捐助的同学！
|
||||
1. **捐助渠道已开通，如有意向请点击[【支付宝二维码】](alipay_qrcode.jpg)捐赠，或者直接前往[【托管于码云的项目首页】](http://git.oschina.net/binary/weixin-java-tools)，在评论区上方可以找到“捐助”按钮。非常感谢各位捐助的同学！**
|
||||
|
||||
---------------------------------
|
||||
## SDK使用交流方式说明：
|
||||
@ -39,19 +51,19 @@
|
||||
* Bitbucket：https://bitbucket.org/binarywang/weixin-java-tools
|
||||
* Coding: https://git.coding.net/binarywang/weixin-java-tools.git
|
||||
|
||||
---------------------------------
|
||||
## 可参考的Demo项目
|
||||
#### 欢迎提供更多的Demo供新手参考:
|
||||
* https://github.com/wechat-group/weixin-java-pay-demo （微信支付Demo）
|
||||
* https://github.com/wechat-group/weixin-java-cp-demo （企业号Demo）
|
||||
* https://github.com/wechat-group/weixin-java-mp-demo （公众号Demo，使用Spring MVC实现）
|
||||
* https://github.com/wechat-group/weixin-java-mp-demo-springboot （公众号Demo，使用Spring Boot实现）
|
||||
* https://github.com/wechat-group/weixin-java-tools-springmvc （公众号Demo，内含部分微信支付代码）
|
||||
* https://github.com/wechat-group/weixin-java-mp-multi-demo (支持多公众号)
|
||||
|
||||
---------------------------------
|
||||
## Maven 最新正式版本
|
||||
|
||||
* 微信小程序（暂时为测试版本）：
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>com.github.binarywang</groupId>
|
||||
<artifactId>weixin-java-miniapp</artifactId>
|
||||
<version>2.6.5.BETA</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
* 微信支付：
|
||||
|
||||
```xml
|
||||
|
||||
Loading…
Reference in New Issue
Block a user