baomidou/dynamic-datasource

The project is organized into 6 distinct modules. Depending on your Spring Boot version and requirements, you may need to target specific modules:

1. dynamic-datasource-creator: Core datasource creator functionality
2. dynamic-datasource-spring: Spring framework integration
3. dynamic-datasource-spring-boot-common: Common Spring Boot autoconfiguration
4. dynamic-datasource-spring-boot-starter: Spring Boot 2.x starter
5. dynamic-datasource-spring-boot3-starter: Spring Boot 3.x starter (Java 17+)
6. dynamic-datasource-spring-boot4-starter: Spring Boot 4.x starter (Java 17+)

To publish the project to Maven Central, use the publish task.

Requirements:

• You must set ossrhUsername and ossrhPassword in your local ~/.gradle/gradle.properties file.
• You must configure GPG signing for releases.

./gradlew publish

Use the Gradle wrapper (./gradlew) to perform common build operations. This replaces the previous Maven (mvnw) workflow.

# Build the project
./gradlew build

# Clean build artifacts
./gradlew clean

# Build without running tests
./gradlew build -x test

# Publish to local Maven repository
./gradlew publishToMavenLocal

If you need to switch between different JDK versions for builds, you can specify the JDK path using the JAVA_HOME environment variable or via a Gradle system property.

# Using JAVA_HOME to specify JDK
export JAVA_HOME=/path/to/jdk-17
./gradlew build

# Or using Gradle's JVM parameter
./gradlew build -Dorg.gradle.java.home=/path/to/jdk-17

Use the following command to verify that all modules compile successfully and all tests (including Spring Boot 2, 3, and 4) pass.

./gradlew clean build

Choose the appropriate dependency based on your Spring Boot and JDK versions:

• Spring Boot 1.5.x ~ 2.x.x (JDK 8+): Use dynamic-datasource-spring-boot-starter (Version 1.0.0+).
• Spring Boot 3.x.x (JDK 17+): Use dynamic-datasource-spring-boot3-starter (Version 4.0.0+).
• Spring Boot 4.x.x (JDK 17+): Use dynamic-datasource-spring-boot4-starter (Version 4.5.0+).

Ensure each module uses the correct JDK version required by its Spring Boot target. Use both java {} configuration and options.release to ensure bytecode and API level consistency.

// Spring Boot 2.x Starter - JDK 8
java {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}

// Spring Boot 3.x/4.x Starter - JDK 17
java {
    sourceCompatibility = JavaVersion.VERSION_17
    targetCompatibility = JavaVersion.VERSION_17
}

tasks.withType(JavaCompile).configureEach {
    options.release = 17
}

You can improve build speeds by enabling the Gradle build cache and parallel execution in your gradle.properties file.

Expected benefits:

• 30-50% improvement in incremental builds.
• 20-40% improvement via parallel builds.

The Spring Boot 3 and 4 starters support GraalVM native image compilation.

./gradlew nativeCompile

The project can be opened in the following IDEs:

• IntelliJ IDEA: Automatically detects the Gradle build upon opening the project.
• Eclipse: Requires the Buildship plugin. Install via Help → Eclipse Marketplace, then use File → Import → Gradle → Existing Gradle Project.
• VS Code: Install the "Gradle for Java" extension from the marketplace.