[原創]SpringBoot的自動配置原理與自定義SpringBootStarter
阿新 • • 發佈:2019-12-31
以SpringBootAdmin的實現方式作為參考
# 實現的效果:
- 新增相關的依賴,再在啟動類上加上
@EnableXXX
就可以使用相關的功能了。
# 原理-SpringBootAdmin為例
- 在啟動類上標記註解
@EnableAdminServer
@EnableAdminServer
@SpringBootApplication
public class AdminApplication {
public static void main(String[] args) {
SpringApplication.run(AdminApplication.class,args);
}
}
複製程式碼
- 點進去發現只是匯入了一個類
AdminServerMarkerConfiguration.class
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(AdminServerMarkerConfiguration.class)
public @interface EnableAdminServer {
}
複製程式碼
- 點進這個類
AdminServerMarkerConfiguration
發現只是向容器中添加了一個beanMarker
public class AdminServerMarkerConfiguration {
@Bean
public Marker adminServerMarker() {
return new Marker();
}
public static class Marker {
}
}
複製程式碼
- 所以這一部分的總結就是:新增
@EnableAdminServer
註解,向容器中新增一個型別為Marker
的bean
- 接下來找到
AdminServerAutoConfiguration
這個類,一般預設SpringBoot的自動配置類都是以XXXAutoConfiguration
命名,所以很容易找到,例如RedisAutoConfiguration
...
@Configuration
@ConditionalOnBean(AdminServerMarkerConfiguration.Marker.class)
@EnableConfigurationProperties(AdminServerProperties.class)
@Import ({AdminServerWebConfiguration.class})
public class AdminServerAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public InstanceRegistry instanceRegistry(InstanceRepository instanceRepository,InstanceIdGenerator instanceIdGenerator) {
return new InstanceRegistry(instanceRepository,instanceIdGenerator);
}
@Bean
@ConditionalOnMissingBean
public InstanceIdGenerator instanceIdGenerator() {
return new HashingInstanceUrlIdGenerator();
}
......
}
複製程式碼
- 解讀這個類的註解可發現以下幾點:
-
@Configuration
這是一個配置類,可以看到這個類裡面通過@Bean
定義了很多bean -
@ConditionalOnBean(AdminServerMarkerConfiguration.Marker.class)
[重點],判斷容器中有這個bean,這就是上一部分,在啟動類上新增@EnableAdminServer
的作用,當容器中有Marker
這個bean時,這個Configuration才生效,才會向容器中新增這個類中定義的bean -
@EnableConfigurationProperties(AdminServerProperties.class)
啟動配置類AdminServerProperties
,將配置類與配置檔案繫結
@ConfigurationProperties("spring.boot.admin") public class AdminServerProperties { ... } 複製程式碼
-
@Import({AdminServerWebConfiguration.class})
匯入另外一個配置類,向容器中新增其他bean
-
接下來的問題是:如何讓Spring在啟動的時候掃面到這個配置類呢,通過分析@EnableAutoConfiguration
註解的實現可得知:將需要自動配置的類的全路徑配置在META-INF/spring.factories
,Spring會在啟動的時候掃描類路徑下所有的META-INF/spring.factories
檔案
- 如SpringBootAdmin的配置:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
de.codecentric.boot.admin.server.config.AdminServerAutoConfiguration,\
de.codecentric.boot.admin.server.config.AdminServerNotifierAutoConfiguration,\
de.codecentric.boot.admin.server.config.AdminServerHazelcastAutoConfiguration,\
de.codecentric.boot.admin.se rver.config.AdminServerCloudFoundryAutoConfiguration
複製程式碼
完成~
# 另外一個例子: 專案中Redis的自動配置
- SpringBoot專案中使用Redis更加簡單,新增Redis依賴即可使用
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
複製程式碼
SpringBoot是如何實現添加了redis依賴就可以使用Redis,RedisTemplate
的呢?
原理:
- 永遠第一步:找到Redis的自動配置類
RedisAutoConfiguration
@Configuration
@ConditionalOnClass(RedisOperations.class)
@EnableConfigurationProperties(RedisProperties.class)
@Import({ LettuceConnectionConfiguration.class,JedisConnectionConfiguration.class })
public class RedisAutoConfiguration {
@Bean
@ConditionalOnMissingBean(name = "redisTemplate")
public RedisTemplate<Object,Object> redisTemplate(
RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
RedisTemplate<Object,Object> template = new RedisTemplate<>();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
@Bean
@ConditionalOnMissingBean
public StringRedisTemplate stringRedisTemplate(
RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
StringRedisTemplate template = new StringRedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
}
複製程式碼
- @Configuration
- @ConditionalOnClass(RedisOperations.class) 當類路徑下有
RedisOperations
這個類時,那麼很明顯,這個類肯定是在新增redis依賴的時候導進來的,現在看一下這個類的路徑。 確實是通過redis的起步依賴導進來的,這就是為什麼添加了redis的起步依賴,redis就可以直接使用了 - @EnableConfigurationProperties(RedisProperties.class) 啟用配置類
RedisProperties
@ConfigurationProperties(prefix = "spring.redis")
public class RedisProperties {
/**
* Database index used by the connection factory.
*/
private int database = 0;
/**
* Connection URL. Overrides host,port,and password. User is ignored. Example:
* redis://user:[email protected]:6379
*/
private String url;
/**
* Redis server host.
*/
private String host = "localhost";
/**
* Login password of the redis server.
*/
private String password;
/**
* Redis server port.
*/
private int port = 6379;
......
}
複製程式碼
- @Import({ LettuceConnectionConfiguration.class,JedisConnectionConfiguration.class }) 匯入
LettuceConnectionConfiguration
和JedisConnectionConfiguration
,這兩個都是redis的客戶端。 那麼啟用哪一個呢 - LettuceConnectionConfiguration
@Configuration
@ConditionalOnClass(RedisClient.class)
class LettuceConnectionConfiguration extends RedisConnectionConfiguration {}
複製程式碼
- JedisConnectionConfiguration
@Configuration
@ConditionalOnClass({ GenericObjectPool.class,JedisConnection.class,Jedis.class })
class JedisConnectionConfiguration extends RedisConnectionConfiguration {}
複製程式碼
- 可以看到當類路徑下有響應的客戶端時,就啟用相應的自動配置類
- 而SpringBoot預設使用的是lettuce