210630:springBoot自动配置-自定义start

时间:2021-7-3 作者:qvyue

一. 自动配置原理

Spring Boot关于自动配置的源码在spring-boot-autoconfigure-x.x.x.x.jar中:

210630:springBoot自动配置-自定义start

当然,自动配置原理的相关描述,官方文档貌似是没有提及。不过我们不难猜出,Spring Boot的启动类上有一个@SpringBootApplication注解,这个注解是Spring Boot项目必不可少的注解。那么自动配置原理一定和这个注解有着千丝万缕的联系!

1. @EnableAutoConfiguration

210630:springBoot自动配置-自定义start

@SpringBootApplication是一个复合注解或派生注解,在@SpringBootApplication中有一个注解@EnableAutoConfiguration,翻译成人话就是开启自动配置,其定义如下:

210630:springBoot自动配置-自定义start

而这个注解也是一个派生注解,其中的关键功能由@Import提供,其导入的AutoConfigurationImportSelector的selectImports()方法通过SpringFactoriesLoader.loadFactoryNames()扫描所有具有META-INF/spring.factories的jar包。spring-boot-autoconfigure-x.x.x.x.jar里就有一个这样的spring.factories文件。

这个spring.factories文件也是一组一组的key=value的形式,其中一个key是EnableAutoConfiguration类的全类名,而它的value是一个xxxxAutoConfiguration的类名的列表,这些类名以逗号分隔,如下图所示:

210630:springBoot自动配置-自定义start

这个@EnableAutoConfiguration注解通过@SpringBootApplication被间接的标记在了Spring Boot的启动类上。在SpringApplication.run(…)的内部就会执行selectImports()方法,找到所有JavaConfig自动配置类的全限定名对应的class,然后将所有自动配置类加载到Spring容器中。

二. 自动配置生效

每一个XxxxAutoConfiguration自动配置类都是在某些条件之下才会生效的,这些条件的限制在Spring Boot中以注解的形式体现,常见的条件注解有如下几项:

  • @ConditionalOnBean:当容器里有指定的bean的条件下。
  • @ConditionalOnMissingBean:当容器里不存在指定bean的条件下。
  • @ConditionalOnClass:当类路径下有指定类的条件下。
  • @ConditionalOnMissingClass:当类路径下不存在指定类的条件下。
  • @ConditionalOnProperty:指定的属性是否有指定的值,比如@ConditionalOnProperties(prefix=”xxx.xxx”, value=”enable”, matchIfMissing=true),代表当xxx.xxx为enable时条件的布尔值为true,如果没有设置的情况下也为true。

以ServletWebServerFactoryAutoConfiguration配置类为例,解释一下全局配置文件中的属性如何生效,比如:server.port=8081,是如何生效的(当然不配置也会有默认值,这个默认值来自于org.apache.catalina.startup.Tomcat)。

210630:springBoot自动配置-自定义start

在ServletWebServerFactoryAutoConfiguration类上,有一个@EnableConfigurationProperties注解:开启配置属性,而它后面的参数是一个ServerProperties类,这就是习惯优于配置的最终落地点。

210630:springBoot自动配置-自定义start

在这个类上,我们看到了一个非常熟悉的注解:@ConfigurationProperties,它的作用就是从配置文件中绑定属性到对应的bean上,而@EnableConfigurationProperties负责导入这个已经绑定了属性的bean到spring容器中(见上面截图)。那么所有其他的和这个类相关的属性都可以在全局配置文件中定义,也就是说,真正“限制”我们可以在全局配置文件中配置哪些属性的类就是这些XxxxProperties类,它与配置文件中定义的prefix关键字开头的一组属性是唯一对应的。

至此,我们大致可以了解。在全局配置的属性如:server.port等,通过@ConfigurationProperties注解,绑定到对应的XxxxProperties配置实体类上封装为一个bean,然后再通过@EnableConfigurationProperties注解导入到Spring容器中。

而诸多的XxxxAutoConfiguration自动配置类,就是Spring容器的JavaConfig形式,作用就是为Spring 容器导入bean,而所有导入的bean所需要的属性都通过xxxxProperties的bean来获得。

可能到目前为止还是有所疑惑,但面试的时候,其实远远不需要回答的这么具体,你只需要这样回答:

Spring Boot启动的时候会通过@EnableAutoConfiguration注解找到META-INF/spring.factories配置文件中的所有自动配置类,并对其进行加载,而这些自动配置类都是以AutoConfiguration结尾来命名的,它实际上就是一个JavaConfig形式的Spring容器配置类,它能通过以Properties结尾命名的类中取得在全局配置文件中配置的属性如:server.port,而XxxxProperties类是通过@ConfigurationProperties注解与全局配置文件中对应的属性进行绑定的。

