自定义springboot starter

一、什么是springboot starter

　　自己写一个jar包，读取application.yml（application.properties）文件的配置节点到对象里面，springboot在启动的时候，会执行jar包，并把对象交给spring。我们在使用对象的时候，引入jar包，直接用@autowired引入注解即可。

　　关于命名规则，spring官方的命名规则为：spring-boot-starter-XXX，建议自定义starter的命名为：组织标识-spring-boot-starter-XXX。

二、springboot starter的配置方式

　　1、在resources下新建META-INF文件夹，新建文件名称为：spring.factories，里面写入我们要自动配置的类的全路径。

　　2、注解方式。

三、spring.factories方式实现

　　1、新建maven项目。

　　2、把pom文件的packaging改为jar

　　3、引入依赖，

 <!--主要是为编译器配置的 可以根据properties 鼠标右键 点到用这个属性的类上个-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <!--主要是为了自动装配-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>

　　4、编写配置类

public class UserInfo {
    private String userName;
    private Integer age;
    private String addr;

     //get set 省略      
}

　　5、编写读取配置文件的类

@ConfigurationProperties(prefix = "user")
public class AutoConfigurationProperties {
    private String userName;
    private Integer age;
    private String addr;

    //get set省略
}

　　6、编写资源类，把读取的配置节点赋给配置类

@Configuration
@EnableConfigurationProperties(AutoConfigurationProperties.class)
@ConditionalOnClass(UserInfo.class)
public class MyAutoConfigurationClass {

    @Autowired
    private AutoConfigurationProperties autoConfigurationProperties;

    @ConditionalOnMissingBean
    @Bean
    public UserInfo getUserInfo(){
        UserInfo userInfo = new UserInfo();
        userInfo.setUserName(autoConfigurationProperties.getUserName());
        userInfo.setAge(autoConfigurationProperties.getAge());
        userInfo.setAddr(autoConfigurationProperties.getAddr());
        return userInfo;
    }

}

　　7、在resources文件夹下新建META-INF文件夹，新建spring.factories文件，添加内容

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.rana.MyAutoConfigurationClass

　　8、执行maven install命令，打包到本地

四、测试

　　1、新建测试项目。

　　2、引入依赖。

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

　　3、添加application.yml配置节点

user:
  user-name: xxx
  age: 18
  addr: tongzhou beijing

　　4、引用

    @Autowired
    private UserInfo userInfo;

    @RequestMapping("/getuserinfo")
    public String getUserInfo(){
        return userInfo.getUserName();
    }