Spring Boot进阶 - Starter自定义

在Spring Boot中，自定义starter是一种高级用法，它允许你封装特定功能或组件，使得其他开发者能够轻松地在他们的Spring Boot应用中引入和配置这些功能，而无需关注其实现细节。自定义starter本质上是一个jar包，它集合了自动配置、依赖管理和可选的模板代码，以简化集成过程。以下是创建自定义starter的基本步骤：

1. 创建Maven项目

首先，你需要创建一个新的Maven项目作为你的自定义starter。这个项目结构应该遵循一般的Spring Boot项目结构，并且需要包含一些特定的元数据来指示这是一个starter。

2. 添加依赖

在pom.xml中，你需要添加必要的依赖来支持Spring Boot特性以及你想要封装的任何第三方库或服务。通常，这包括但不限于：

• spring-boot-starter-parent：提供默认的Maven配置和插件。
• spring-boot-autoconfigure：用于定义自动配置逻辑。
• 你打算封装的特定库或服务的依赖。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.5</version> <!-- 使用当前Spring Boot的版本 -->
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
    <!-- 添加你项目所需的其他依赖 -->
</dependencies>

3. 定义自动配置

自动配置是自定义starter的核心部分，它让Spring Boot根据特定条件（如类路径上的某些类或属性的存在）自动设置bean。通常，在src/main/java下创建一个新包，比如com.example.mystarter.config，并在此包下编写配置类。使用@Configuration注解标记该类，并可能使用@ConditionalOnClass、@ConditionalOnProperty等条件注解来控制自动配置的启用。

4. 提供属性

为了使你的starter更加灵活，你可以定义一些外部配置属性，让用户可以通过application.properties或application.yml来调整行为。为此，创建一个@ConfigurationProperties类，并在配置类中通过@EnableConfigurationProperties来启用它。

5. 打包发布

最后，将你的项目打包成jar文件，并发布到私有或公共Maven仓库，或者直接在你的组织内部共享。确保版本号管理得当，以便于后续维护和升级。

示例

假设你要创建一个处理日志记录到数据库的自定义starter，你可能需要定义一个自动配置类来设置数据库连接和日志处理器的bean，同时定义一个@ConfigurationProperties类来管理数据库连接信息。

注意事项

• 命名约定：自定义starter的命名通常遵循spring-boot-starter-<功能名>的形式，例如my-project-starter。
• 文档：编写清晰的文档对于使用者理解如何配置和使用你的starter至关重要。
• 测试：确保为你的starter编写充分的单元测试和集成测试，验证其在不同环境下的行为。

通过上述步骤，你可以成功创建并分享自己的Spring Boot starter，促进代码复用，提升开发效率。 这里我们通过一个简化的例子来创建一个名为api-starter的自定义Spring Boot Starter，这个starter的目的是提供一些基本的API监控和健康检查功能。这个示例会涵盖自动配置、配置属性和基本的使用说明。

1. 创建Maven项目

首先，创建一个新的Maven项目，编辑pom.xml如下：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>api-starter</artifactId>
    <version>1.0.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.5</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>

    <properties>
        <java.version>11</java.version>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2. 定义配置属性

在src/main/java/com/example/api/config目录下创建ApiProperties.java，用于定义外部配置属性：

package com.example.api.config;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "api")
public class ApiProperties {
    private boolean healthCheckEnabled = true;
    // 更多配置属性...

    // Getter and Setter
}

3. 自动配置

在相同包下创建ApiAutoConfiguration.java，实现自动配置：

package com.example.api.config;

import org.springframework.boot.actuate.autoconfigure.health.CompositeHealthContributorConfiguration;
import org.springframework.boot.actuate.health.HealthEndpoint;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.boot.actuate.health.HttpCodeStatusMapper;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableAutoConfiguration
@EnableConfigurationProperties(ApiProperties.class)
public class ApiAutoConfiguration extends CompositeHealthContributorConfiguration<HealthIndicator, ApiProperties> {

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnClass(HealthEndpoint.class)
    public HealthEndpoint healthEndpoint(HttpCodeStatusMapper httpCodeStatusMapper, ApiProperties properties) {
        return new HealthEndpoint(httpCodeStatusMapper, properties.getHealthGroup());
    }

    // 示例健康指标或其他配置...
}

4. 发布和使用

完成以上步骤后，构建并安装此项目到你的本地Maven仓库。然后，在其他Spring Boot应用中使用这个starter，只需在该应用的pom.xml中添加依赖：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>api-starter</artifactId>
    <version>1.0.0</version>
</dependency>

并在application.yml中配置相关属性：

api:
  health-check-enabled: true
  # 更多配置...

请注意，上述代码仅为示例，实际应用中你可能需要根据具体需求实现更复杂的功能和配置。