自己动手写-手写一个spring boot starter
自己动手写之手写一个starter
-
什么是starter？
starter是SpringBoot中的一个新发明，它有效的降低了项目开发过程的复杂程度，对于简化开发操作有着非常好的效果。提供一个开箱即用的组件。
-
手写一个starter
假设我们有个需求，我们需要序列化一个对象，当工程中存在FastJson的com.alibaba.fastjson.JSON类时使用FastJson序列化，如果不存在就则进行简单的toString操作。
我们首先定义一个接口有一个格式化方法
public interface FormatProcessor { //定义一个序列化的方法String format(T obj); } 然后这个接口有两个实现类，分别做不同序列化操作。
import com.alibaba.fastjson.JSON; public class JsonFormatProcessor implements FormatProcessor{ @Override publicString format(T obj) { return "JsonFormatProcessor:"+ JSON.toJSONString(obj); } } import java.util.Objects;
public class StringFormatProcessor implements FormatProcessor{
@Override
public String format(T obj) {
return “StringFormatProcessor:”+Objects.toString(obj);
}
}定义一个Configuration类。@Configuration
public class FormatAutoConfiguration {
@ConditionalOnMissingClass(“com.alibaba.fastjson.JSON”) // 如果不存在JSON类就加载
@Bean
@Primary // 如果有两个实现则优先加载这个
public FormatProcessor stringFormat() {
return new StringFormatProcessor();
}@ConditionalOnClass(name = “com.alibaba.fastjson.JSON”) // 如果存在JSON类
@Bean
public FormatProcessor jsonFormat() {
return new JsonFormatProcessor();
}
}定义一个自动配置类。@Import(FormatAutoConfiguration.class)
@Configuration
public class HelloAutoConfiguration {@Bean
public HelloFormatTemplate helloFormatTemplate( FormatProcessor formatProcessor) {
return new HelloFormatTemplate(formatProcessor);
}
}template类public class HelloFormatTemplate {
private FormatProcessor formatProcessor;
public HelloFormatTemplate(FormatProcessor formatProcessor) {
this.formatProcessor = formatProcessor;
}public String doFormat(T obj){
StringBuilder stringBuilder=new StringBuilder();
stringBuilder.append(“begin:Execute format”).append("
");
stringBuilder.append(“Obj format result:”).append(formatProcessor.format(obj)).append("
");
return stringBuilder.toString();
}
}使用spring boot的SPI机制把 HelloAutoConfiguration自动装配进spring容器。在spring.factories文件中定义org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.yhx.starter.autoconfiguration.HelloAutoConfiguration这样我们就写出了一个starter，实现了一个类似以RedisTemplate的HelloFormatTemplate的工具。那如果我们要使用外部化的配置也就要读取到application.yml文件的配置该怎么写呢？ 首先我们写一个Properties类，并加上@ConfigurationProperties注解。@ConfigurationProperties(prefix = HelloProperties.HELLO_FORMAT_PREFIX)
public class HelloProperties {
public static final String HELLO_FORMAT_PREFIX = “yhx.hello.format”;
private Map
public Map
return info;
}
public void setInfo(Map
this.info = info;
}
}然后在HelloAutoConfiguration的自动装配的类中加上@EnableConfigurationProperties(HelloProperties.class)，此时HelloAutoConfiguration类为@Import(FormatAutoConfiguration.class)
@EnableConfigurationProperties(HelloProperties.class)
@Configuration
public class HelloAutoConfiguration {@Bean
// HelloProperties这时候的已经在spring容器中了，会自动去找查的
public HelloFormatTemplate helloFormatTemplate(HelloProperties helloProperties, FormatProcessor formatProcessor) {
return new HelloFormatTemplate(helloProperties, formatProcessor);
}
}这时候我们的Template可以改写为如下的public class HelloFormatTemplate {
private FormatProcessor formatProcessor;
private HelloProperties helloProperties;
public HelloFormatTemplate(HelloProperties helloProperties,FormatProcessor formatProcessor) {
this.helloProperties=helloProperties;
this.formatProcessor = formatProcessor;
}public String doFormat(T obj){
StringBuilder stringBuilder=new StringBuilder();
stringBuilder.append(“begin:Execute format”).append("
");
stringBuilder.append(“HelloProperties:”).append(formatProcessor.format(helloProperties.getInfo())).append("
");
stringBuilder.append(“Obj format result:”).append(formatProcessor.format(obj)).append("
");
return stringBuilder.toString();}
}我们在使用这个这个starter的工程中在application.yml或者是application.properties中配置，就可以配置进这个序列化的bean中yhx.hello.format.info.country=CN
yhx.hello.format.info.provice=HuNan
yhx.hello.format.info.city=shanghai
yhx.hello.format.info.org=xingren -
常见的starter之logger
我们在项目中加入logging starter的依赖
org.springframework.boot spring-boot-starter-logging 2.3.4.RELEASE 然后看一下spring-boot-starter-logging的jar包，发现里面并没有什么，这是为什么呢？
spring-boot-starter-logging-2.3.4.RELEASE.jar META-INF LICENSE.txt MANIFEST.MF NOTICE.txt然后我们点进pom文件中的spring-boot-starter-logging看看
4.0.0 org.springframework.boot spring-boot-starter-logging 2.3.4.RELEASE spring-boot-starter-logging Starter for logging using Logback. Default logging starter https://spring.io/projects/spring-boot Pivotal Software, Inc. https://spring.io Apache License, Version 2.0 https://www.apache.org/licenses/LICENSE-2.0 Pivotal [email protected] Pivotal Software, Inc. https://www.spring.io scm:git:git://github.com/spring-projects/spring-boot.git scm:git:ssh://[email protected]/spring-projects/spring-boot.git https://github.com/spring-projects/spring-boot GitHub https://github.com/spring-projects/spring-boot/issues ch.qos.logback logback-classic 1.2.3 compile org.apache.logging.log4j log4j-to-slf4j 2.13.3 compile org.slf4j jul-to-slf4j 1.7.30 compile 里面就是一堆依赖，为什么空的也能实现自动装配呢？因为spring boot官方提供了装配，如果相关的类或者一类存在的话，所以logging的starter只需要添加一些依赖就可以。