(我们以redis为例,我们自己制作一个starter)
1、首先创建一个项目;
2、加入依赖
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>3.1.0</version>
</dependency>
3、创建一个RedisProperties用于加载Redis需要的配置;
package com.bjpowernode.starter.properties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "spring.cat.redis")
public class MyRedisProperties {
private String host;
private int port;
private String password;
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
}
public int getPort() {
return port;
}
public void setPort(int port) {
this.port = port;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
4、创建一个配置类,这个配置类用于加载配置,并实例化Jedis客户端;
package com.bjpowernode.starter.config;
import com.bjpowernode.starter.properties.MyRedisProperties;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import redis.clients.jedis.Jedis;
@Configuration //配置类,相当于一个spring的xml
@ConditionalOnClass(Jedis.class)
@EnableConfigurationProperties(MyRedisProperties.class) //开启使用映射实体对象
@ConditionalOnProperty //存在对应配置信息时初始化该配置类
(
prefix = "spring.cat.redis",//存在配置前缀redis
value = "enabled",//开启
matchIfMissing = true //缺失检查
)
public class MyRedisAutoConfiguration {
/**
* 在spring ioc容器中要创建一个jedis对象
*
* @param redisProperties
* @return
*/
@Bean
@ConditionalOnMissingBean
public Jedis jedis(MyRedisProperties redisProperties) {
Jedis jedis = new Jedis(redisProperties.getHost(), redisProperties.getPort());
jedis.auth(redisProperties.getPassword());
return jedis;
}
}
自动化配置代码中有很多我们之前没有用到的注解配置,分别介绍如下:
@Configuration:这个配置就不用多做解释了,我们一直在使用;
@EnableConfigurationProperties:这是一个开启使用配置参数的注解,value值就是我们配置实体参数映射的ClassType,将配置实体作为配置来源;
SpringBoot内置条件注解
@ConditionalOnXxx相关的注解为条件注解,也是我们配置的关键,可以把这些注解理解为具有Xxx条件:
@ConditionalOnBean:当SpringIoc容器内存在指定Bean的条件
@ConditionalOnClass:当Spring Ioc容器内存在指定Class的条件;
@ConditionalOnExpression:基于SpEL表达式作为判断条件
@ConditionalOnJava:基于JVM版本作为判断条件
@ConditionalOnMissingBean:当SpringIoc容器内不存在指定Bean的条件
@ConditionalOnMissingClass:当SpringIoc容器内不存在指定Class的条件
@ConditionalOnNotWebApplication:当前项目不是Web项目的条件
@ConditionalOnProperty:指定的属性是否有指定的值;
@ConditionalOnResource:类路径是否有指定的值
@ConditionalOnSingleCandidate:当指定Bean在SpringIoc容器内只有一个,或者虽然有多个但是指定首选的Bean;
@ConditionalOnWebApplication:当前项目是Web项目的条件
以上注解都是元注解@Conditional演变而来的,根据不用的条件对应创建以上的具体条件注解。
截止到项目我们还没有完成自动化配置starter,我们先来了解Starter自动化配置原理:
在注解@SpringBootApplication上存在一个开启自动化配置的注解@EnableAutoConfiguration来完成自动化配置,注解源码如下所示:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
在@EnableAutoConfiguration注解内使用到了@import注解来完成导入配置的功能,而EnableAutoConfigurationImportSelector内部则是使用了SpringFactoriesLoader.loadFactoryNames方法进行扫描具有META-INF/spring.factories文件的jar包。我们可以先来看下spring-boot-autoconfigure包内的spring.factories文件内容,如下所示:
可以看到配置的结构形式是Key=>Value形式,多个Value时使用,隔开,目的是为了完成自动化配置,所以我们这里Key则是需要使用:org.springframework.boot.autoconfigure.EnableAutoConfiguration
自定义spring.factories
在src/main/resource目录下创建META-INF目录,并在目录内添加文件spring.factories,具体内容如下:
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.bjpowernode.starter.config.MyRedisAutoConfiguration
至此自定义的starter已经开发完毕;
然后就可以在其他项目里面引用我们自己制作的starter的依赖,然后使用它进行开发;