自定义 SpringBoot starter
文章目录
- 是什么？
- 优点
- 缺点
- 自定义实现 starter
- 1. 确定功能和依赖
- 2. 创建 Maven 或 Gradle 项目
- 3. 编写自动配置类
- 4. 编写 Starter 类
- 5. 编写 Starter 的属性配置类
- 6. 编写 Spring Boot Starter Metadata 文件
- 7. 编写 README 和文档
是什么？
Spring Boot Starter 是 Spring Boot 的一个核心概念，它是一种约定俗成的方式，用于快速集成和配置 Spring 应用程序所需的依赖项。
优点
-
简化依赖管理：Spring Boot Starter 将相关的依赖项打包在一起，使得项目配置和依赖管理变得更加简单和一致。
-
快速启动应用程序：Starter 提供了预配置的默认选项，可以快速启动 Spring 应用程序，减少了繁琐的配置过程。
-
约定优于配置：遵循了 Spring Boot 的设计原则，通过约定俗成的方式，使得开发者可以专注于业务逻辑而非配置。
-
自动配置：Spring Boot Starter 提供了自动配置的能力，根据应用程序的依赖和环境，自动配置 Spring 应用程序的各种组件。
-
生态系统支持：Spring Boot 社区和第三方开发者提供了大量的 Starter，覆盖了几乎所有常见的应用场景和集成需求。
缺点
-
过度依赖：有时候会出现过度依赖的情况，即项目中引入了不必要的 Starter，导致项目的依赖关系复杂化。
-
不灵活：某些情况下，Starter 提供的默认配置可能不符合特定的需求，需要额外的配置或者自定义。
自定义实现 starter
1. 确定功能和依赖
首先，确定 Starter 的功能和依赖。这可能包括需要集成的库、配置文件、自动配置类等。
2. 创建 Maven 或 Gradle 项目
创建一个新的 Maven 或 Gradle 项目作为 Starter 的基础。确保项目的结构和命名符合 Maven 或 Gradle 的约定。
3. 编写自动配置类
编写一个自动配置类，通常命名为 XxxAutoConfiguration，其中 Xxx 是你的 Starter 的名称。在这个类中，可以使用 @Configuration、@ConditionalOnClass、@ConditionalOnProperty 等注解来定义自动配置的条件和行为。例如
package com.example.welcome.autoconfigure;import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
@ConditionalOnClass(WelcomeService.class)
public class WelcomeAutoConfiguration {@Beanpublic WelcomeService welcomeService() {return new WelcomeService();}
}
@ConditionalOnClass(WelcomeService.class) 是 Spring Boot 中的一个条件注解，它的意思是：只有当类路径中存在 WelcomeService 类时，才会生效配置。
4. 编写 Starter 类
编写一个 Starter 类，通常命名为 XxxStarter，这个类应该是一个普通的 Java 类，用来暴露 Starter 的主要功能和接口。
5. 编写 Starter 的属性配置类
如果需要用户配置属性，可以编写一个属性配置类（通常命名为 XxxProperties），并使用 @ConfigurationProperties 注解来映射配置文件中的属性到这个类中。
package com.example.welcome.autoconfigure;import org.springframework.boot.context.properties.ConfigurationProperties;@ConfigurationProperties(prefix = "welcome")
public class WelcomeProperties {private String message = "Welcome to Spring Boot Starter!";public String getMessage() {return message;}public void setMessage(String message) {this.message = message;}
}
6. 编写 Spring Boot Starter Metadata 文件
- SpringBoot 2.7 以下版本，在
src/main/resources/META-INF/spring.factories文件中，指定自动配置类，这样 SpringBoot 在启动时会自动加载你的自动配置。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.welcome.autoconfigure.WelcomeAutoConfiguration
- Spring Boot 2.7 开始，不再推荐使用
spring.factories，而是改用在src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中，指定自动配置类，每个自动配置类的全类名单独一行。(在 Spring Boot 3 开始将移除对/META-INF/spring.factories的支持)
com.example.welcome.autoconfigure.WelcomeAutoConfiguration
7. 编写 README 和文档
为了使 Starter 更易于使用，编写清晰的 README 文件和文档，描述如何引入、配置和使用 Starter。