徒手撸一个SpringBoot中的starter，解密自动化配置

[[380163]]

创新互联专业为企业提供陇县网站建设、陇县做网站、陇县网站设计、陇县网站制作等企业网站建设、网页设计与制作、陇县企业网站模板建站服务，10多年陇县做网站经验，不只是建网站，更提供有价值的思路和整体网络服务。

starter背景

Spring Boot目前已经变成了后端开发这必备技能之一，其中一个主要原因是Spring Boot中有个非常重要的机制(starter机制)。

starter能够抛弃以前繁杂的配置，将其统一集成进starter，使用的时候只需要在maven中引入对应的starter依赖即可，Spring Boot就能自动扫描到要加载的信息并启动相应的默认配置。

starter让我们摆脱了各种依赖库的处理，以及各种配置信息的烦恼。SpringBoot会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。Spring Boot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循“约定大于配置”的理念。

我们经常会看到或者使用到各种xxx-starter。比如下面几种：

Spring Boot starter原理

从总体上来看，无非就是将Jar包作为项目的依赖引入工程。而现在之所以增加了难度，是因为我们引入的是Spring Boot Starter，所以我们需要去了解Spring Boot对Spring Boot Starter的Jar包是如何加载的?下面我简单说一下。

SpringBoot 在启动时会去依赖的 starter 包中寻找 /META-INF/spring.factories 文件，然后根据文件中配置的 Jar 包去扫描项目所依赖的 Jar 包，这类似于 Java 的 SPI 机制。

细节上可以使用@Conditional 系列注解实现更加精确的配置加载Bean的条件。

JavaSPI 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制。

自定义starter的条件

如果想自定义Starter，首选需要实现自动化配置，而要实现自动化配置需要满足以下两个条件：

  1. 能够自动配置项目所需要的配置信息，也就是自动加载依赖环境;
  2. 能够根据项目提供的信息自动生成Bean，并且注册到Bean管理容器中;

实现自定义starter

 
 
 
 
    
  
  
  
  
  1.  
    2.   
  
  
  
  2.   
    3.   
  
  
  
  3.     org.springframework.boot 
    4.   
  
  
  
  4.     spring-boot-autoconfigure 
    5.   
  
  
  
  5.     2.0.0.RELEASE 
    6.   
  
  
  
  6.   
    7.   
  
  
  
  7.   
    8.   
  
  
  
  8.     org.springframework.boot 
    9.   
  
  
  
  9.     spring-boot-configuration-processor 
    10.   
  
  
  
  10.     2.0.0.RELEASE 
    11.   
  
  
  
  11.     true 
    12.   
  
  
  
  12.    
    13.   
  
  
  
  13.  
    14.

根据需要自定义Starter的实现过程大致如下(以我定义的Starter为例)：

定义XxxProperties类，属性配置类，完成属性配置相关的操作，比如设置属性前缀，用于在application.properties中配置。

TianProperties代码：

 
 
 
 
    
  
  
  
  
  1. import org.springframework.boot.context.properties.ConfigurationProperties; 
    2.   
  
  
  
  2. @ConfigurationProperties(prefix = "spring.tian") 
    3.   
  
  
  
  3. public class TianProperties { 
    4.   
  
  
  
  4.     private String name; 
    5.   
  
  
  
  5.     private int age; 
    6.   
  
  
  
  6.     private String sex = "M"; 
    7.   
  
  
  
  7.     //省略 get set 方法 
    8.   
  
  
  
  8. } 
    9.

创建XxxService类，完成相关的操作逻辑 。

TianService代码：

 
 
 
 
    
  
  
  
  
  1. public class TianService { 
    2.   
  
  
  
  2.  
    3.   
  
  
  
  3.     private TianProperties properties; 
    4.   
  
  
  
  4.  
    5.   
  
  
  
  5.     public TianService() { 
    6.   
  
  
  
  6.     } 
    7.   
  
  
  
  7.  
    8.   
  
  
  
  8.     public TianService(TianProperties userProperties) { 
    9.   
  
  
  
  9.         this.properties = userProperties; 
    10.   
  
  
  
  10.     } 
    11.   
  
  
  
  11.     public void sayHello(){ 
    12.   
  
  
  
  12.         System.out.println("hi, 我叫: " + properties.getName() + 
    13.   
  
  
  
  13.         ", 今年" + properties.getAge() + "岁" 
    14.   
  
  
  
  14.          + ", 性别: " + properties.getSex()); 
    15.   
  
  
  
  15.     } 
    16.   
  
  
  
  16. } 
    17.

定义XxxConfigurationProperties类，自动配置类，用于完成Bean创建等工作。

