【主流技术】Spring Boot Starter 的应用场景与自动配置-编程知识

【主流技术】Spring Boot Starter 的应用场景与自动配置

news/2025/3/11 9:10:50/文章来源:https://www.cnblogs.com/CodeBlogMan/p/18300877

前言
一、Spring Boo Starter 简介
二、如何自定义 Starter
- 2.1命名规范
- 2.2整体结构
- 2.3模块开发
  - 2.3.1依赖引入
  - 2.3.2xxxAutoConfiguration的实现
  - 2.3.3 xxxProperties的实现
  - 2.3.4配置spring.factories文件
三、浅析 Spring Boot 自动配置原理
- 3.1自动配置原理
- 3.2自动配置的过程
四、文章小结

前言

一、Spring Boo Starter 简介

在 SpringBoot 出现之前，如果我们想使用 SpringMVC 来构建我们的 web 项目，必须要做的几件事情如下：

首先项目中需要引入 SpringMVC 的依赖
在 web.xml 中注册 SpringMVC 的DispatcherServlet，并配置url映射
编写springmcv-servlet.xml，在其中配置几个重要的组件，处理映射器（HandlerMapping）、处理适配器（HandlerAdapter）、视图解析器（ViewResolver）
在applicationcontext.xml文件中引入springmvc-servlet.xml文件

以上这几步只是配置好了 SpringMVC，如果我们还需要与数据库进行交互，就要在 application.xml 中配置数据库连接池 DataSource，如果需要数据库事务，还需要配置 TransactionManager… 等等。

以上会带来两个明显的问题：

依赖导入问题： 每个项目都需要来单独维护自己所依赖的 jar 包，手动导入依赖容易出错，且无法统一集中管理。
配置繁琐： 在引入依赖之后需要做繁琐的配置，并且这些配置是每个项目来说都是必要的，例如 web.xml 配置（Listener 配置、Filter 配置、Servlet 配置）、log4j 配置、数据库连接池配置等。

而使用 Spring Boot 的 starters（场景启动器）解决上述的两个痛点，Spring Boot 通过将我们常用的功能场景抽取出来，做成的一系列场景启动器。

我们只需要在项目中引入这些 starters，相关场景的所有依赖就会全部被导入进来，并且我们仅需要通过配置文件来进行少量的配置就可以使用相应的功能。

二、如何自定义 Starter

一般在企业开发中，会有专门的 git 仓库（组）来统一放置各个系统对应的 Starter 项目，其中会包括一个空的框架，拉取下来后我们就可以自己开发了。

在开发之前，我们需要知道常见的使用场景有哪些：

API 调用： 将某系统的部分功能经过封装后通过 API 暴露出去，方便内部/外部系统调用，调用时需要经过认证；
基础组件： 比如全局统一的 Http 组件、缓存组件和一些通用工具包等，目的是提升团队开发效率和形成开发规范；
底层框架： 主要是公司自研的系统框架，如 Netty 通信、Maven 插件、ORM 框架等等，用于项目开发的基础支持。

2.1命名规范

Spring Boot 官方推荐的命名规范如下：

前缀：spring-boot-starter-
模式：spring-boot-starter-模块名
举例：spring-boot-starter-web、spring-boot-starter-jdbc 等

我们自定义开发推荐的命名：

前缀：xx-spring-boot-starter
模式：xx模块-spring-boot-starter
举例：业务线-系统名-spring-boot-starter、saas-user-spring-boot-starter等

2.2整体结构

一个 starter 的整体实现逻辑主要由两个基本部分组成：

xxxAutoConfiguration：自动配置类，对某个场景下需要使用到的一些组件进行自动注入，并利用xxxProperties类来进行组件相关配置。
xxxProperties：某个场景下所有可配置属性的集成，在配置文件中配置可以进行属性值的覆盖。

按照 SpringBoot 官方的定义，starer 的作用就是依赖聚合，因此直接在 starter 内部去进行代码实现是不符合规定的，starter 应该只起到依赖导入的作用，而具体的代码实现应该去交给其它服务/模块来实现。

2.3模块开发

2.3.1依赖引入

首先所有的自动配置模块都要引入两个 jar 包依赖：

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId> <!-- 包含很多与自动配置相关的注解的定义，必须要引入 --></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId> <!-- 可以通过其它 .properties 文件为相关类进行属性映射，SpringBoot 默认使用 application.yml--><optional>true</optional></dependency><dependencies>

2.3.2xxxAutoConfiguration的实现

xxxAutoconfigure 模块中最重要的就是自动配置类的编写，它为我们实现组件的自动配置与自动注入。在编写自动配置类的时候，我们应该要考虑向容器中注入什么组件，如何去配置它。

@Configuration 
@EnableConfigurationProperties(xxxProperties.class)
public class xxxAutoConfiguration {@Resourceprivate xxxProperties properties;@Beanpublic static BeanYouNeed beanYouNeed() {BeanYouNeed bean = new BeanYouNeed()bean.setField(properties.get(field));bean.setField(properties.get(field));}
}

2.3.3 xxxProperties的实现

这是跟配置文件相绑定的类，里边的属性就是我们可以在配置文件中配置的内容，然后通过@ConfigurationProperties将其与配置文件绑定：

//使用 @ConfigurationProperties 注解绑定配置文件
@ConfigurationProperties(prefix = "your properties") 
public class xxxProperties {private String url;private String key;private String secret;
}

2.3.4配置spring.factories文件

在 resource 目录下新建META-INF文件夹，在文件夹下新建spring.factories文件，并添加写好的xxxAutoConfiguration类：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.xx.xx.xx.autoconfigure.xxxAutoConfiguration

三、浅析 Spring Boot 自动配置原理

在这一小节我将分析 Spring Boot 在创建 Stater 时主要帮我们完成的两件最关键的事情：

相关组件的自动导入
相关组件的自动配置

这两件事情统一称为 SpringBoot 的自动配置。

3.1自动配置原理

我们从主程序入口来探索一下整个过程的原理：

@SpringBootApplication //标注这个类是一个 springboot 的应用
public class MyApplication {public static void main(String[] args) {//将 springboot 应用启动SpringApplication.run(MyApplication.class, args);}
}

@SpringBootApplication注解内部结构如下图3-1所示：

图3-1

我们可以去到上边提到的spring.factories文件中去看一下，找到 spring 官方提供的spring-boot-autoconfigure包，再去找一下该文件，如图3-2所示：

图3-2

可以看到这个就是SpringBoot官方为我们提供的所有自动配置类的候选列表。
我们可以在其中找到一个我们比较熟悉的自动配置类去看一下它内部的实现，可以看到这些一个个的都是JavaConfig配置类，而且都通过@Bean注解向容器中注入了一些 Bean，如图3-3所示：

图3-3 小结：

SpringBoot 在启动的时候从类路径下的META-INF/spring.factories中获取 EnableAutoConfiguration 指定的所有自动配置类的全限定类名；
整个 J2EE 的全部解决方案和自动配置都在spring-boot-autoconfigure的 jar 包中，将这些自动配置类导入容器，自动配置类就生效；
上面2点会给容器中导入非常多的自动配置类（xxxAutoConfiguration）, 就是给容器中导入这个场景需要的所有组件，并配置好这些组件。