Spring Boot starter原理

Spring Boot 将常见的开发性能,分成了一个个的starter,这样咱们开发性能的时候只须要引入对应的starter,而不须要去引入一堆依赖了!starter能够了解为一个依赖组,其次要性能就是实现引入依赖初始化配置。Spring 官网提供的starter 命名标准为 spring-boot-starter-xxx ,第三方提供的starter命名标准为 xxx-spring-boot-starter

这里咱们以 RocketMQ 的依赖 rocketmq-spring-boot-starter 来学习 starter的原理。

在我的项目中引入 rocketmq-spring-boot-starter 之后,实际上就引入了 rocketmq 的一些相干依赖。

rocketmq-spring-boot 中有一个主动拆卸的类RocketMQAutoConfiguration ,我截取了其中的一小段代码,一起来看看。

@Configuration@EnableConfigurationProperties(RocketMQProperties.class)@ConditionalOnClass({MQAdmin.class})@ConditionalOnProperty(prefix = "rocketmq", value = "name-server", matchIfMissing = true)@Import({MessageConverterConfiguration.class, ListenerContainerConfiguration.class, ExtProducerResetConfiguration.class, RocketMQTransactionConfiguration.class})@AutoConfigureAfter({MessageConverterConfiguration.class})@AutoConfigureBefore({RocketMQTransactionConfiguration.class})public class RocketMQAutoConfiguration {    private static final Logger log = LoggerFactory.getLogger(RocketMQAutoConfiguration.class);    public static final String ROCKETMQ_TEMPLATE_DEFAULT_GLOBAL_NAME =        "rocketMQTemplate";    @Autowired    private Environment environment;    @Bean(destroyMethod = "destroy")    @ConditionalOnBean(DefaultMQProducer.class)    @ConditionalOnMissingBean(name = ROCKETMQ_TEMPLATE_DEFAULT_GLOBAL_NAME)    public RocketMQTemplate rocketMQTemplate(DefaultMQProducer mqProducer,        RocketMQMessageConverter rocketMQMessageConverter) {        RocketMQTemplate rocketMQTemplate = new RocketMQTemplate();        rocketMQTemplate.setProducer(mqProducer);        rocketMQTemplate.setMessageConverter(rocketMQMessageConverter.getMessageConverter());        return rocketMQTemplate;    }}
  • @Configuration 阐明这是一个配置类,类中被@Bean注解了的办法,就是spring的一个bean,例如rocketMQTemplate
  • @EnableConfigurationProperties,启用被@ConfigurationProperties的bean,这里引入了 RocketMQProperties

RocketMQProperties 就是须要在yml文件中写入的属性。

@ConfigurationProperties(prefix = "rocketmq")public class RocketMQProperties {    private String nameServer;    private String accessChannel;    private Producer producer;    private Consumer consumer = new Consumer();}

在Spring Boot我的项目启动的时候默认只会扫描上级目录下带 @Configuration 注解的类,那么像本文中提到的 RocketMQAutoConfiguration 是如何扫描的呢?其实我的项目启动的时候会去加载我的项目中所有的 spring.factories 文件,而后加载对应的配置类,因而咱们就须要在 spring.factories 中只指定须要扫描的类。

原理搞明确了,接下来咱们就简略实现一个本人的starter!这个starter的次要作用就是给一个对象尾部拼接一个字符串!

一、新建我的项目

新建一个名为 javatip-spring-boot-starter 的我的项目,并且引入上面的依赖

<dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter</artifactId></dependency>

二、新增配置类

配置类对应的properties文件中的属性为javatip.name

@ConfigurationProperties(prefix = "javatip")public class JavatipPorperties {    private String name;    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }}

三、新增拼接字符串的办法

此办法次要就是为对象拼接一个固定的字符串

public class StrUt {    private String name;    public String strTo(Object object){        return object +"---"+ getName();    }    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }}

四、新增主动配置类

应用注解 @EnableConfigurationProperties 启用 JavatipProperties 配置类

应用注解 @Configuration 配合 @Bean 注册一个拼接字符串的bean对象。

@Configuration@EnableConfigurationProperties(JavatipPorperties.class)public class JavatipAutoConfiguration {    @Autowired    private JavatipPorperties javatipPorperties;    @Bean    public StrUt strut(){        StrUt strut = new StrUt();        strut.setName(javatipPorperties.getName());        return strut;    }}

五、新增配置发现文件

在resources文件夹中新建 META-INF 文件夹,在 META-INF 文件夹中新建配置发现文件 spring.factories,并且将主动配置类写到文件里。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.javatip.str.configuration.JavatipAutoConfiguration

六、打包测试

应用 mvn install 命令将我的项目打包推送到本地maven仓库,而后新建一个测试项目,引入打包好的依赖。

<dependency>    <groupId>com.javatip</groupId>    <artifactId>javatip-spring-boot-starter</artifactId>    <version>0.0.1-SNAPSHOT</version></dependency>

application.yml 文件中写入主动拼接的字符串对应的属性 javatip.name

javatip:  name: Java旅途

而后手写一个测试类:

@RestControllerpublic class Test {        @Autowired    private StrUt strUt;    @GetMapping("test")    public String test(){        String str = strUt.strTo("who are you?");        return str;    }}

运行测试类后,页面返回了

who are you?---Java旅途

这样,一个简略的starter就写好了,只有了解了starter的原理,实现起来就很简略,第一点就是starter相当于一个依赖组,另一点就是starter能够实现初始化配置。