dynamic-datasource源码贡献指南：CONTRIBUTING解析
项目地址: https://gitcode.com/gh_mirrors/dy/dynamic-datasource 本文档基于项目CONTRIBUTING.md解析dynamic-datasource项目的源码贡献流程，涵盖环境配置、测试执行、PR提交等核心环节，帮助开发者快速参与开源贡献。
1. 源码仓库Fork
贡献的第一步是Fork项目仓库。项目主仓库位于GitHub，贡献者需访问官方镜像仓库创建个人分支。所有代码修改将通过PR（Pull Request）提交至主仓库进行审核。
2. 开发环境配置
2.1 JDK版本要求
项目使用OpenJDK 17构建，输出产物兼容OpenJDK 8。开发时需确保IDE语言级别设置正确：
- 主项目语言级别：8
- Spring Boot 3子模块（
dynamic-datasource-spring-boot3-starter）语言级别：17
2.2 依赖管理
项目通过Maven管理依赖，核心构建文件包括：
- 根目录POM：pom.xml
- Spring Boot 2 starter模块：dynamic-datasource-spring-boot-starter/pom.xml
- Spring Boot 3 starter模块：dynamic-datasource-spring-boot3-starter/pom.xml
3. 测试执行流程
3.1 基础单元测试
提交PR前必须通过所有单元测试，执行命令：
./mvnw -T1C clean test
测试代码位于各模块的src/test/java目录，例如Spring Boot 3 starter的测试用例：dynamic-datasource-spring-boot3-starter/src/test/java/com/baomidou/dynamic/datasource/fixture/v3/
3.2 GraalVM Native Image测试
项目支持GraalVM原生镜像构建，需通过nativeTestInSpringBoot Profile验证：
./mvnw -PnativeTestInSpringBoot -T1C -e clean test
若测试失败，需生成GraalVM可达性元数据：
./mvnw -PgenerateMetadata -DskipNativeTests -e -T1C clean test native:metadata-copy
元数据文件存放于：native-image/
4. 提交PR规范
4.1 分支策略
- 功能开发：基于
develop分支创建特性分支 - 问题修复：基于
main分支创建修复分支
4.2 CI验证
PR提交后将触发GitHub Actions CI，自动验证：
- 多JDK版本兼容性（8+）
- 单元测试覆盖率
- GraalVM原生镜像构建
4.3 代码规范
遵循项目编码规范，关键模块参考：
- 数据源核心逻辑：dynamic-datasource-spring/src/main/java/com/baomidou/dynamic/datasource/DynamicRoutingDataSource.java
- 注解定义：dynamic-datasource-spring/src/main/java/com/baomidou/dynamic/datasource/annotation/DS.java
5. 常见问题解决
5.1 SpEL功能限制
由于Spring Framework原生限制，暂不支持SpEL相关功能的nativeTest，参考Spring Issue #29548。
5.2 第三方库元数据缺失
若遇第三方库缺失GraalVM元数据，需提交PR至oracle/graalvm-reachability-metadata仓库。
6. 贡献者资源
- 行为准则：CODE_OF_CONDUCT.md
- 问题模板：ISSUE_TEMPLATE
- PR模板：PULL_REQUEST_TEMPLATE
通过以上流程，开发者可规范地参与dynamic-datasource项目的源码贡献，助力多数据源功能的持续优化与迭代。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
