springboot自定义stater

简介

SpringBoot starter机制

SpringBoot由众多Starter组成（一系列的自动化配置的starter插件），SpringBoot之所以流行，也是因为starter。starter是SpringBoot非常重要的一部分，可以理解为一个可拔插式的插件，正是这些starter使得使用某个功能的开发者不需要关注各种依赖库的处理，不需要具体的配置信息，由Spring Boot自动通过classpath路径下的类发现需要的Bean，并织入相应的Bean。

例如，你想使用Reids插件，那么可以使用spring-boot-starter-redis；如果想使用MongoDB，可以使用spring-boot-starter-data-mongodb

为什么要自定义starter

开发过程中经常会有一些独立于业务之外的配置模块.如果我们将这些可独立于业务代码之外的功能配置模块封装成一个stater,复用的时候只需要将其在pom中引用依赖即可,springboot为我们自动完成装配

自定义stater的命名机制

springboot提供的stater一springboot-stater-xxx的方式命名的,官方建议自定义的stater使用xxx-spring-boot-stater规则命名,以区分springboot生态提供的stater

实例

创建自定义stater

1. 新建maven jar工程,工程名为zdy-spring-boot-stater,导入依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
        <version>2.2.2.RELEASE</version>
    </dependency>
</dependencies>

编写javaBean

package com.lagou;
 
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
 
@EnableConfigurationProperties(SimpleBean.class) // 开启@ConfigurationProperties
@ConfigurationProperties(prefix = "simplebean")
public class SimpleBean {
    private int id;
    private String name;
 
    @Override
    public String toString() {
        return "SimpleBean{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
 
    public int getId() {
        return id;
    }
 
    public void setId(int id) {
        this.id = id;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
}

配置类MyAutoConfiguration

package com.lagou.config;
 
import com.lagou.SimpleBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
@Configuration
@ConditionalOnClass// 注解：当类路径classpath下有指定类的情况，就会进行自动配置
public class MyAutoConfiguration {
    static {
        System.out.println("MyAutoConfiguration init....");
    }
 
    @Bean
    public SimpleBean simpleBean() {
        return new SimpleBean();
    }
}

resource下创建/META-INF/spring.factories

注意：META-INF是自己手动创建的目录，spring.factories也是手动创建的文件,在该文件中配置自己的自动配置类

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.lagou.config.MyAutoConfiguration

使用自定义stater

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

在全局配置文件中配置属性值

simplebean.id=1
simplebean.name=自定义starter

编写测试方法

//测试自定义starter
@Autowired
private SimpleBean simpleBean;
@Test
public void zdyStarterTest(){
    System.out.println(simpleBean);
}

总结

编写

1. 导入spring-boot-autoconfigure
2. 编写javabean
3. 编写配置类
4. resource下创建/META-INF/spring.factories,配置上自己的配置类

使用

1. 导入配置类的依赖
2. yml配置属性值
3. 注入,使用