关于java:徒手撸一个Spring-Boot中的starter

starter背景

Spring Boot目前曾经变成了后端开发这必备技能之一,其中一个次要起因是Spring Boot中有个十分重要的机制(starter机制)。

starter可能摈弃以前繁冗的配置,将其对立集成进starter,应用的时候只须要在maven中引入对应的starter依赖即可,Spring Boot就能主动扫描到要加载的信息并启动相应的默认配置。

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

[[金三银四,如何涨薪看这里]](http://mp.weixin.qq.com/s?__b…

咱们常常会看到或者应用到各种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

pom.xml依赖

<dependencies>
 <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>2.0.0.RELEASE</version>
 </dependency>
 <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <version>2.0.0.RELEASE</version>
    <optional>true</optional>
  </dependency>
</dependencies>

依据须要自定义Starter的实现过程大抵如下(以我定义的Starter为例):

定义XxxProperties类,属性配置类,实现属性配置相干的操作,比方设置属性前缀,用于在application.properties中配置。

TianProperties代码:

import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "spring.tian")
public class TianProperties {
    private String name;
    private int age;
    private String sex = "M";
    //省略 get set 办法
}

创立XxxService类,实现相干的操作逻辑 。

TianService代码:

public class TianService {
    private TianProperties properties;
    public TianService() {
    }
    public TianService(TianProperties userProperties) {
        this.properties = userProperties;
    }
    public void sayHello(){
        System.out.println("hi, 我叫: " + properties.getName() +
        ", 往年" + properties.getAge() + "岁"
         + ", 性别: " + properties.getSex());
    }
}

定义XxxConfigurationProperties类,主动配置类,用于实现Bean创立等工作。

TianServiceAutoConfiguration代码:

@Configuration
@EnableConfigurationProperties(TianProperties.class)
@ConditionalOnClass(TianService.class)
@ConditionalOnProperty(prefix = "spring.tian", value = "enabled", matchIfMissing = true)
public class TianServiceAutoConfiguration {
    @Autowired
    private TianProperties properties;
    @Bean
    @ConditionalOnMissingBean(TianService.class)
    public TianService tianService() {
        return new TianService(properties);
    }
}

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

「spring.factories中配置」

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

把下面这个starter工程打成jar包:

应用自定义starter

创立一个Spring Boot我的项目test,我的项目整体如下图:

在我的项目中把自定义starter增加pom依赖

<dependency>
    <groupId>com.tian</groupId>
    <artifactId>spring-boot-tian-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

TestApplication启动类

@SpringBootApplication
@EnableEurekaServer
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }
}

application.properties中配置

spring.tian.name=tian
spring.tian.age=22
spring.tian.sex=M

写一个TestController.java类

RestController
@RequestMapping("/my")
public class TestController {
    @Resource
    private TianService tianService;
    @PostMapping("/starter")
    public Object starter() {
        tianService.sayHello();
        return "ok";
    }
}

把咱们自定义的starter打成的jar依赖进来后,

能够看到其中多了一个json的文件。

最初启动我的项目,输出

http://localhost:9091/my/starter

controller胜利返回ok,再看后盾打印

hi, 我叫: tian, 往年22岁, 性别: M

这就胜利的事实了自定义的starter。

关键词:开箱即用、缩小大量的配置项、约定大于配置

总结

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

「只有咱们的方向对了,就不怕路远!」

举荐浏览

面试:Zookeeper常见11个连环炮
金三银四,筹备跳槽的看这里!
面试:说说几个常见的Linux性能

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

这个站点使用 Akismet 来减少垃圾评论。了解你的评论数据如何被处理