springBoot框架通过简化配置的方式实现spring应用的快速搭建;同时可以一定程度上解决包依赖冲突;提升开发效率的同时也减少系统搭建难度。
为了方便理解和自己编写一些starter,就需要熟悉starter的内部结构。
- 依赖的包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<!-- 禁止传递依赖 -->
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
- 配置类
不管是官方提供的starter还是自定义的starter,使用的时候都需要在配置文件中进行相关的配置,那么这些配置信息在starter中最终会映射到一个类中,因此我们需要首先定义这个类,需要使用到@ConfigurationProperties注解。其中最重要的一个属性是preffix,该值对应的是我们在配置文件中设置的配置信息的前缀,即需要通过此前缀来进行相关信息的配置,然后类中定义需要配置的属性,则前缀+属性名就是我们需要在使用starter项目配置文件中配置的信息了,本例定义如下:具体有关如何与yml、properties文件如何对应,请自行查看相应资料。
@Data
@ConfigurationProperties(prefix = "payne.mybatis-plus")
public class MybatisPlusProperties {
private Boolean tenantMode = true;
private Boolean sqlLog = true;
private List<String> sqlLogExclude = new ArrayList();
private Boolean optimizeJoin = false;
/**
* 分页最大数
*/
private Long pageLimit = 500L;
/**
* 溢出总页数后是否进行处理
*/
protected Boolean overflow = false;
}
- 服务类
服务类,也就是我们定义这个starter需要注入的bean。也就是最终被调用执行具体功能的类,该类和定义普通类没有任何差别。
public class PayneSqlInjector extends DefaultSqlInjector {
@Override
public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
List<AbstractMethod> methodList = new ArrayList();
methodList.add(new InsertIgnore());
methodList.add(new Replace());
methodList.add(new InsertBatchSomeColumn((i) -> {
return i.getFieldFill() != FieldFill.UPDATE;
}));
methodList.addAll(super.getMethodList(mapperClass));
return Collections.unmodifiableList(methodList);
}
}
- 服务注册
通过bean configuration的方式来注册服务,因为需要使用到用户的配置信息所以需要通过@EnableConfigurationProperties注解来启用配置,并将配置类注入,这里是MyFirstConfigurationProperties,最后最终要的就是通过@Bean注解来注册服务类到容器中,这里就是FirstStarterService,最终代码如下:
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(MybatisPlusProperties.class)
public class MybatisPlusConfiguration implements WebMvcConfigurer {
@Bean
@ConditionalOnMissingBean({ISqlInjector.class})
public ISqlInjector sqlInjector() {
return new PayneSqlInjector();
}
}
- 暴露服务
在项目代码的resources目录下创建META-INF/spring.factories文件,并将创建的bean configuration类的全限定名定义在里面,示例这里是com.payne.auto.core.mp.config.MybatisPlusConfiguration,注意每个人不一样,记得更换为自己的。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.payne.auto.core.mp.config.MybatisPlusConfiguration
后续打包后就可以使用了。打包过程这些没有特别需要说明的。