TianServiceAutoConfiguration代码：

 
 
 
 
    
  
  
  
  
  1. @Configuration 
    2.   
  
  
  
  2. @EnableConfigurationProperties(TianProperties.class) 
    3.   
  
  
  
  3. @ConditionalOnClass(TianService.class) 
    4.   
  
  
  
  4. @ConditionalOnProperty(prefix = "spring.tian", value = "enabled", matchIfMissing = true) 
    5.   
  
  
  
  5. public class TianServiceAutoConfiguration { 
    6.   
  
  
  
  6.  
    7.   
  
  
  
  7.     @Autowired 
    8.   
  
  
  
  8.     private TianProperties properties; 
    9.   
  
  
  
  9.  
    10.   
  
  
  
  10.     @Bean 
    11.   
  
  
  
  11.     @ConditionalOnMissingBean(TianService.class) 
    12.   
  
  
  
  12.     public TianService tianService() { 
    13.   
  
  
  
  13.         return new TianService(properties); 
    14.   
  
  
  
  14.     } 
    15.   
  
  
  
  15. } 
    16.

在resources下创建目录META-INF，在 META-INF 目录下创建 spring.factories，在SpringBoot启动时会根据此文件来加载项目的自动化配置类。

「spring.factories中配置」

 
 
 
 
    
  
  
  
  
  1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tian.TianServiceAutoConfiguration 
    2.

把上面这个starter工程打成jar包：

使用自定义starter

创建一个Spring Boot项目test，项目整体如下图：

在项目中把自定义starter添加pom依赖

 
 
 
 
    
  
  
  
  
  1.  
    2.   
  
  
  
  2.     com.tian 
    3.   
  
  
  
  3.     spring-boot-tian-starter 
    4.   
  
  
  
  4.     1.0-SNAPSHOT 
    5.   
  
  
  
  5.  
    6.

TestApplication启动类

 
 
 
 
    
  
  
  
  
  1. @SpringBootApplication 
    2.   
  
  
  
  2. @EnableEurekaServer 
    3.   
  
  
  
  3. public class TestApplication { 
    4.   
  
  
  
  4.     public static void main(String[] args) { 
    5.   
  
  
  
  5.         SpringApplication.run(TestApplication.class, args); 
    6.   
  
  
  
  6.     } 
    7.   
  
  
  
  7. } 
    8.

application.properties中配置

 
 
 
 
    
  
  
  
  
  1. spring.tian.name=tian 
    2.   
  
  
  
  2. spring.tian.age=22 
    3.   
  
  
  
  3. spring.tian.sex=M 
    4.

写一个TestController.java类

 
 
 
 
    
  
  
  
  
  1. RestController 
    2.   
  
  
  
  2. @RequestMapping("/my") 
    3.   
  
  
  
  3. public class TestController { 
    4.   
  
  
  
  4.  
    5.   
  
  
  
  5.     @Resource 
    6.   
  
  
  
  6.     private TianService tianService; 
    7.   
  
  
  
  7.  
    8.   
  
  
  
  8.     @PostMapping("/starter") 
    9.   
  
  
  
  9.     public Object starter() { 
    10.   
  
  
  
  10.         tianService.sayHello(); 
    11.   
  
  
  
  11.         return "ok"; 
    12.   
  
  
  
  12.     } 
    13.   
  
  
  
  13. } 
    14.

把我们自定义的starter打成的jar依赖进来后，

可以看到其中多了一个json的文件。

最后启动项目，输入

http://localhost:9091/my/starter

controller成功返回ok，再看后台打印

 
 
 
 
    
  
  
  
  
  1. hi, 我叫: tian, 今年22岁, 性别: M 
    2.

这就成功的现实了自定义的starter。

关键词：开箱即用、减少大量的配置项、约定大于配置。

总结

  1. Spring Boot在启动时扫描项目所依赖的JAR包，寻找包含spring.factories文件的JAR包，
  2. 然后读取spring.factories文件获取配置的自动配置类AutoConfiguration`，
  3. 然后将自动配置类下满足条件(@ConditionalOnXxx)的@Bean放入到Spring容器中(Spring Context)
  4. 这样使用者就可以直接用来注入，因为该类已经在容器中了。

本文转载自微信公众号「Java后端技术全栈」，可以通过以下二维码关注。转载本文请联系Java后端技术全栈公众号。

 

网站标题：徒手撸一个SpringBoot中的starter，解密自动化配置
文章链接：http://www.shufengxianlan.com/qtweb/news18/103718.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

全网营销推广知识

行业网站建设

雕琢时光　　 　明安消防器材　　 　微信网站开发　　 　添翼二手车鉴定　　 　成都微信开发　　 　户外广告设计　　 　成都画册设计　　 　郫县门窗定制　　 　网站seo　　 　双流做网站　　 　域名ssl证书　　 　成都微信小程序　　 　定制网站　　 　成都网站营销推广　　 　全网营销　　 　成都门窗定制　　 　成都网站设计制作公司　　 　医药医疗网站建设方案　　 　网上商城开发　　 　四川服务器托管