SpringBoot2集成nacos（一）

SpringBoot集成Nacos配置详解

最新推荐文章于 2025-07-16 18:05:12 发布

原创最新推荐文章于 2025-07-16 18:05:12 发布 · 9.1k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#nacos

springboot 同时被 3 个专栏收录

18 篇文章

订阅专栏

nacos

7 篇文章

订阅专栏

配置中心

5 篇文章

订阅专栏

本文详细解析了SpringBoot项目中集成Nacos配置管理的常见问题及解决方法，包括必须配置的参数、NacosConfigUtils源码分析、正确配置type属性及启用预加载配置的必要条件。

根据nacos官网的描述，集成时总是出现错误，读不到nacos中的配置，用的nacos-config-spring-boot-starter版本为0.2.3。

后来经过debug，发现有几个参数是必须配置的，否则项目不会启动成功。


    public NacosPropertySource reqNacosConfig(Properties configProperties, String dataId, String groupId, ConfigType type) {
        String config = NacosUtils.getContent(builder.apply(configProperties), dataId, groupId);
        NacosPropertySource nacosPropertySource = new NacosPropertySource(dataId, groupId,
                buildDefaultPropertySourceName(dataId, groupId, configProperties), config, type.getType());
        nacosPropertySource.setDataId(dataId);
        nacosPropertySource.setType(type.getType());
        nacosPropertySource.setGroupId(groupId);
        return nacosPropertySource;
    }

上边是nacos的NacosConfigUtils源码片段，

buildDefaultPropertySourceName(dataId, groupId, configProperties), config, type.getType());

上边的type是在nacos中配置的内容格式，

/*
 * Copyright 1999-2018 Alibaba Group Holding Ltd.
 *
 * Licensed under the Apache License, Version 2.0  = the "License"");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.alibaba.nacos.api.config;

/**
 * @author liaochuntao
 * @date 2019-06-14 21:12
 **/
public enum ConfigType {

    /**
     * config type is "properties"
     */
    PROPERTIES("properties"),

    /**
     * config type is "xml"
     */
    XML("xml"),

    /**
     * config type is "json"
     */
    JSON("json"),

    /**
     * config type is "text"
     */
    TEXT("text"),

    /**
     * config type is "html"
     */
    HTML("html"),

    /**
     * config type is "yaml"
     */
    YAML("yaml");

    String type;

    ConfigType(String type) {
        this.type = type;
    }

    public String getType() {
        return type;
    }
}

单独在nacos中指定类型，在运行时还是会报空指针异常，因此还需要在配置nacos时指定：nacos.config.type

另外还需要配置的是nacos.config bootstrap.enable=true或nacos.config bootstrap.log.enable=true，这两个配置必须指定其一。因为在NacosConfigApplicationContextInitializer的initialize方法中会调用enable()方法中判断这两个配置项是否其一为true。

public class NacosConfigApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {

  

@Override
    public void initialize(ConfigurableApplicationContext context) {
        CacheableEventPublishingNacosServiceFactory singleton = CacheableEventPublishingNacosServiceFactory.getSingleton();
        singleton.setApplicationContext(context);
        environment = context.getEnvironment();
        if (!enable()) {
            logger.info("[Nacos Config Boot] : The preload configuration is not enabled");
        } else {
            Function<Properties, ConfigService> builder = properties -> {
                try {
                    return singleton.createConfigService(properties);
                } catch (
                        NacosException e) {
                    throw new RuntimeException("ConfigService can't be created with properties : " + properties, e);
                }
            };
            nacosConfigProperties = NacosConfigPropertiesUtils.buildNacosConfigProperties(environment);
            NacosConfigUtils configUtils = new NacosConfigUtils(nacosConfigProperties, environment, builder);

            if (processor.enable(environment)) {
                configUtils.addListenerIfAutoRefreshed(processor.getDeferPropertySources());
            } else {
                configUtils.loadConfig(false);
                configUtils.addListenerIfAutoRefreshed();
            }

        }

    }


//其他代码省略...
    
private boolean enable() {
        return processor.enable(environment) || Boolean.parseBoolean(environment.getProperty(NacosConfigConstants.NACOS_BOOTSTRAP, "false"));
    }

}

SpringBoot2集成nacos的完整配置文件如下：

nacos:
  config:
    type: yaml
    server-addr: 192.168.111.111:8848
    namespace: 32a9fc67-5fc9-47a7-947b-863364d93a88
    context-path: nacos
    data-id: the-dataid
    auto-refresh: true
    group: the-group
    bootstrap:
      enable: true
      log:
        enable: true