83、高级特性-自定义starter细节
83、高级特性-自定义starter细节
自定义Spring Boot Starter可以将通用功能封装成可复用的模块，简化其他项目的配置和使用。以下是创建自定义Starter的详细步骤和关键细节：
### 1. 项目结构
通常，自定义Starter包含两个模块：
#### **自动配置模块**：`xxx-spring-boot-autoconfigure`
- 包含自动配置类、配置属性类和其他核心功能代码。
#### **Starter模块**：`xxx-spring-boot-starter`
- 依赖自动配置模块，提供依赖管理，不包含实际代码。
### 2. 创建自动配置模块
#### **添加依赖**
在`xxx-spring-boot-autoconfigure`的`pom.xml`中添加必要的依赖：
```xml
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- 添加其他需要的依赖 -->
</dependencies>
```
#### **创建自动配置类**
使用`@Configuration`注解创建自动配置类，并使用`@ConditionalOnXXX`注解控制配置的条件加载：
```java
@Configuration
@EnableConfigurationProperties(MyProperties.class)
@ConditionalOnClass(MyService.class)
public class MyAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public MyService myService(MyProperties properties) {
return new MyService(properties.getMessage());
}
}
```
- `@EnableConfigurationProperties`：启用配置属性类。
- `@ConditionalOnClass`：当类路径中存在指定类时，配置生效。
- `@ConditionalOnMissingBean`：当容器中不存在指定类型的Bean时，创建Bean。
#### **定义配置属性类**
创建用于接收外部配置的属性类，使用`@ConfigurationProperties`注解：
```java
@ConfigurationProperties(prefix = "my.starter")
public class MyProperties {
private String message = "默认消息";
// 提供getter和setter方法
// ...
}
```
#### **注册自动配置类**
在`src/main/resources/META-INF/spring`目录下创建`org.springframework.boot.autoconfigure.AutoConfiguration.imports`文件，内容为：
```
com.example.autoconfigure.MyAutoConfiguration
```
### 3. 创建Starter模块
#### **添加依赖**
在`xxx-spring-boot-starter`的`pom.xml`中添加对自动配置模块的依赖：
```xml
<dependencies>
<dependency>
<groupId>com.example</groupId>
<artifactId>xxx-spring-boot-autoconfigure</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
```
### 4. 打包和发布
- 分别打包两个模块，将`xxx-spring-boot-starter`发布到Maven仓库或本地仓库。
### 5. 使用自定义Starter
在其他项目中添加依赖：
```xml
<dependency>
<groupId>com.example</groupId>
<artifactId>xxx-spring-boot-starter</artifactId>
<version>1.0.0</version>
</dependency>
```
然后在`application.properties`或`application.yml`中进行配置：
```yaml
my:
starter:
message: 自定义消息
```
### 6. 关键细节
#### **命名规范**
- 自动配置模块：`xxx-spring-boot-autoconfigure`
- Starter模块：`xxx-spring-boot-starter`
#### **条件装配**
灵活运用`@ConditionalOnXXX`注解，根据条件选择性地加载配置，提高灵活性。
#### **配置属性绑定**
确保`@ConfigurationProperties`的`prefix`属性与外部配置一致。
#### **版本管理**
合理管理Starter的版本，确保与其他依赖的兼容性。
#### **文档和示例**
提供详细的文档和使用示例，方便其他开发者快速上手。
通过以上步骤和注意事项，您可以创建功能完善、易于使用的自定义Spring Boot Starter，提升开发效率和代码复用性。