Spring Boot自定义Starter_spring3.4如何编写一个starter-优快云博客

本文链接：https://blog.youkuaiyun.com/print_helloword/article/details/144917297

下面是一个详细的 Spring Boot 自定义 Starter 教程，分步骤讲解相关内容，包括 spring.factories、AutoConfiguration.imports、EnvironmentPostProcessor 等核心知识点，帮助深入理解自定义 Starter 的实现过程。

1. 什么是 Spring Boot Starter

Spring Boot Starter 是一个模块化的库，它通过自动配置的方式，简化了功能的集成。例如：spring-boot-starter-web、spring-boot-starter-data-jpa 等。我们可以通过自定义 Starter 提供特定功能（如统一日志、动态环境配置等）。

2. 自定义 Starter 的核心概念

2.1 自动配置

自动配置是 Starter 的核心功能。Spring Boot 使用 @EnableAutoConfiguration 和特定配置文件（如 spring.factories 或 AutoConfiguration.imports）实现自动加载模块的配置。

2.2 环境初始化（可选）

如果需要在 Spring 应用加载前修改配置，可以使用 EnvironmentPostProcessor。

3. 自定义 Starter 的实现步骤

我们以开发一个自定义 Starter 为例：实现一个统一的日志打印功能，并动态支持环境变量的加载。

3.1 创建一个 Maven 模块

使用 Maven 创建一个新模块：

mvn archetype:generate -DgroupId=com.example -DartifactId=custom-spring-boot-starter -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

在 pom.xml 中引入必要的依赖：

<dependencies>
    <!-- Spring Boot Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot</artifactId>
    </dependency>
</dependencies>

3.2 创建自动配置类

创建自动配置类，用于注册自定义的日志服务。

package com.example.starter;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@AutoConfiguration // 使用 @AutoConfiguration 替代传统的 @Configuration
public class LogAutoConfiguration {

    // 只有当 custom.log.enabled=true 时，注册 MyLogService Bean
    @Bean
    @ConditionalOnProperty(name = "custom.log.enabled", havingValue = "true", matchIfMissing = true)
    public MyLogService myLogService() {
        return new MyLogService();
    }
}

3.3 创建日志服务类

这是实际的业务逻辑，打印日志。

package com.example.starter;

public class MyLogService {

    public void log(String message) {
        System.out.println("Custom Log: " + message);
    }
}

3.4 配置 `spring.factories` 或 `AutoConfiguration.imports`

方式1：使用 `spring.factories`

在 resources/META-INF/spring.factories 中添加以下内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.starter.LogAutoConfiguration

方式2：使用 `AutoConfiguration.imports`

在 resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 中添加以下内容：

com.example.starter.LogAutoConfiguration

建议使用 AutoConfiguration.imports，它是 Spring Boot 2.7+ 的推荐方式，性能更优，维护更方便。

3.5 动态环境配置（可选）

如果需要在 Spring Boot 应用启动时动态修改配置，可以实现 EnvironmentPostProcessor。

创建 EnvironmentPostProcessor 实现类

package com.example.starter;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;

import java.util.HashMap;
import java.util.Map;

public class CustomEnvironmentPostProcessor implements EnvironmentPostProcessor {

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        // 动态添加环境变量
        Map<String, Object> customProperties = new HashMap<>();
        customProperties.put("custom.log.enabled", "true"); // 默认启用日志

        environment.getPropertySources().addLast(new MapPropertySource("customProperties", customProperties));
    }
}

在 `spring.factories` 中注册

org.springframework.boot.env.EnvironmentPostProcessor=\
com.example.starter.CustomEnvironmentPostProcessor

3.6 打包 Starter

使用 Maven 打包：

mvn clean install

4. 在其他项目中使用 Starter

在主项目中引入 Starter：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>custom-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

在 application.properties 中启用自定义日志：
```
custom.log.enabled=true
```

在主项目中测试：

package com.example.demo;

import com.example.starter.MyLogService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication implements CommandLineRunner {

    @Autowired
    private MyLogService myLogService;

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

    @Override
    public void run(String... args) throws Exception {
        myLogService.log("Hello, Spring Boot Starter!");
    }
}

5. 核心知识点补充

5.1 `spring.factories` 和 `AutoConfiguration.imports` 的区别

特性	`spring.factories`	`AutoConfiguration.imports`
使用版本	Spring Boot 1.x 和 2.x	Spring Boot 2.7+
文件路径	`META-INF/spring.factories`	`META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`
加载机制	较旧的 `EnableAutoConfiguration` 实现	更高效的自动配置加载
推荐性	不推荐（可能被弃用）	推荐