dreamina-spring-boot-starter

Spring Boot Starter for dreamina

简体中文 | English

Positioning · Capabilities · Dependency · Quick Start · Configuration · Versions · Build · License

---

Current Version：4.0.x.20260630-SNAPSHOT
JDK Baseline：17
Group ID：io.github.easy4j
Artifact ID：dreamina-spring-boot-starter
License：Apache License 2.0

1. Positioning

dreamina-spring-boot-starter is a Spring Boot starter that integrates dreamina for applications using dreamina. It provides auto-configuration, property binding, and ready-to-use beans so that applications can consume dreamina capabilities with minimal setup.

Dimension	Description
Type	Spring Boot Starter
Consumers	Spring Boot applications using dreamina
Core Capabilities	auto-configuration, property binding, ready-to-use beans for dreamina
JDK	17
Coordinates	io.github.easy4j:dreamina-spring-boot-starter:4.0.x.20260630-SNAPSHOT
Config Prefix	dreamina

2. Core Capabilities

Capability	Status	Description
Auto-configuration	✅ Stable	Registers dreamina beans automatically
Property Binding	✅ Stable	Binds dreamina.* to DreaminaProperties
DreaminaCliExecutor bean	✅ Stable	Auto-registered via DreaminaAutoConfiguration

3. Requirements and Compatibility

Dependency	Minimum	Evidence
JDK	17	pom.xml
Spring Boot	4.0.1	pom.xml parent
Maven	3.6+	Maven Enforcer

4. Auto-configuration

The starter auto-configures the following beans:

Bean	Condition	Missing Behavior
DreaminaCliExecutor	classpath + property	not created
DreaminaCliAvailabilityChecker	classpath + property	not created
DreaminaCliStartupChecker	classpath + property	not created

Auto-configuration registration:

• META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports (Spring Boot 2.7+ / 3.x / 4.x)
• META-INF/spring.factories (Spring Boot 2.x legacy)

5. Dependency

<dependency>
    <groupId>io.github.easy4j</groupId>
    <artifactId>dreamina-spring-boot-starter</artifactId>
    <version>4.0.x.20260630-SNAPSHOT</version>
</dependency>

This starter depends on the following components (managed by ddd4j BOM):

<dependency>
    <groupId>io.github.easy4j</groupId>
    <artifactId>dreamina-java-sdk</artifactId>
</dependency>

6. Quick Start

6.1 Add dependency

Add the dependency above to your pom.xml.

6.2 Configure

dreamina:
  enabled: true

6.3 Use the bean

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Then inject the auto-configured bean in your code:

@Autowired
private DreaminaCliExecutor dreaminaCliExecutor;

7. Configuration Reference

7.1 Config Prefix

dreamina

7.2 Configuration Items

Property	Type	Default	Required	Description	Sensitive
dreamina.enabled	boolean	true	No	Enable the starter	No

8. Version Lines and Compatibility

Branch	JDK	Spring Boot	Component Version	Status
2.3.x / 2.7.x	8+	2.3.x / 2.7.x	1.0.x	Maintenance
3.0.x ~ 3.5.x	17	3.x	2.0.x	Maintenance
4.0.x / 4.1.x	17+	4.x	3.0.x	Active

9. Build and Test

mvn clean verify
mvn -pl dreamina-spring-boot-starter -am test

10. Troubleshooting

Symptom	Diagnosis	Resolution
Bean not created	Check auto-configuration report	Verify dreamina.enabled=true and classpath
ClassNotFoundException	Missing dependency	Add the required module
Version conflict	mvn dependency:tree	Use BOM for version alignment

11. Contribution

1. Fork the repository.
2. Create a feature branch.
3. Run mvn clean verify before submitting.
4. Submit a pull request.

12. License

This project is licensed under the Apache License, Version 2.0.

---

Back to top · Issues · Repository