WxJava: Instructions file for GitHub Copilot

Copilot Instruction

请始终使用中文生成 Pull Request 的标题、描述和提交信息

WxJava - 微信 Java SDK 开发说明

WxJava 是一个支持多种微信平台的完整 Java SDK，包含公众号、小程序、微信支付、企业微信、开放平台、视频号、企点等多种功能模块。

请始终优先参考本说明，只有在遇到与此内容不一致的意外信息时，才退而使用搜索或 bash 命令。

高效开发指南

前置条件与环境准备

• Java 要求：JDK 8+（项目最低目标为 Java 8）
• Maven：推荐 Maven 3.6+（已验证 Maven 3.9.11）
• IDE：推荐使用 IntelliJ IDEA（项目针对 IDEA 优化）

引导、构建与校验

克隆仓库后按顺序执行以下命令：

# 1. 基础编译（请勿中断 - 约需 4-5 分钟）
mvn clean compile -DskipTests=true --no-transfer-progress
# 超时时间：建议设置 8 分钟以上。实际时间：约 4 分钟

# 2. 完整打包（请勿中断 - 约需 2-3 分钟）  
mvn clean package -DskipTests=true --no-transfer-progress
# 超时时间：建议设置 5 分钟以上。实际时间：约 2 分钟

# 3. 代码质量校验（请勿中断 - 约需 45-60 秒）
mvn checkstyle:check --no-transfer-progress
# 超时时间：建议设置 3 分钟以上。实际时间：约 50 秒

重要时间说明：

• 绝对不要中断任意 Maven 构建命令
• 编译阶段耗时最长（约 4 分钟），原因是项目包含 34 个模块
• 后续构建会更快，因为存在增量编译
• 始终使用 --no-transfer-progress 以减少日志噪音

测试结构

• 测试框架：TestNG（非 JUnit）
• 测试文件：共有 298 个测试文件
• 默认行为：pom.xml 中默认禁用测试（<skip>true</skip>）
• 测试配置：测试需要通过 test-config.xml 提供真实的微信 API 凭据
• 注意：没有真实微信 API 凭据请不要尝试运行测试，测试将会失败

项目结构与导航

核心 SDK 模块（主要开发区）

• weixin-java-common/ - 通用工具与基础类（最重要）
• weixin-java-mp/ - 公众号 SDK
• weixin-java-pay/ - 微信支付 SDK
• weixin-java-miniapp/ - 小程序 SDK
• weixin-java-cp/ - 企业微信 SDK
• weixin-java-open/ - 开放平台 SDK
• weixin-java-channel/ - 视频号 / Channel SDK
• weixin-java-qidian/ - 企点 SDK

框架集成模块

• spring-boot-starters/ - Spring Boot 自动配置 starter
• solon-plugins/ - Solon 框架插件
• weixin-graal/ - GraalVM 本地镜像支持

配置与质量控制

• quality-checks/google_checks.xml - Checkstyle 配置
• .editorconfig - 代码格式规则（2 个空格等于 1 个制表）
• pom.xml - 根级 Maven 配置

开发工作流

修改代码的流程

1. 修改前务必先构建以建立干净基线：

   mvn clean compile --no-transfer-progress
   

2. 遵循代码风格（由 checkstyle 强制）：

   • 缩进使用 2 个空格（不要用制表符）
   • 遵循 Google Java 风格指南
   • 在 IDE 中安装 EditorConfig 插件

3. 增量验证修改：

   # 每次修改后运行：
   mvn compile --no-transfer-progress
   mvn checkstyle:check --no-transfer-progress
   

提交修改前的必须校验

请务必按顺序完成以下校验步骤：