SpringBoot-自定义Start
一、SpringBoot Starter机制SpringBoot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的
一、SpringBoot Starter机制
SpringBoot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,
SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。
SpringBoot会自动通过classpath路径下的类发现需要的Bean,并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。
比如我们在springboot里面要引入rabbitmq,那么我们需要在pom中引入以下内容:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-amqp</artifactId>
</dependency>
这其实就是一个starter。简而言之,starter就是一个外部的项目,我们需要使用它的时候就可以在当前springboot项目中引入它。
二、为什么要自定义starter
在我们的日常开发工作中,经常会有一些独立于业务之外的配置模块,我们经常将其放到一个特定的包下,然后如果另一个工程需要复用这块功能的时候,
需要将代码硬拷贝到另一个工程,重新集成一遍,麻烦至极。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter,
复用的时候只需要将其在pom中引用依赖即可,再由SpringBoot为我们完成自动装配,就非常轻松了
三、自定义starter的案例
以下案例是开发中遇到的部分场景
▲ 动态数据源。
▲ 登录模块。
▲ 基于AOP技术实现日志切面。
.........
四、自定义starter的命名规则
SpringBoot提供的starter以spring-boot-starter-xxx 的方式命名的。
官方建议自定义的starter使用xxx-spring-boot-starter 命名规则。以区分SpringBoot生态提供的starter
五、自定义starter代码实现
整个过程分为两部分:
自定义starter
使用starter
5.1 自定义starter
首先,先完成自定义starter
5.1.1 新建Spring initializr工程web
勾选选择web 中spring web,点击完成,项目如下:
新建web项目的maven项目字模块如下:
一直下一步,完成如上图圈红模块
5.1.2 导入依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.2.9.RELEASE</version>
</dependency>
</dependencies>
5.1.3 编写JavaBean
@Data
//@EnableConfigurationProperties
@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 + '\'' +
'}';
}
}
5.1.4 编写配置类MyAutoConfiguration
import com.best.pojo.SimpleBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MyAutoConfiguration {
static {
System.out.println("MyAutoConfiguration init...");
}
@Bean
public SimpleBean instanceSimple(){
return new SimpleBean();
}
}
5.1.5 resources下创建/META-INF/spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.best.config.MyAutoConfiguration
5.2 使用自定义starter
5.2.1 在web项目导入依赖
<dependency>
<groupId>com.best</groupId>
<artifactId>best-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
5.2.2 在子模块的全局配置文件中配置属性值
5.2.3 在web项目中编写测试方法
5.2.4 启动编译后结果如下:
但此处还有一个问题,如果有一天我们不想要启动工程的时候自动装配SimpleBean呢?可能有的同学会想,那简单啊,我们去pom中把依赖注释掉,的确,这是一种方案,
但为免有点Low。
六、热插拔技术
还记得我们经常会在启动类Application上面加@EnableXXX注解吗?
其实这个@Enablexxx注解就是一种热拔插技术,加了这个注解就可以启动对应的starter,当不需要对应的starter的时候只需要把这个注解注释掉就行,是不是很优雅呢?
那么这是如何实现的呢?
接下来,我们改造starter工程新增热插拔支持类
6.1 新增标记类ConfigMarker
6.2 新增EnableRegisterService
6.3 改造MyAutoConfiguration
新增条件注解@ConditionalOnBean(ConfigMarker.class) ,@ConditionalOnBean 这个是条件注解,
前面的意思代表只有当前上下文中含有ConfigMarker对象,被标注的类才会被实例化。
6.4 使用自定义的注解
在web项目启动类上新增@EnableRegisterServer注解
到此热插拔就实现好了,当你加了@EnableImRegisterServer 的时候,启动starter程就会自动装配SimpleBean,反之则不装配。
它的原理也很简单,当加了@EnableImRegisterServer 注解的时候,由于这个注解使用了@Import({ConfigMarker.class}) ,所以会导致Spring去加载ConfigMarker 到上下文中,
而又因为条件注解@ConditionalOnBean(ConfigMarker.class) 的存在,所以MyAutoConfiguration 类就会被实例化。
不加注解
加注解
七、关于条件注解的讲解
更多推荐
所有评论(0)