Spring Boot Starter开发教程

为什么需要 Starter？

开发者只需要关心调用哪些接口、传递哪些参数，其他逻辑都被封装好，便于使用。

使用 starter 的好处就是，开发者引入后可以直接在 application.yml 中进行配置，自动创建相应的客户端。这样使得开发过程更加简单便捷，无需过多关注底层实现细节，而是专注于配置和使用。

开发一个Spring Boot Starter是创建可重用组件的好方法。Spring Boot Starter本质上是一个Maven或Gradle项目，它包含了一些预配置好的依赖项，以及一些自动化配置类，使得用户可以在自己的项目中轻松地启用某些功能。

下面是创建一个简单的Spring Boot Starter的步骤：

1. 创建一个新的Maven项目

首先，我们要创建一个新的Maven项目作为你的Starter模块。假设我们想要创建一个名为my-starter的Starter，用于提供一些基础的日志记录功能。

创建项目

打开IDE，创建一个新的Maven项目，并配置如下：

• Group ID: com.example

• Artifact ID: my-starter

• Version: 1.0.0-SNAPSHOT

2. 添加依赖

在pom.xml文件中添加必要的依赖。通常情况下，你会添加spring-boot-starter-parent作为父POM，以继承Spring Boot的标准配置。

 1<parent>
 2    <groupId>org.springframework.boot</groupId>
 3    <artifactId>spring-boot-starter-parent</artifactId>
 4    <version>3.1.2</version>
 5    <relativePath/> <!-- lookup parent from repository -->
 6</parent>
 7
 8<dependencies>
 9    <dependency>
 10        <groupId>org.springframework.boot</groupId>
 11        <artifactId>spring-boot-autoconfigure</artifactId>
 12    </dependency>
 13</dependencies>

3. 创建自动配置类

为了使Starter能够自动配置一些组件，你需要创建一个配置类，并使用@Configuration和@ConditionalOnClass等注解来控制配置的条件性加载。

例如，创建一个MyAutoConfiguration类：

 1@Configuration(proxyBeanMethods = false)
 2@ConditionalOnClass(Log.class)
 3public class MyAutoConfiguration {
 4
 5    @Bean
 6    public Logger getLogger() {
 7        // 这里可以做一些初始化工作，比如设置日志级别
 8        return new Logger();
 9    }
 10}

4. 提供自动配置元数据

为了让Spring Boot知道如何自动配置你的Starter，你需要创建一个META-INF/spring.factories文件，指定自动配置类的位置。

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

 1org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.mystarter.MyAutoConfiguration

5. 创建一个示例项目

为了验证Starter是否正常工作，你可以创建一个简单的Spring Boot项目，并引入你的Starter作为依赖。

示例项目的pom.xml

 1<parent>
 2    <groupId>org.springframework.boot</groupId>
 3    <artifactId>spring-boot-starter-parent</artifactId>
 4    <version>3.1.2</version>
 5    <relativePath/> <!-- lookup parent from repository -->
 6</parent>
 7
 8<dependencies>
 9    <dependency>
 10        <groupId>com.example</groupId>
 11        <artifactId>my-starter</artifactId>
 12        <version>1.0.0-SNAPSHOT</version>
 13    </dependency>
 14</dependencies>

6. 使用Starter

在你的示例项目中，你可以直接使用Starter提供的Bean。

 1@SpringBootApplication
 2public class Application {
 3
 4    public static void main(String[] args) {
 5        SpringApplication.run(Application.class, args);
 6    }
 7
 8    @Bean
 9    public CommandLineRunner demo(Logger logger) {
 10        return (args) -> {
 11            logger.log("Hello, World!");
 12        };
 13    }
 14}

7. 测试

启动示例项目，查看控制台输出是否包含了预期的日志信息。

8. 发布到Maven仓库

如果你想要让其他人也能使用你的Starter，你可以将其发布到私有的或公共的Maven仓库。

以上，就是创建一个简单的Spring Boot Starter的基本步骤。

更多精彩请关注我的Github：Utopia007 (Qiao Guanhao) · GitHub