spring cloud config配置中心源码分析之注解@EnableConfigServer

spring cloud config配置中心源码分析之注解@EnableConfigServer

基于spring-cloud-config-server-2.0.2.RELEASE代码

spring cloud config的主函数是ConfigServerApplication，其定义如下：

package com.liuwen;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {
   
     public static void main(String[] args){
   
         SpringApplication.run(ConfigServerApplication.class,args);
      }

}

@EnableConfigServer是spring cloud定义的注解，

@EnableConfigServer定义如下：

@Target({
   ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({
   ConfigServerConfiguration.class})
public @interface EnableConfigServer {
   
}

可以看出，它引入了ConfigServerConfiguration

@Configuration
public class ConfigServerConfiguration {
   
    public ConfigServerConfiguration() {
   
    }

    @Bean
    public ConfigServerConfiguration.Marker enableConfigServerMarker() {
   
        return new ConfigServerConfiguration.Marker();
    }

    class Marker {
   
        Marker() {
   
        }
    }
}

ConfigServerConfiguration类里面并没有实现太多bean的装配，这里利用一种折中方式，引入需要的自动配置。请看下面的类。Marker唯一被引用的地方在ConfigServerAutoConfiguration类。

ConfigServerConfiguration 装配了一个Marker的Bean。这个bean则有开启了ConfigServerAutoConfiguration。

@Configuration
@ConditionalOnBean({
   Marker.class})
@EnableConfigurationProperties({
   ConfigServerProperties.class})
@Import({
   EnvironmentRepositoryConfiguration.class, CompositeConfiguration.class, ResourceRepositoryConfiguration.class, ConfigServerEncryptionConfiguration.class, ConfigServerMvcConfiguration.class})
public class ConfigServerAutoConfiguration {
   
    public ConfigServerAutoConfiguration() {
   
    }
}

这里又引入了多个配置类，包括:

EnvironmentRepositoryConfiguration

CompositeConfiguration

ResourceRepositoryConfiguration

ConfigServerEncryptionConfiguration

ConfigServerMvcConfiguration

TransportConfiguration

接下来介绍EnvironmentRepositoryConfiguration

EnvironmentRepositoryConfiguration是配置中心的关键Configuration类。这个配置类中包含很多实现了EnvironmentRepository接口的类，每个实现类都对应一种类型(git/svn/navtie/vault)的配置。 EnvironmentRepositoryConfiguration通过profile注解（对当前应用的环境）决定使用装配哪个EnvironmentRepository Bean。默认是MultipleJGitEnvironmentRepository(在内部类DefaultRepositoryConfiguration里面有)。

@Configuration
public class EnvironmentRepositoryConfiguration {
   

	@Bean
	@ConditionalOnProperty(value = "spring.cloud.config.server.health.enabled", matchIfMissing = true)
	public ConfigServerHealthIndicator configServerHealthIndicator(EnvironmentRepository repository) {
   
		return new ConfigServerHealthIndicator(repository);
	}

	@Configuration
	@ConditionalOnMissingBean(EnvironmentRepository.class)
	protected static class DefaultRepositoryConfiguration {
   

		@Autowired
		private ConfigurableEnvironment environment;

		@Autowired
		private ConfigServerProperties server;

		@Autowired(required = false)
		private TransportConfigCallback transportConfigCallback;

		@Bean
		public MultipleJGitEnvironmentRepository defaultEnvironmentRepository() {
   
			MultipleJGitEnvironmentRepository repository = new MultipleJGitEnvironmentRepository(this.environment);
			repository.setTransportConfigCallback(this.transportConfigCallback);
			if (this.server.getDefaultLabel()!=null) {
   
				repository.setDefaultLabel(this.server.getDefaultLabel());
			}
			return repository;
		}
	}

	@Configuration
	@Profile("native")
	protected static class NativeRepositoryConfiguration {
   

		@Autowired
		private ConfigurableEnvironment environment;

		@Bean
		public NativeEnvironmentRepository nativeEnvironmentRepository() {
   
			return new NativeEnvironmentRepository(this.environment);
		}
	}

	@Configuration
	@Profile("git")
	protected static class GitRepositoryConfiguration extends DefaultRepositoryConfiguration {
   }

	@Configuration
	@Profile("subversion")
	protected static class SvnRepositoryConfiguration {
   
		@Autowired
		private ConfigurableEnvironment environment;

		@Autowired
		private ConfigServerProperties server;

		@Bean
		public SvnKitEnvironmentRepository svnKitEnvironmentRepository() {
   
			SvnKitEnvironmentRepository repository = new SvnKitEnvironmentRepository(this.environment);
			if (this.server.getDefaultLabel()!=null) {
   
				repository.setDefaultLabel(this.server.getDefaultLabel());
			}
			return repository;
		}
	}

	@Configuration
	@Profile("vault")
	protected static class VaultConfiguration {
   
		@Bean
		public VaultEnvironmentRepository vaultEnvironmentRepository(HttpServletRequest request, EnvironmentWatch watch) {
   
			return new VaultEnvironmentRepository(request, watch, new RestTemplate());
		}
	}

	@Configuration
	@ConditionalOnProperty(value = "spring.cloud.config.server.consul.watch.enabled")
	protected static class ConsulEnvironmentWatchConfiguration {