自定义spring-boot-starter

自定义加载spring-boot-starter

第一步

• 创建一个Maven空项目 luban-spring-boot-starter
  

• 引入基础依赖

 <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starterartifactId>
        <version>2.5.0version>
    dependency>
    <dependency>
        <groupId>org.projectlombokgroupId>
        <artifactId>lombokartifactId>
        <version>1.18.28version>
    dependency>
1
2
3
4
5
6
7
8
9
10

第二步

• 创建配置类UserAutoConfiguration

@Configuration
@ConditionalOnProperty(prefix = "user", value = "enable",havingValue = "true",matchIfMissing = false)
public class UserAutoConfiguration {
    @Bean(name = "user")
    @ConditionalOnMissingBean(value =  User.class)
    public User getUser() {
        User user = new User();
        user.setName("张三");
        user.setAge(18);
        user.setGender("男");
        return user;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

其中该配置类的加载条件为配置文件中 user.enable=true ,不存在或者不为true，则不加载。

getUser()方法生效的条件为当前环境变量中不存在名为user的Bean对象，目的让使用者自定义的user Bean对象生效

• User类

@Data
public class User {
    private String name;
    private Integer age;
    private String gender;
}
1
2
3
4
5
6

第三步

• 在resources目录下创建META-INF\spring.factories文件
• 在spring.factories中写入需要spring-boot自动加载的类，通常名为xxxAutoConfiguration
• 打包项目----》发布到Maven私服/安装到本地Maven

固定格式为Key-Value形式
EnableAutoConfiguration的全路径名称 = 自定义配置类的全路径名称 \ 为换行符

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.cxl.luban.UserAutoConfiguration
1
2

第四步

• 使用者引入依赖

 		<dependency>
            <groupId>com.cxlgroupId>
            <artifactId>luban-spring-boot-starterartifactId>
            <version>2.5.0version>
        dependency>
1
2
3
4
5

• 配置文件中配置：

user: 
	enable: true
1
2

• 使用user的Bean对象

@Autowired
private User user;

 public void getName(){
 	user.getName();
 }
1
2
3
4
5
6