根据自动装配原理在Springboot项目中自定义starter,并实现热插拔技术
自定义starter
简单步骤
- 创建项目,并引入autoconfigure依赖,根据自己的需要选择spring-boot的版本号
- maven项目:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>[自己选择spring-boot的版本号]</version>
</dependency>
- gradle
implementation 'org.springframework.boot:spring-boot-autoconfigure:指定的版本号'
- 创建自己注入的组件/bean/service的java类
@ConfigurationProperties(prefix = "mystarter")
public class MyStarterBean {
private Integer id;
private String name;
// getting/setting 省略
}
- 创建自动装配Class
@Configuration
public class MyAutoConfiguration {
@Bean
public MyStarterBean myStarterBean(){
return new MyStarterBean();
}
}
- 在项目的resource目录下新建META-INF目录,并创建一个名为
spring.factories
的文件
在文件中
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.chenglj.starter.MyAutoConfiguration
使用测试
- 直接引入自定义的starter依赖
- 试着在配置文件中配置属性
mystarter.id = 250000
mystarter.name = cheng
- 测试
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)
@RunWith(SpringRunner.class)
public class MySpringBootTest {
@Resource
MyStarterBean myStarterBean;
@Test
public void test(){
System.out.println(myStarterBean.getId()+"="+myStarterBean.getName());
}
}
优化(热插拔技术)
- 创建一个标记类
public class MyStarterBeanMarker {
}
- 创建一个enable注解
@Target({
ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import({
MyStarterBeanMarker.class})
public @interface EnableRegisterMyStarter {
}
3.在自动装配类中添加添加条件
@Configuration
@ConditionalOnBean(MyStarterBeanMarker.class) //只有容器中有MyStarterBeanMarker这个bean时才会扫描这个配置类
public class MyAutoConfiguration {
@Bean
public MyStarterBean createBean(){
return new MyStarterBean();
}
}
- 测试
在SpringBoot启动主类加上自定义的注解@EnableRegisterMyStarter
,不添加则无法注入MyStarterBean。
@SpringBootApplication
@EnableRegisterMyStarter
public class TestApplication {
}