前言
平时我们在工作中总会写一些非业务相关的公共代码,这些公共代码通常会单独放置到一个模块中,在使用springBoot进行开发时,spring团队为我们提供了许多开箱即用的starter,那么怎么创建一个自己的starter,将这些公共的非业务代码封装起来呢
创建starter子模块
先看一下项目的结构
下面开始创建我们的demo-spring-boot-starter
1.创建properties属性实体
@ConfigurationProperties(prefix = "spring.demo")
public class DemoProperties {
private String name;
private Integer age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
}
2.创建service
public class DemoService {
private final DemoProperties demoProperties;
public DemoService(DemoProperties demoProperties) {
this.demoProperties = demoProperties;
}
public void test(){
System.out.println(this.demoProperties.getName() +"-"+this.demoProperties.getAge());
}
}
3.创建autoConfig
@Configuration
@ConditionalOnClass(DemoProperties.class)
@EnableConfigurationProperties(DemoProperties.class)
public class DemoAutoConfiguration {
private DemoProperties demoProperties;
@Bean
@ConditionalOnMissingBean
public DemoService demoService(){
return new DemoService(demoProperties);
}
}
这里简单介绍一下几个条件注解的使用
- @ConditionalOnBean //要求bean存在时,才会创建这个bean
- @ConditionalOnMissingBean //要求bean不存在时,才会创建这个bean
- @ConditionalOnClass //要求class存在时,才会创建这个bean
- @ConditionalOnMissingClass //要求class不存在时,才会创建这个bean
这些条件注解可以控制bean的注入时机,不至于使第三方引入我们的依赖时,因为没有某个bean或者class而抛出异常
除此之后,还有@DependsOn等注解可以控制bean的注入顺序;
4.创建spring.factories,暴露autoConfig
在resources文件夹下创建META-INF文件夹后,创建spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration= \
com.demo.config.DemoAutoConfiguration
至此一个自定义的starter就创建好了,接下来就可以打成jar,快乐的使用了。