Loading configuration of Nacos configuration center

Nacos配置中心之加载配置

一 The loading configuration of the client configuration center

We continued what we said in the previous article,Springboot启动的时候调用prep在reEnvironment()进行环境准备,prepareEnvironment()进行环境准备,After the startup class is executedprepareEnvironment后,执行prepareContextThe preparation code for refreshing the application context file is as follows：

public ConfigurableApplicationContext run(String... args) {
 StopWatch stopWatch = new StopWatch();
 stopWatch.start();
 ConfigurableApplicationContext context = null;
 Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
 configureHeadlessProperty();
 SpringApplicationRunListeners listeners = getRunListeners(args);
 listeners.starting();
 try {
 ApplicationArguments applicationArguments = new DefaultApplicationArguments(
 args);
 //环境准备
 ConfigurableEnvironment environment = prepareEnvironment(listeners,
 applicationArguments);
 configureIgnoreBeanInfo(environment);
 Banner printedBanner = printBanner(environment);
 context = createApplicationContext();
 exceptionReporters = getSpringFactoriesInstances(
 SpringBootExceptionReporter.class,
 new Class[] { ConfigurableApplicationContext.class }, context);
 prepareContext(context, environment, listeners, applicationArguments,
 printedBanner);
 refreshContext(context);
 afterRefresh(context, applicationArguments);
 stopWatch.stop();
 if (this.logStartupInfo) {
 new StartupInfoLogger(this.mainApplicationClass)
 .logStarted(getApplicationLog(), stopWatch);
 }
 listeners.started(context);
 callRunners(context, applicationArguments);
 }
 catch (Throwable ex) {
 handleRunFailure(context, ex, exceptionReporters, listeners);
 throw new IllegalStateException(ex);
 }

 try {
 listeners.running(context);
 }
 catch (Throwable ex) {
 handleRunFailure(context, ex, exceptionReporters, null);
 throw new IllegalStateException(ex);
 }
 return context;
}


我们看一下prepareContext()what the prepare context method does

prepareContext()方法

private void prepareContext(ConfigurableApplicationContext context,
 ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
 ApplicationArguments applicationArguments, Banner printedBanner) {
 context.setEnvironment(environment);
 postProcessApplicationContext(context);
 applyInitializers(context);
 listeners.contextPrepared(context);
 if (this.logStartupInfo) {
 logStartupInfo(context.getParent() == null);
 logStartupProfileInfo(context);
 }
 // Add boot specific singleton beans
 ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
 beanFactory.registerSingleton("springApplicationArguments", applicationArguments);
 if (printedBanner != null) {
 beanFactory.registerSingleton("springBootBanner", printedBanner);
 }
 if (beanFactory instanceof DefaultListableBeanFactory) {
 ((DefaultListableBeanFactory) beanFactory)
 .setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding);
 }
 // Load the sources
 Set<Object> sources = getAllSources();
 Assert.notEmpty(sources, &quot;Sources must not be empty&quot;);
 load(context, sources.toArray(new Object[0]));
 listeners.contextLoaded(context);
}


• 调用applyInitializers()方法

• 注册打印bannersingleton of graphbean

• 加载资源

我们再看一下applyInitializers()方法是做什么的

applyInitializers()方法

@SuppressWarnings({ "rawtypes", "unchecked" })
protected void applyInitializers(ConfigurableApplicationContext context) {
 for (ApplicationContextInitializer initializer : getInitializers()) {
 Class<?> requiredType = GenericTypeResolver.resolveTypeArgument(
 initializer.getClass(), ApplicationContextInitializer.class);
 Assert.isInstanceOf(requiredType, context, &quot;Unable to call initializer.&quot;);
 initializer.initialize(context);
 }
}


PropertySourceBootstrapConfiguration实现了ApplicationContextInitializer接口,所以会调用PropertySourceBootstrapConfiguration的initialize()方法

PropertySourceBootstrapConfiguration的initialize()方法

@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
 CompositePropertySource composite = new CompositePropertySource(
 BOOTSTRAP_PROPERTY_SOURCE_NAME);
 AnnotationAwareOrderComparator.sort(this.propertySourceLocators);
 boolean empty = true;
 ConfigurableEnvironment environment = applicationContext.getEnvironment();
 for (PropertySourceLocator locator : this.propertySourceLocators) {
 PropertySource<?> source = null;
 //加载
 source = locator.locate(environment);
 if (source == null) {
 continue;
 }
 logger.info(&quot;Located property source: &quot; + source);
 composite.addPropertySource(source);
 empty = false;
 }
 if (!empty) {
 MutablePropertySources propertySources = environment.getPropertySources();
 String logConfig = environment.resolvePlaceholders(&quot;${logging.config:}&quot;);
 LogFile logFile = LogFile.get(environment);
 if (propertySources.contains(BOOTSTRAP_PROPERTY_SOURCE_NAME)) {
 propertySources.remove(BOOTSTRAP_PROPERTY_SOURCE_NAME);
 }
 insertPropertySources(propertySources, composite);
 reinitializeLoggingSystem(environment, logConfig, logFile);
 setLogLevels(applicationContext, environment);
 handleIncludedProfiles(environment);
 }
}


