自定义Starter
Spring Boot starter机制
Starter机制目的是抛弃以前繁杂的配置，将其统一集成为starter，应用者引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。
常见的 starter：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
为什么要自定义starter
在我们的日常开发工作中，经常会有一些独立于业务之外的配置模块，我们经常将其放到一个特定
的包下，然后如果另一个工程需要复用这块功能的时候，需要将代码硬拷贝到另一个工程，重新集
成一遍，麻烦至极。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter，
复用的时候只需要将其在pom中引用依赖即可，再由SpringBoot为我们完成自动装配，就非常轻
松了
自定义starter的命名规则
springboot官方提供的starter以spring-boot-starter-xxx的方式命名的。
官方建议自定义的starter使用xxx-sping-boot-starter命名规则命名。以区分SpringBoot生态提供的starter。
自定义starter代码实现
分为两个部分：
- 自定义starter
- 使用starter
自定义starter
(1) 新建maven工程，工程名为custom-boot-starter，引入依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.5.1</version>
</dependency>
(2)编写javaBean
package com.xdf.starter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
/**
* @author xdf
* @date 2021/6/29
* @description
*/
@EnableConfigurationProperties(SimpleBean.class)
@ConfigurationProperties(prefix = "simplebean")
public class SimpleBean {
private int id;
private String 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;
}
@Override
public String toString() {
return "SimpleBean{" +
"id=" + id +
", name='" + name + '\'' +
'}';
}
}
(3)编写配置类
package com.xdf.starter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @author xdf
* @date 2021/6/29
* @description
*/
@Configuration
public class MyAutoConfiguration {
static {
System.out.println("MyAutoConfiguration init ...");
}
@Bean
public SimpleBean simpleBean() {
return new SimpleBean();
}
}
(4)创建META-INF/spring.factories，添加自动配置类
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.xdf.starter.MyAutoConfiguration
使用starter
创建Springboot工程
引入依赖：
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.xdf</groupId>
<artifactId>custom-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
编写配置文件：
simplebean:
id: 1
name: xdf1
编写配置类：
/**
* @author xdf
* @date 2021/6/29
* @description
*/
@SpringBootTest
public class Test {
@Autowired
private SimpleBean simpleBean;
@org.junit.jupiter.api.Test
public void startTest() {
System.out.println(simpleBean);
}
}
simplebean能正常注入并打印正确的值，说明starter编写正确。
问题：只要引入了custom-boot-starter，simplebean就一定会被创建。如何解决？
热插拔技术
很多组件都会有@EnableXXX注解来启用组件
image
这就是热插拔技术
我们将我们的自定义starter进行改造：
新建ConfigMarker类：
package com.xdf.starter;
/**
* @author xdf
* @date 2021/6/29
* @description
*/
public class ConfigMarker {
}
创建EnableSimpleBean注解
package com.xdf.starter;
import org.springframework.context.annotation.Import;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import({ConfigMarker.class})
public @interface EnableSimpleBean {
}
在MyAutoConfiguration类上加上ConditionalOnBean方法，按条件加载：
/**
* @author xdf
* @date 2021/6/29
* @description
*/
@Configuration
@ConditionalOnBean(ConfigMarker.class)
public class MyAutoConfiguration {
static {
System.out.println("MyAutoConfiguration init ...");
}
@Bean
public SimpleBean simpleBean() {
return new SimpleBean();
}
}
测试：
在测试项目的启动类上加@EnableConfigurationProperties注解，启动测试方法测试，能正常打印。
@SpringBootApplication
@EnableConfigurationProperties
public class SpringBootDemoApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootDemoApplication.class, args);
}
}
去掉@EnableConfigurationProperties注解，测试方法抛出异常。
条件注解
- @ConditionalOnBean：仅仅在当前上下文中存在某个对象时，才会实例化一个Bean。
- @ConditionalOnClass：某个class位于类路径上，才会实例化一个Bean。
- @ConditionalOnExpression：当表达式为true的时候，才会实例化一个Bean。基于SpEL表
- 达式的条件判断。
- @ConditionalOnMissingBean：仅仅在当前上下文中不存在某个对象时，才会实例化一个
- Bean。
- @ConditionalOnMissingClass：某个class类路径上不存在的时候，才会实例化一个Bean。
- @ConditionalOnNotWebApplication：不是web应用，才会实例化一个Bean。
- @ConditionalOnWebApplication：当项目是一个Web项目时进行实例化。
- @ConditionalOnNotWebApplication：当项目不是一个Web项目时进行实例化。
- @ConditionalOnProperty：当指定的属性有指定的值时进行实例化。
- @ConditionalOnJava：当JVM版本为指定的版本范围时触发实例化。
- @ConditionalOnResource：当类路径下有指定的资源时触发实例化。
- @ConditionalOnJndi：在JNDI存在的条件下触发实例化。
- @ConditionalOnSingleCandidate：当指定的Bean在容器中只有一个，或者有多个但是指定
- 了首选的Bean时触发实例化。
网友评论