nacos-springboot配置中心使用

本文介绍如何使用Nacos作为SpringBoot项目的配置中心,包括配置文件设置、依赖引入、主类启动、控制器测试及动态配置更新。通过具体案例展示Nacos与SpringBoot集成的全过程。
启动nacos服务
案例如下:
  • 结合springboot,application.properties配置:
nacos.config.server-addr=127.0.0.1:8848

 endpoint http://localhost:8080/actuator/nacos-config
 health http://localhost:8080/actuator/health
management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always
  • pom配置:
 <properties>
        <spring-boot.version>2.0.3.RELEASE</spring-boot.version>
        <nacos-config-spring-boot.version>0.2.1</nacos-config-spring-boot.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba.boot</groupId>
            <artifactId>nacos-config-spring-boot-starter</artifactId>
            <version>${nacos-config-spring-boot.version}</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba.boot</groupId>
            <artifactId>nacos-config-spring-boot-actuator</artifactId>
            <version>${nacos-config-spring-boot.version}</version>
        </dependency>
       
    </dependencies>
  • 启动主类:NacosConfigApplication.java
@SpringBootApplication
@NacosPropertySource(dataId = "example", autoRefreshed = true)
public class NacosConfigApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosConfigApplication.class, args);
    }
}
  • 测试demo:ConfigController.java

import com.alibaba.nacos.api.annotation.NacosInjected;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.annotation.NacosValue;
import com.alibaba.nacos.api.exception.NacosException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import static org.springframework.web.bind.annotation.RequestMethod.GET;

@Controller
@RequestMapping("config")
public class ConfigController {

    private static final Logger log = LoggerFactory.getLogger(ConfigController.class);

    @NacosInjected
    ConfigService configService;

    @NacosValue(value = "${useLocalCache:xxx}", autoRefreshed = true)
    private String useLocalCache;

    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public String get() {
    // http://localhost:8080/config/get
        return useLocalCache;
    }

    @RequestMapping(value = "/publish", method = GET)
    @ResponseBody
    public String doPublish() {
    // http://localhost:8080/config/publish
        try {
            log.info("原始值{}", configService.getConfig("example", "DEFAULT_GROUP", 20000));
            configService.publishConfig("example", "DEFAULT_GROUP", "useLocalCache=api更改");
            log.info("更改后的值{}", configService.getConfig("example", "DEFAULT_GROUP", 20000));

            return "SUCESS";
        } catch (NacosException e) {
            e.printStackTrace();
            return "FALSE";
        }
    }
  • 此时我们访问http://localhost:8080/config/get,得到的值是默认值:xxx
  • 自定义配置,登陆nacos控制台:http://127.0.0.1:8848/nacos/
    在配置列表中,打开dateId为example的配置,编辑。如果没有这个dateId,就点击“+”,自行添加
    在这里插入图片描述
    添加配置:
    useLocalCache=ssss
    在这里插入图片描述
    再次访问http://localhost:8080/config/get,得到结果:ssss,配置实时生效。
使用ConfigService,改变控制台的值

代码如上,思路就是使用NacosInjected注解,获取ConfigService,然后利用api更改nacos配置
访问http://localhost:8080/config/publish,刷新控制台,可以看到控制台的值已经变成如下,已经实时更改
在这里插入图片描述

### NacosSpringBoot集成时@ConditionalOnProperty注解不生效的解决方案 当遇到`@ConditionalOnProperty`注解在Nacos与Spring Boot集成时不生效的情况时,可能的原因涉及多个方面。以下是详细的分析和解决方法: #### 1. 确保引入必要的依赖 为了使`@ConditionalOnProperty`正常工作,需确认项目中已正确引入了Spring Cloud Bootstrap的相关依赖。这是因为在Spring Cloud环境中,Bootstrap上下文优先于主应用程序上下文加载,从而影响配置解析逻辑。 ```xml <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-bootstrap</artifactId> </dependency> ``` 启动命令也需要显式指定启用Bootstrap功能,可以通过如下方式完成: ```bash java -Dspring.cloud.bootstrap.enabled=true -jar your-application.jar ``` 此操作确保了Bootstrap上下文中能够正确读取外部配置源(如Nacos)。[^1] --- #### 2. 配置文件位置与优先级 Nacos作为配置中心,在Spring Boot应用运行期间动态注入配置项。如果`application.properties`或`application.yml`中的某些属性未被覆盖,则可能导致`@ConditionalOnProperty`无法按预期触发条件判断。 建议检查以下几点: - **Nacos配置是否成功拉取**:验证Nacos服务端是否有对应的配置集,并确认客户端能正确获取到这些值。 - **配置文件加载顺序**:由于Spring Cloud会先加载`bootstrap.yml`再加载`application.yml`,因此应将敏感参数放置于前者以便更早初始化。[^3] --- #### 3. 正确使用@ConditionalOnProperty注解 该注解的核心作用在于依据特定环境变量的存在与否决定Bean实例化行为。其常见用法包括但不限于以下几个维度: - `prefix`: 定义属性前缀,默认为空字符串; - `name`: 属性名称数组形式传入; - `havingValue`: 判断期望的具体数值; 例如下面的例子展示了如何基于开关控制某组件注册状态: ```java @Component @ConditionalOnProperty(prefix = "my.feature", name = "enabled", havingValue = "true") public class FeatureComponent { // Component logic here... } ``` 这里假设存在名为`my.feature.enabled`的一个布尔型配置键值对关系,只有当它等于`true`的时候才会创建此类对象并加入容器管理之中。[^2] --- #### 4. 调试排查流程 如果仍然存在问题可以按照以下步骤逐一排除干扰因素: - 打印日志观察实际加载过程中的所有可用属性列表及其对应值; - 使用断点调试进入`loadBeanDefinitions()`函数内部查看具体筛选机制是如何运作的。根据描述得知在此过程中会对不符合约束条件的对象予以剔除处理。[^4] 另外值得注意的是有时候即使表面上看起来已经满足了设定的前提条件但由于类型转换失败等原因也可能造成最终判定失误现象发生所以务必小心对待每一个细节部分。 --- #### 示例代码片段 提供一段简单的单元测试帮助理解整个交互环节: ```java @SpringBootTest class ConditionalOnPropertyTest { @Autowired(required = false) private Optional<MyFeatureService> featureService; @Test void contextLoads() { boolean isEnabled = featureService.isPresent(); System.out.println("Is MyFeatureService enabled? -> " + isEnabled); } } @Service @ConditionalOnProperty(name="feature.toggle.my-service", matchIfMissing=false) class MyFeatureService {} ``` 以上案例演示了一个可选的服务模块启停切换场景。通过调整相关联的系统级别或者远程仓库里的配置条目即可轻松达成目标效果。[^5] --- ### 总结 综上所述,针对Nacos与Spring Boot结合下发生的`@ConditionalOnProperty`失效状况可以从四个方面入手解决问题——补充缺失的关键库件支持、理顺各类资源定位规则、遵循标准语法结构书写声明语句以及借助工具辅助深入探究根本原因所在。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

EmineWang

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值