From a62cf873df808acf17333c7217408efdf793a75b Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Thu, 5 Mar 2026 12:21:03 +0800 Subject: [PATCH] docs: apply B2 README restructure with quick-start and module matrix --- README.md | 402 ++++++++++++++++++++++++++---------------------------- 1 file changed, 192 insertions(+), 210 deletions(-) diff --git a/README.md b/README.md index ab1d82352..5d729d322 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,198 @@ [![使用IntelliJ IDEA开发维护](https://img.shields.io/badge/IntelliJ%20IDEA-支持-blue.svg)](https://www.jetbrains.com/?from=WxJava-weixin-java-tools) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -
- - Featured｜HelloGitHub - - - binarywang%2FWxJava | 趋势转变 - -
+### 微信 `Java` 开发工具包，支持微信支付、开放平台、公众号、企业微信、视频号、小程序等后端开发。 + +--- + +### 目录 +- [快速开始（3分钟）](#快速开始3分钟) +- [我该选哪个模块？](#我该选哪个模块) +- [安装与版本](#安装与版本) +- [最小示例](#最小示例) +- [HTTP 客户端支持](#http-客户端支持) +- [FAQ（提问前必读）](#faq提问前必读) +- [社区与支持](#社区与支持) +- [贡献方式](#贡献方式) +- [版本说明](#版本说明) +- [应用案例](#应用案例) +- [赞助与致谢](#赞助与致谢) + +--- + +### 快速开始（3分钟） +1. 根据业务场景选择模块（见下方“我该选哪个模块？”） +2. 引入 Maven 依赖并使用最新稳定版本 +3. 参考最小示例初始化 `Service` 并调用 API + +--- + +### 我该选哪个模块？ + +| 业务场景 | 模块 | artifactId | +|---|---|---| +| 微信公众号开发 | MP | `weixin-java-mp` | +| 微信小程序开发 | MiniApp | `weixin-java-miniapp` | +| 微信支付 | Pay | `weixin-java-pay` | +| 企业微信 | CP | `weixin-java-cp` | +| 微信开放平台（第三方平台） | Open | `weixin-java-open` | +| 视频号 / 微信小店 | Channel | `weixin-java-channel` | + +> 移动端（iOS/Android）微信登录、分享等能力仍需集成微信官方客户端 SDK；本项目为服务端 SDK。 + +--- + +### 安装与版本 + +最新版本（含测试版）请查看： +[![Maven Central](https://img.shields.io/maven-central/v/com.github.binarywang/wx-java.svg)](https://central.sonatype.com/artifact/com.github.binarywang/wx-java/versions) + +```xml + + com.github.binarywang + （按模块选择） + 4.8.0 + +``` + +常用模块： +- 微信小程序：`weixin-java-miniapp` +- 微信支付：`weixin-java-pay` +- 微信开放平台：`weixin-java-open` +- 微信公众号：`weixin-java-mp` +- 企业微信：`weixin-java-cp` +- 微信视频号/微信小店：`weixin-java-channel` + +--- + +### 最小示例 + +
+公众号（MP）示例：获取 AccessToken + +```java +WxMpDefaultConfigImpl config = new WxMpDefaultConfigImpl(); +config.setAppId("your-app-id"); +config.setSecret("your-secret"); + +WxMpService wxMpService = new WxMpServiceImpl(); +wxMpService.setWxMpConfigStorage(config); + +String accessToken = wxMpService.getAccessToken(); +System.out.println(accessToken); +``` + +
+ +
+小程序（MiniApp）示例：code2Session + +```java +WxMaDefaultConfigImpl config = new WxMaDefaultConfigImpl(); +config.setAppid("your-app-id"); +config.setSecret("your-secret"); + +WxMaService wxMaService = new WxMaServiceImpl(); +wxMaService.setWxMaConfig(config); + +WxMaJscode2SessionResult result = wxMaService.getUserService().getSessionInfo("js-code"); +System.out.println(result.getOpenid()); +``` + +
+ +--- + +### HTTP 客户端支持 + +本项目支持多种 HTTP 客户端，默认推荐 **Apache HttpClient 5.x**。 + +| HTTP 客户端 | 说明 | 配置值 | 推荐程度 | +|------------|------|--------|---------| +| Apache HttpClient 5.x | Apache HttpComponents Client 5.x，最新版本 | `HttpComponents` | ⭐⭐⭐⭐⭐ 推荐 | +| Apache HttpClient 4.x | Apache HttpClient 4.x，向后兼容 | `HttpClient` | ⭐⭐⭐⭐ 兼容 | +| OkHttp | Square OkHttp 客户端 | `OkHttp` | ⭐⭐⭐ 可选 | +| Jodd-http | Jodd 轻量级 HTTP 客户端 | `JoddHttp` | ⭐⭐ 可选 | + +```properties +# 使用 HttpClient 5.x（推荐，MP/MiniApp/CP/Channel/QiDian 模块默认） +wx.mp.config-storage.http-client-type=HttpComponents + +# 使用 HttpClient 4.x（兼容模式） +wx.mp.config-storage.http-client-type=HttpClient + +# 使用 OkHttp +wx.mp.config-storage.http-client-type=OkHttp + +# 使用 Jodd-http +wx.mp.config-storage.http-client-type=JoddHttp +``` + +Multi-Starter（如 `wx-java-mp-multi-spring-boot-starter`）请使用大写下划线格式： + +```properties +wx.mp.config-storage.http-client-type=HTTP_COMPONENTS +``` + +--- + +### FAQ（提问前必读） +- 本项目是 SDK，不提供 Web 实现，建议直接通过 Maven/Gradle 引入并参考 [Demo](demo.md)。 +- 新手请先阅读 [开发文档 Wiki](https://github.com/binarywang/WxJava/wiki) / [Gitee Wiki](https://gitee.com/binary/weixin-java-tools/wikis/Home)。 +- 提问前建议先看 [提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md)。 +- 贴长代码或异常日志建议使用 http://paste.ubuntu.com 。 + +--- + +### 社区与支持 +- 技术交流群：关注公众号 `WxJava`（或搜索 `weixin-java-tools`）后通过菜单获取最新加群方式。 +- 钉钉技术交流群：`32206329`（技术交流2群）、`30294972`（技术交流1群，已满）、`35724728`（通知群）。 +- 问题反馈与需求建议：请在 [Issues](https://github.com/binarywang/WxJava/issues) 提交。 + +--- + +### 贡献方式 +- 提交 PR 前请先阅读 [代码贡献指南](CONTRIBUTING.md)。 +- 贡献源码可参考视频： + - [贡献源码全过程（上集）](https://mp.weixin.qq.com/s/3xUZSATWwHR_gZZm207h7Q) + - [贡献源码全过程（下集）](https://mp.weixin.qq.com/s/nyzJwVVoYSJ4hSbwyvTx9A) + +--- + +### 版本说明 +1. 正式版通常约半年发布一次，重大问题会及时发版； +2. 日常更新会构建尝鲜版本（`x.x.x-时间戳`）； +3. 正式版发布时 `develop` 合并到 `release`，版本号一般为 `X.X.0`； +4. 测试版本（如 `3.6.8.B`）仅存在于 `develop` 分支； +5. 各模块版本： +[微信支付](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-pay/versions)、[小程序](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-miniapp/versions)、[公众号](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-mp/versions)、[企业微信](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-cp/versions)、[开放平台](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-open/versions)、[视频号](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-channel/versions) + +--- + +### 应用案例 +完整案例登记列表请见 [Issue #729](https://github.com/binarywang/WxJava/issues/729)。 + +
+节选案例（点击展开） + +#### 开源项目 +- Jeepay 支付系统：https://gitee.com/jeequan/jeepay +- 微信点餐系统：https://github.com/sqmax/springboot-project +- WePush：https://github.com/rememberber/WePush +- 基于若依开发的公众号管理系统：https://gitee.com/joolun/JooLun-wx +- mall4j 电商商城系统：https://gitee.com/gz-yami/mall4j + +#### 企业用户（节选） +- 中国电信上海网厅（公众号） +- HTC 企业微信 +- 锐捷网络：Saleslink + +
+ +--- + +### 赞助与致谢 -### 微信`Java`开发工具包，支持包括微信支付、开放平台、公众号、企业微信、视频号、小程序等微信功能模块的后端开发。
特别赞助 @@ -41,211 +223,11 @@ - - - - -
- - mp qrcode - - - 赞助商招募中 - - - ad - -
-### 重要信息 -1. [`WxJava` 荣获 `GitCode` 2024年度十大开源社区奖项](https://mp.weixin.qq.com/s/wM_UlMsDm3IZ1CPPDvcvQw)。 -2. 项目合作洽谈请联系微信`binary0000`（在微信里自行搜索并添加好友，请注明来意，如有关于SDK问题需讨论请参考下文入群讨论，不要加此微信）。 -3. **2026-01-03 发布 [【4.8.0正式版】](https://mp.weixin.qq.com/s/mJoFtGc25pXCn3uZRh6Q-w)**！ -5. 贡献源码可以参考视频：[【贡献源码全过程（上集）】](https://mp.weixin.qq.com/s/3xUZSATWwHR_gZZm207h7Q)、[【贡献源码全过程（下集）】](https://mp.weixin.qq.com/s/nyzJwVVoYSJ4hSbwyvTx9A) ，友情提供：[程序员小山与Bug](https://space.bilibili.com/473631007) -6. 新手重要提示：本项目仅是一个SDK开发工具包，未提供Web实现，建议使用 `maven` 或 `gradle` 引用本项目即可使用本SDK提供的各种功能，详情可参考 **[【Demo项目】](demo.md)** 或本项目中的部分单元测试代码； -7. 微信开发新手请务必阅读【开发文档】（[Gitee Wiki](https://gitee.com/binary/weixin-java-tools/wikis/Home) 或者 [Github Wiki](https://github.com/binarywang/WxJava/wiki)）的常见问题部分，可以少走很多弯路，节省不少时间。 -8. 技术交流群：想获得QQ群/微信群/钉钉企业群等信息的同学，请使用微信扫描上面的微信公众号二维码关注 `WxJava` 后点击相关菜单即可获取加入方式，同时也可以在微信中搜索 `weixin-java-tools` 或 `WxJava` 后选择正确的公众号进行关注，该公众号会及时通知SDK相关更新信息，并不定期分享微信Java开发相关技术知识； -9. 钉钉技术交流群：`32206329`（技术交流2群）, `30294972`（技术交流1群，目前已满），`35724728`（通知群，实时通知Github项目变更记录）。 -10. 微信开发新手或者Java开发新手在群内提问或新开Issue提问前，请先阅读[【提问的智慧】](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md)，并确保已查阅过 [【开发文档Wiki】](https://github.com/binarywang/WxJava/wiki) ，避免浪费大家的宝贵时间； -11. 寻求帮助时需贴代码或大长串异常信息的，请利用 http://paste.ubuntu.com - --------------------------------- -### 其他说明 -1. **阅读源码的同学请注意，本SDK为简化代码编译时加入了`lombok`支持，如果不了解`lombok`的话，请先学习下相关知识，比如可以阅读[此文章](https://mp.weixin.qq.com/s/cUc-bUcprycADfNepnSwZQ)；** -2. 如有新功能需求，发现BUG，或者由于微信官方接口调整导致的代码问题，可以直接在[【Issues】](https://github.com/binarywang/WxJava/issues)页提出issue，便于讨论追踪问题； -3. 如果需要贡献代码，请务必在提交PR之前先仔细阅读[【代码贡献指南】](CONTRIBUTING.md)，谢谢理解配合； -4. 目前本`SDK`最新版本要求的`JDK`最低版本是`8`，使用`7`的同学可以使用`WxJava` `3.8.0`及以前版本，而还在使用`JDK`6的用户请参考[【此项目】]( https://github.com/binarywang/weixin-java-tools-for-jdk6) ，而其他更早的JDK版本则需要自己改造实现。 -5. [本项目在开源中国的页面](https://www.oschina.net/p/weixin-java-tools-new)，欢迎大家积极留言评分 🙂 -6. SDK开发文档请查阅 [【开发文档Wiki】](https://github.com/binarywang/WxJava/wiki)，部分文档可能未能及时更新，如有发现，可以及时上报或者自行修改。 -7. **如果本开发工具包对您有所帮助，欢迎对我们的努力进行肯定，可以直接前往[【托管于码云的项目首页】](http://gitee.com/binary/weixin-java-tools)，在页尾部分找到“捐助”按钮进行打赏，多多益善 😄。非常感谢各位打赏和捐助的同学！** -8. 各个模块的Javadoc可以在线查看：[weixin-java-miniapp](http://binary.ac.cn/weixin-java-miniapp-javadoc/)、[weixin-java-pay](http://binary.ac.cn/weixin-java-pay-javadoc/)、[weixin-java-mp](http://binary.ac.cn/weixin-java-mp-javadoc/)、[weixin-java-common](http://binary.ac.cn/weixin-java-common-javadoc/)、[weixin-java-cp](http://binary.ac.cn/weixin-java-cp-javadoc/)、[weixin-java-open](http://binary.ac.cn/weixin-java-open-javadoc/) -9. 本SDK项目在以下代码托管网站同步更新: -* 码云：https://gitee.com/binary/weixin-java-tools -* GitHub：https://github.com/binarywang/WxJava - ---------------------------------- -### Maven 引用方式 -注意：最新版本（包括测试版）为 [![Maven Central](https://img.shields.io/maven-central/v/com.github.binarywang/wx-java.svg)](https://central.sonatype.com/artifact/com.github.binarywang/wx-java/versions)，以下为最新正式版。 - -```xml - - com.github.binarywang - （不同模块参考下文） - 4.8.0 - -``` - - - 微信小程序：`weixin-java-miniapp` - - 微信支付：`weixin-java-pay` - - 微信开放平台：`weixin-java-open` - - 微信公众号：`weixin-java-mp` - - 企业微信：`weixin-java-cp` - - 微信视频号/微信小店：`weixin-java-channel` - -**注意**： -- **移动应用开发**：如果你的移动应用（iOS/Android App）需要接入微信登录、分享等功能： - - 微信登录（网页授权）：使用 `weixin-java-open` 模块，在服务端处理 OAuth 授权 - - 微信支付：使用 `weixin-java-pay` 模块 - - 客户端集成：需使用微信官方提供的移动端SDK（iOS/Android），本项目为服务端SDK -- **微信开放平台**（`weixin-java-open`）主要用于第三方平台，代公众号或小程序进行开发和管理 - - ---------------------------------- -### HTTP 客户端支持 - -本项目同时支持多种 HTTP 客户端实现，默认推荐使用 **Apache HttpClient 5.x**（最新稳定版本）。 - -#### 支持的 HTTP 客户端类型 - -| HTTP 客户端 | 说明 | 配置值 | 推荐程度 | -|------------|------|--------|---------| -| Apache HttpClient 5.x | Apache HttpComponents Client 5.x，最新版本 | `HttpComponents` | ⭐⭐⭐⭐⭐ 推荐 | -| Apache HttpClient 4.x | Apache HttpClient 4.x，向后兼容 | `HttpClient` | ⭐⭐⭐⭐ 兼容 | -| OkHttp | Square OkHttp 客户端 | `OkHttp` | ⭐⭐⭐ 可选 | -| Jodd-http | Jodd 轻量级 HTTP 客户端 | `JoddHttp` | ⭐⭐ 可选 | - -#### 配置方式 - -**Spring Boot 配置示例：** - -```properties -# 使用 HttpClient 5.x（推荐，MP/MiniApp/CP/Channel/QiDian 模块默认） -wx.mp.config-storage.http-client-type=HttpComponents - -# 使用 HttpClient 4.x（兼容模式） -wx.mp.config-storage.http-client-type=HttpClient - -# 使用 OkHttp -wx.mp.config-storage.http-client-type=OkHttp - -# 使用 Jodd-http -wx.mp.config-storage.http-client-type=JoddHttp -``` - -**注意**：如果使用 Multi-Starter（如 `wx-java-mp-multi-spring-boot-starter`），枚举值需使用大写下划线格式： -```properties -# Multi-Starter 配置格式 -wx.mp.config-storage.http-client-type=HTTP_COMPONENTS # 注意使用大写下划线 -``` - -**注意事项：** -1. **MP、MiniApp、Channel、QiDian 模块**已完整支持 HttpClient 5.x，默认推荐使用 -2. **CP 模块**的支持情况取决于具体使用的 Starter 版本，请参考对应模块文档 -3. 如需使用 OkHttp 或 Jodd-http，需在项目中添加对应的依赖（scope为provided） -4. HttpClient 4.x 和 HttpClient 5.x 可以共存，按需配置即可 - - ---------------------------------- -### 版本说明 - -
-点此展开查看 - -1. 本项目定为大约每半年左右发布一次正式版，遇到重大问题需修复会及时提交新版本，欢迎大家随时提交 `Pull Request`； -2. 每次代码更新都会自动构建出新版本方便及时尝鲜，版本号格式为 `x.x.x-时间戳`; -3. 发布正式版时，`develop` 分支代码合并进入 `release` 分支），版本号格式为 `X.X.0`（如`2.1.0`，`2.2.0`等）； -4. 每隔一段时间后，会发布测试版本（如`3.6.8.B`，即尾号不为0，并添加B，以区别于正式版），代码仅存在于 `develop` 分支中； -5. 目前最新版本号为 [![Maven Central](https://img.shields.io/maven-central/v/com.github.binarywang/wx-java.svg)](http://mvnrepository.com/artifact/com.github.binarywang/wx-java) ，也可以通过访问以下链接分别查看各个模块最新的版本： -[【微信支付】](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-pay/versions) 、[【小程序】](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-miniapp/versions) 、[【公众号】](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-mp/versions) 、[【企业微信】](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-cp/versions)、[【开放平台】](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-open/versions)、[【视频号】](https://central.sonatype.com/artifact/com.github.binarywang/weixin-java-channel/versions) - - -
- ----------------------------------- -### 应用案例 -完整案例登记列表，请[【访问这里】](https://github.com/binarywang/WxJava/issues/729)查看，欢迎登记更多的案例。 - -
-以下为节选的部分案例， 点此展开查看 - -#### 开源项目： -- 基于微信公众号的签到、抽奖、发送弹幕程序：https://github.com/workcheng/weiya -- Jeepay 支付系统：https://gitee.com/jeequan/jeepay -- 微同商城：https://gitee.com/fuyang_lipengjun/platform -- 微信点餐系统：https://github.com/sqmax/springboot-project -- 专注批量推送的小而美的工具：https://github.com/rememberber/WePush -- yshop意象商城系统：https://gitee.com/guchengwuyue/yshopmall -- wx-manage（微信公众号管理项目）：https://github.com/niefy/wx-manage -- 基于若依开发的微信公众号管理系统：https://gitee.com/joolun/JooLun-wx -- SAAS微信小程序电商：https://gitee.com/wei-it/weiit-saas -- mall4j 电商商城系统：https://gitee.com/gz-yami/mall4j - -#### 小程序： -- （京东）友家铺子，友家铺子店长版，京粉精选 -- [喵星人贴吧助手(扫码关注)](http://p98ahz3tg.bkt.clouddn.com/miniappqrcode.jpg) -- 树懒揽书+ -- 广廉快线，鹏城巴士等 -- 当燃挑战、sportlight轻灵运动 -- 360考试宝典 -- 民医台 -- 来一团商家版 -- 史必达（史丹利） -- 嘀嗒云印 -- 维沃吼吼 -- 王朝社区（比亚迪新能源社区） -- 极吼吼手机上门回收换新 -- 未来信封 -- 5G惠享 -- 生菜wordpress转小程序 -- 丽日购 - -#### 公众号： -- 中国电信上海网厅（sh_189） -- E答平台 -- 宁夏生鲜365 -- 通服货滴 -- 神龙养车 -- 沃音乐商务智能 -- 光环云社群 -- 手机排队 -- [全民约跑健身便利店](http://www.oneminsport.com/) -- 民医台 -- YshopMall -- 好行景区直通车以及全国40多个公众号 -- 我奥篮球公众号 -- 未来信封官微 -- 银川智云问诊 -- 5G惠享 - -#### 企业微信： -- HTC企业微信 -- 掌上史丹利 -- 药店益 - -#### 其他： -- 高善人力资源 -- 小猪餐餐 -- 餐饮系统 -- 微信公众号管理系统：http://demo.joolun.com -- 锐捷网络：Saleslink - -
- ----------------------------------- ### 贡献者列表 -特别感谢参与贡献的所有同学，所有贡献者列表请在[此处](https://github.com/binarywang/WxJava/graphs/contributors)查看，欢迎大家继续踊跃贡献代码！ +特别感谢参与贡献的所有同学，完整列表见 [contributors](https://github.com/binarywang/WxJava/graphs/contributors)。