Skip to content

Commit 606bf3a

Browse files
committed
新增 WxJava 用户技能指南
1 parent 4feb71e commit 606bf3a

15 files changed

Lines changed: 123 additions & 0 deletions

File tree

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: wxjava-api-contributor
3+
description: 按 WxJava 的 Maven 多模块、Java 8、公共 API 兼容性和 TestNG 约定,为微信官方接口新增或维护 SDK 支持。适用于新增 Service API、请求响应 Bean、序列化、HTTP 实现、Starter 配置或回归测试时。
4+
---
5+
6+
# WxJava 接口贡献
7+
8+
1. 确认微信产品和目标模块,阅读对应 README、POM、相似接口、实现与测试。
9+
2. 读取 [贡献约定](references/contribution.md),将官方接口契约映射到 Service、实现、Bean、URL、序列化和测试。
10+
3. 只做完成需求所需的最小改动;更新必要 Javadoc、测试与用户可见文档。
11+
4. 执行 `mvn -pl <module> -am test`,并检查 `git diff --check`
12+
13+
保持 Java 8 与公共 API、异常语义、JSON/XML 字段兼容性。涉及多 HTTP 客户端、单/多账号 Starter 或 Solon 插件时,检查等价实现是否需要同步。
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "WxJava 接口贡献"
3+
short_description: "按 WxJava 项目约定新增或维护 SDK 接口能力"
4+
default_prompt: "使用 $wxjava-api-contributor 为 WxJava 新增微信接口支持。"
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 贡献约定
2+
3+
以微信官方接口定义和本仓库同类实现为准,核对路径、方法、字段名、必填项和响应结构。优先复用既有 HTTP 执行器、异常、配置、Gson/Jackson/XStream 映射和 TestNG 测试模式。
4+
5+
公共方法需要准确 Javadoc。不要吞异常、记录敏感值或无关重构。新增公开方法和 bug 修复均应有针对性测试;涉及公共模块、BOM 或多模块时扩大验证范围。
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: wxjava-integration-guide
3+
description: 为 Java、Spring Boot 或 Solon 项目生成可验证的 WxJava 接入方案,包括模块选择、BOM、配置、最小调用代码以及单/多账号集成。适用于用户要求接入公众号、小程序、支付、企业微信、开放平台、视频号或微信小店时。
4+
---
5+
6+
# WxJava 接入指南
7+
8+
1. 确认微信产品、框架、单/多账号和首个 API 调用。
9+
2. 读取 [接入约束](references/integration.md),选择模块和配置方式。
10+
3. 输出可复制的依赖、脱敏配置和最小服务端代码;凭据一律用占位符。
11+
4. 给出本地验证步骤与安全提醒;支付、回调和证书示例不得直接用于生产。
12+
13+
保持 Java 8 兼容。引用已有 Demo 或 README 作为继续阅读入口;不虚构配置键、SDK 方法或版本号。
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "WxJava 接入指南"
3+
short_description: "生成可验证的 WxJava 最小接入方案与配置示例"
4+
default_prompt: "使用 $wxjava-integration-guide 为我的项目生成 WxJava 接入代码。"
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 接入约束
2+
3+
优先通过 `wx-java-bom` 统一管理多个 WxJava 模块版本。核心 SDK 模块是 MP、MiniApp、Pay、CP、Open、Channel;框架集成模块位于 `spring-boot-starters``solon-plugins`
4+
5+
查阅相应模块 README 和 `demo/` 的相邻示例,确认配置属性与初始化模式。所有 `appId``secret`、商户私钥、API v3 密钥和证书均使用占位符,不得输出到日志。
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: wxjava-module-selector
3+
description: 根据微信公众号、小程序、微信支付、企业微信、开放平台、视频号或微信小店等业务场景,为用户选择合适的 WxJava Maven 模块、BOM 和示例入口。适用于用户询问“该用哪个模块”、依赖坐标、产品边界或单/多账号 Starter 选择时。
4+
---
5+
6+
# WxJava 模块选择
7+
8+
1. 识别微信产品、服务端框架和是否需要多账号;信息不足时只询问必要问题。
9+
2. 读取 [模块映射](references/modules.md),给出一个主推荐,以及组合模块的理由。
10+
3. 优先推荐 BOM;给出准确的 `groupId``artifactId` 和相应 Demo 或 README。
11+
4. 说明服务端 SDK 的边界:移动端登录、分享等能力仍需微信官方客户端 SDK。
12+
5. 不臆测版本号;建议以 Maven Central 或项目 README 的当前版本为准。
13+
14+
使用“场景 → 模块 → 依赖 → 下一步”的简短结构。涉及多账号时说明单账号与 multi Starter 的区别;不要在示例中泄露凭据。
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "WxJava 模块选择"
3+
short_description: "按微信业务场景选择 WxJava 模块、依赖与示例"
4+
default_prompt: "使用 $wxjava-module-selector 为我的微信业务选择合适的 WxJava 模块。"
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# WxJava 模块映射
2+
3+
| 场景 | 核心模块 |
4+
| --- | --- |
5+
| 微信公众号 | `weixin-java-mp` |
6+
| 微信小程序 | `weixin-java-miniapp` |
7+
| 微信支付 | `weixin-java-pay` |
8+
| 企业微信 | `weixin-java-cp` |
9+
| 微信开放平台/第三方平台 | `weixin-java-open` |
10+
| 视频号/微信小店 | `weixin-java-channel` |
11+
12+
多个模块并用时优先使用 `com.github.binarywang:wx-java-bom`。Spring Boot 集成从 `spring-boot-starters` 选择;Solon 集成从 `solon-plugins` 选择。只有多个独立微信应用配置时才选择名称含 `multi` 的 Starter 或插件。
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: wxjava-troubleshooter
3+
description: 排查 WxJava 在配置初始化、access token、签名验签、支付证书、回调通知、序列化、网络请求和多账号隔离方面的问题。适用于用户提供异常、日志、请求响应或“WxJava 为什么不能调用”的场景。
4+
---
5+
6+
# WxJava 故障排查
7+
8+
1. 收集最小复现:产品模块、SDK 版本、JDK、框架、异常堆栈及脱敏后的配置形状。
9+
2. 依据 [诊断清单](references/diagnostics.md),按配置、请求契约、认证材料、网络与回调顺序验证。
10+
3. 每次只提出一个可验证根因,给出最小修复和验证动作。
11+
4. 签名、支付、回调和加密场景须核对编码、字段排序、金额精度、时间戳、证书链和重放保护。
12+
13+
要求遮蔽 secret、token、私钥、证书、签名原文和个人数据。不要建议关闭 TLS 校验或验签;区分已证实结论与待验证假设。

0 commit comments

Comments
 (0)