Skip to content

Repository files navigation

berkeley-spring-boot-starter

Spring Boot Starter for berkeley

Maven CentralJavaLicense

简体中文 | English

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


Current Version1.0.0-SNAPSHOT
JDK Baseline17
Group IDio.github.easy4j
Artifact IDberkeley-spring-boot-starter
License:Apache License 2.0

1. Positioning

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

DimensionDescription
TypeSpring Boot Starter
ConsumersSpring Boot applications using berkeley
Core Capabilitiesauto-configuration, property binding, ready-to-use beans for berkeley
JDK17
Coordinatesio.github.easy4j:berkeley-spring-boot-starter:1.0.0-SNAPSHOT
Config Prefixberkeley

2. Core Capabilities

CapabilityStatusDescription
Auto-configuration✅ StableRegisters berkeley beans automatically
Property Binding✅ StableBinds berkeley.* to BerkeleyProperties
Ready-to-use beans✅ StableAuto-registered via BerkeleyAutoConfiguration

3. Requirements and Compatibility

DependencyMinimumEvidence
JDK17pom.xml
Spring Boot2.3.0.RELEASEpom.xml parent
Maven3.6+Maven Enforcer

4. Auto-configuration

The starter auto-configures the following beans:

BeanConditionMissing Behavior
Objectclasspath + propertynot 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>berkeley-spring-boot-starter</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>

No additional easy4j component dependencies.

6. Quick Start

6.1 Add dependency

Add the dependency above to your pom.xml.

6.2 Configure

berkeley:
enabled: true

6.3 Use the bean

@SpringBootApplicationpublicclassApplication {
publicstaticvoidmain(String[] args) {
SpringApplication.run(Application.class, args);
}
}

Then inject the auto-configured bean in your code:

@AutowiredprivateObjectbean;

7. Configuration Reference

7.1 Config Prefix

berkeley

7.2 Configuration Items

PropertyTypeDefaultRequiredDescriptionSensitive
berkeley.enabledbooleantrueNoEnable the starterNo

8. Version Lines and Compatibility

BranchJDKSpring BootComponent VersionStatus
2.3.x / 2.7.x8+2.3.x / 2.7.x1.0.xMaintenance
3.0.x ~ 3.5.x173.x2.0.xMaintenance
4.0.x / 4.1.x17+4.x3.0.xActive

9. Build and Test

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

10. Troubleshooting

SymptomDiagnosisResolution
Bean not createdCheck auto-configuration reportVerify berkeley.enabled=true and classpath
ClassNotFoundExceptionMissing dependencyAdd the required module
Version conflictmvn dependency:treeUse 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.


Releases

Packages

Used by

Contributors

Languages