locator.locate(environment)方法会调用NacosPropertySourceLocator的locate方法,This is the key code to load the configuration

NacosPropertySourceLocator的locate()方法

@Override
public PropertySource<?> locate(Environment env) {

 ConfigService configService = nacosConfigProperties.configServiceInstance();

 if (null == configService) {
 log.warn(&quot;no instance of config service found, can't load config from nacos&quot;);
 return null;
 }
 long timeout = nacosConfigProperties.getTimeout();
 nacosPropertySourceBuilder = new NacosPropertySourceBuilder(configService,
 timeout);
 String name = nacosConfigProperties.getName();

 String dataIdPrefix = nacosConfigProperties.getPrefix();
 if (StringUtils.isEmpty(dataIdPrefix)) {
 dataIdPrefix = name;
 }

 if (StringUtils.isEmpty(dataIdPrefix)) {
 dataIdPrefix = env.getProperty(&quot;spring.application.name&quot;);
 }

 CompositePropertySource composite = new CompositePropertySource(
 NACOS_PROPERTY_SOURCE_NAME);

 loadSharedConfiguration(composite);
 loadExtConfiguration(composite);
 loadApplicationConfiguration(composite, dataIdPrefix, nacosConfigProperties, env);

 return composite;
}


• 初始化ConfigService对象,ConfigService是Nacos客户端提供的用于访问实现配置中心基本操作的类

• If empty print support noConfigService实例,Could not load configuration,返回空

• 如果不为空,按照顺序分别加载共享配置、扩展配置、应用名称对应的配置.

进入loadApplicationConfiguration-》loadNacosDataIfPresent-》loadNacosPropertySource-》build-》loadNacosData

loadNacosData()方法

private Properties loadNacosData(String dataId, String group, String fileExtension) {
 String data = null;
 try {
 data = configService.getConfig(dataId, group, timeout);
 if (StringUtils.isEmpty(data)) {
 log.warn(
 "Ignore the empty nacos configuration and get it based on dataId[{}] & group[{}]",
 dataId, group);
 return EMPTY_PROPERTIES;
 }
 log.info(String.format(
 "Loading nacos data, dataId: '%s', group: '%s', data: %s", dataId,
 group, data));

 Properties properties = NacosDataParserHandler.getInstance()
 .parseNacosData(data, fileExtension);
 return properties == null ? EMPTY_PROPERTIES : properties;
 }
 catch (NacosException e) {
 log.error("get data from Nacos error,dataId:{}, ", dataId, e);
 }
 catch (Exception e) {
 log.error("parse data from Nacos error,dataId:{},data:{},", dataId, data, e);
 }
 return EMPTY_PROPERTIES;
}


configService.getConfig方法从Nacos配置中心上加载配置进行填充

private String getConfigInner(String tenant, String dataId, String group, long timeoutMs) throws NacosException {
 group = null2defaultGroup(group);
 ParamUtils.checkKeyParam(dataId, group);
 ConfigResponse cr = new ConfigResponse();

 cr.setDataId(dataId);
 cr.setTenant(tenant);
 cr.setGroup(group);

 // 优先使用本地配置
 String content = LocalConfigInfoProcessor.getFailover(agent.getName(), dataId, group, tenant);
 if (content != null) {
 LOGGER.warn("[{}] [get-config] get failover ok, dataId={}, group={}, tenant={}, config={}", agent.getName(),
 dataId, group, tenant, ContentUtils.truncateContent(content));
 cr.setContent(content);
 configFilterChainManager.doFilter(null, cr);
 content = cr.getContent();
 return content;
 }

 try {
 content = worker.getServerConfig(dataId, group, tenant, timeoutMs);

 cr.setContent(content);

 configFilterChainManager.doFilter(null, cr);
 content = cr.getContent();

 return content;
 } catch (NacosException ioe) {
 if (NacosException.NO_RIGHT == ioe.getErrCode()) {
 throw ioe;
 }
 LOGGER.warn("[{}] [get-config] get from server error, dataId={}, group={}, tenant={}, msg={}",
 agent.getName(), dataId, group, tenant, ioe.toString());
 }

 LOGGER.warn("[{}] [get-config] get snapshot ok, dataId={}, group={}, tenant={}, config={}", agent.getName(),
 dataId, group, tenant, ContentUtils.truncateContent(content));
 content = LocalConfigInfoProcessor.getSnapshot(agent.getName(), dataId, group, tenant);
 cr.setContent(content);
 configFilterChainManager.doFilter(null, cr);
 content = cr.getContent();
 return content;
}


The local configuration is loaded first in the method,Returns the result if not empty,Otherwise, it will be called again hereClientWork的getServerConfig()The method gets the content and returns the result

ClientWork的getServerConfig()方法

public String getServerConfig(String dataId, String group, String tenant, long readTimeout)
 throws NacosException {
 if (StringUtils.isBlank(group)) {
 group = Constants.DEFAULT_GROUP;
 }

 HttpResult result = null;
 try {
 List<String> params = null;
 if (StringUtils.isBlank(tenant)) {
 params = Arrays.asList(&quot;dataId&quot;, dataId, &quot;group&quot;, group);
 } else {
 params = Arrays.asList(&quot;dataId&quot;, dataId, &quot;group&quot;, group, &quot;tenant&quot;, tenant);
 }
 //发起请求
 result = agent.httpGet(Constants.CONFIG_CONTROLLER_PATH, null, params, agent.getEncode(), readTimeout);
 } catch (IOException e) {
 String message = String.format(
 &quot;[%s] [sub-server] get server config exception, dataId=%s, group=%s, tenant=%s&quot;, agent.getName(),
 dataId, group, tenant);
 LOGGER.error(message, e);
 throw new NacosException(NacosException.SERVER_ERROR, e);
 }

 switch (result.code) {
 case HttpURLConnection.HTTP_OK:
 LocalConfigInfoProcessor.saveSnapshot(agent.getName(), dataId, group, tenant, result.content);
 return result.content;
 case HttpURLConnection.HTTP_NOT_FOUND:
 LocalConfigInfoProcessor.saveSnapshot(agent.getName(), dataId, group, tenant, null);
 return null;
 case HttpURLConnection.HTTP_CONFLICT: {
 LOGGER.error(
 &quot;[{}] [sub-server-error] get server config being modified concurrently, dataId={}, group={}, &quot;
 + &quot;tenant={}&quot;, agent.getName(), dataId, group, tenant);
 throw new NacosException(NacosException.CONFLICT,
 &quot;data being modified, dataId=&quot; + dataId + &quot;,group=&quot; + group + &quot;,tenant=&quot; + tenant);
 }
 case HttpURLConnection.HTTP_FORBIDDEN: {
 LOGGER.error(&quot;[{}] [sub-server-error] no right, dataId={}, group={}, tenant={}&quot;, agent.getName(), dataId,
 group, tenant);
 throw new NacosException(result.code, result.content);
 }
 default: {
 LOGGER.error(&quot;[{}] [sub-server-error] dataId={}, group={}, tenant={}, code={}&quot;, agent.getName(), dataId,
 group, tenant, result.code);
 throw new NacosException(result.code,
 &quot;http error, code=&quot; + result.code + &quot;,dataId=&quot; + dataId + &quot;,group=&quot; + group + &quot;,tenant=&quot; + tenant);
 }
 }
}


Now the bottom line is out,Here the client is called to send a request to the server,agent.httpGet()发起请求,请求路径：/v1/cs/configs

二 服务端/v1/cs/configs接口的处理

服务端在nacos.config包下,

ConfigController

类的getConfig()方法

@GetMapping
@Secured(action = ActionTypes.READ, signType = SignType.CONFIG)
public void getConfig(HttpServletRequest request, HttpServletResponse response,
 @RequestParam("dataId") String dataId, @RequestParam("group") String group,
 @RequestParam(value = "tenant", required = false, defaultValue = StringUtils.EMPTY) String tenant,
 @RequestParam(value = "tag", required = false) String tag)
 throws IOException, ServletException, NacosException {
 // check tenant
 ParamUtils.checkTenant(tenant);
 tenant = NamespaceUtil.processNamespaceParameter(tenant);
 // check params
 ParamUtils.checkParam(dataId, group, "datumId", "content");
 ParamUtils.checkParam(tag);
 
 final String clientIp = RequestUtil.getRemoteIp(request);
 String isNotify = request.getHeader("notify");
 inner.doGetConfig(request, response, dataId, group, tenant, tag, isNotify, clientIp);
}


调用了

ConfigServletInner

的doGetConfig()方法,调用

tryConfigReadLock()

method to add a read lock,查看缓存中有没有nacos中配置的key If there is, the lock is successful,Called after successful lockingConfigCacheService.getContentCache()获取CacheItem实例,然后判断,Then choose to fetch data from the database or local files according to the configuration information,Then return the file content back to the client

总结

启动类执行完prepareEnvironment后,执行prepareContext进行刷新应用上下文件的准备,调用applyInitializers,调用NacosPropertySourceLocator的locate方法,初始化ConfigService对象,按照顺序分别加载共享配置、扩展配置、应用名称对应的配置,进入loadNacosData方法,然后configService.getConfig方法从Nacos配置中心上加载配置进行填充.

这就是nacos初始化的大体流程,如果我们在工作中遇到获取nacos数据获取不到的时候,我们可以试着跟踪一下nacos加载数据的流程,分析问题,定位问题,及时解决.