什么是SpringBoot的自動配置原理以及自定義SpringBootStarter

本篇文章為大家展示了什么是SpringBoot的自動配置原理以及自定義SpringBootStarter，內容簡明扼要并且容易理解，絕對能使你眼前一亮，通過這篇文章的詳細介紹希望你能有所收獲。

以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發現只是向容器中添加了一個bean Marker

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();
    }
......
}

• 解讀這個類的注解可發現以下幾點：

        @ConfigurationProperties("spring.boot.admin")
        public class AdminServerProperties {
          ...
        }

   

4. @Import({AdminServerWebConfiguration.class}) 導入另外一個配置類，向容器中添加其他bean

1. @Configuration 這是一個配置類，可以看到這個類里面通過@Bean定義了很多bean

2. @ConditionalOnBean(AdminServerMarkerConfiguration.Marker.class) [重點]，判斷容器中有這個bean，這就是上一部分，在啟動類上添加@EnableAdminServer 的作用，當容器中有Marker這個bean時，這個Configuration才生效，才會向容器中添加這個類中定義的bean

3. @EnableConfigurationProperties(AdminServerProperties.class) 啟動配置類AdminServerProperties，將配置類與配置文件綁定

接下來的問題是：如何讓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:password@example.com: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

上述內容就是什么是SpringBoot的自動配置原理以及自定義SpringBootStarter，你們學到知識或技能了嗎？如果還想學到更多技能或者豐富自己的知識儲備，歡迎關注億速云行業資訊頻道。