三. 什么是starter

Starter可以理解为一个可拔插式的插件,提供一系列便利的依赖描述符,您可以获得所需的所有Spring和相关技术的一站式服务。应用程序只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。用一句话描述,就是springboot的场景启动器。

1. 自定义starter

官方定义的starter命名都是spring-boot-starter-xxx,我们自己定义的一般都 xxx-spring-boot-starter,新建一个ruangh-id-gengerate-spring-boot-starter项目

导入springboot 包spring-boot-starter

org.springframework.bootspring-boot-starterorg.springframework.bootspring-boot-configuration-processortrueorg.projectlomboklomboktrue

2. 创建映射配置类

定义一个映射配置新的的类IdProperties和LockieProperties,添加注解ConfigurationProperties(“machine.id”),我们的配置文件以machine.id开头,比如mathine.id.name=boot-order,另外一个配置是已spring.lockie开头的

210630:springBoot自动配置-自定义start
210630:springBoot自动配置-自定义start
package com.ruangh.start.config;
@Data
@ConfigurationProperties("machine.id")
public class IdProperties {
    private String name;
}


package com.ruangh.start.config;
@Data
@ConfigurationProperties("spring.lockie")
public class LockieProperties {
    private String prefix;
    private String suffix;
}

3. 创建接口对应业务

IdService里面有个getId方法用来生成自定义的ID

package com.ruangh.start.service;

@Data
public class IdService {
    private IdProperties idProperties;

    /**
     * 获取id
     * @return
     */
    public String getId(){
        return idProperties.getName() + "-" + System.currentTimeMillis();
    }
}

package com.ruangh.start.service;

@Data
public class LockieService {
    LockieProperties lockieProperties;
    public String hello(String name){
        return lockieProperties.getPrefix() + "-" + name + "-" +lockieProperties.getSuffix();
    }
}

4. 创建配置类

  • @Configuration:配置类
  • @EnableConfigurationProperties():开启某属性类,里面封装的是属性信息,相当于@ConfigurationProperties加载application.properties里面的信息,并用@Component将类交由spring管理
  • @ConditionalOnClass():当这个类存在时,再进行下面的步骤,否则就不进行下面的步骤了
  • @AutoConfigureAfter():当自动配置完成后,再执行里面的类
  • @ConfigurationOnMissBean():当这个bean不存在时,再添加bean类
  • @Bean:添加bean类
package com.ruangh.start.configuation;

@Configuration
@EnableConfigurationProperties(IdProperties.class)
public class IdAutoConfiguation {
    @Autowired
    private IdProperties idProperties;
    @Bean
    public IdService idService(){
        IdService idService = new IdService();
        idService.setIdProperties(idProperties);
        return idService;
    }
}


package com.ruangh.start.configuation;

@Configuration
@EnableConfigurationProperties({LockieProperties.class})
public class LockieAutoConfiguration {
    @Autowired
    LockieProperties lockieProperties;
    @Bean
    public LockieService lockieService(){
        LockieService lockieService = new LockieService();
        lockieService.setLockieProperties(lockieProperties);
        return lockieService;
    }
}

5. 添加文件spring.factories

在resources目录下创建META-INF目录,并添加文件spring.factories。在这个文件中配置EnableAutoConfiguration,具体如下:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
  com.ruangh.start.configuation.IdAutoConfiguation,
  com.ruangh.start.configuation.LockieAutoConfiguration
210630:springBoot自动配置-自定义start

6. 测测自定义的start

创建一个模块,在pom文件中增加依赖

210630:springBoot自动配置-自定义start
210630:springBoot自动配置-自定义start
com.ruangh.studyruangh-id-gengerate-spring-boot-starter0.0.1-SNAPSHOT

启动类上添加注解

@SpringBootApplication(scanBasePackages = "com.ruangh")

配置文件增加配置参数

210630:springBoot自动配置-自定义start

添加测试类

210630:springBoot自动配置-自定义start
@SpringBootTest
@ContextConfiguration(classes = DemoApplication.class)
public class DemoTest {
    @Autowired
    private IdService idService;
    @Autowired
    private LockieService lockieService;
    @Test
    public void testId(){
        String id = idService.getId();
        System.out.println("生成id--》"+id);
    }
    @Test
    public void testLockie(){
        System.out.println(lockieService.hello("小明"));

    }
}

运行一下查看结果,看到结果是我们想要的,至此我们自定义一个starter就成功了,总结一下就是要创建3个类1个配置文件,xxProperties,xxService,xxAutoConfiguation和spring.factories

210630:springBoot自动配置-自定义start
声明:本文内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:qvyue@qq.com 进行举报,并提供相关证据,工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。