【Java分布式】Nacos配置管理

最新推荐文章于 2025-09-02 12:47:39 发布

原创最新推荐文章于 2025-09-02 12:47:39 发布 · 1.2k 阅读

26 ·

CC 4.0 BY-SA版权

文章标签：

#java #分布式 #开发语言 #Nacos #配置管理

分布式专栏收录该内容

4 篇文章

订阅专栏

Nacos配置管理

Nacos一方面可以将配置集中管理，另一方可以在配置变更时，及时通知微服务，实现配置的热更新。

统一配置管理

当微服务部署的实例越来越多，达到数十、数百时，逐个修改微服务配置就会很繁琐，而且很容易出错，因此需要一种统一配置管理方案，可以集中管理所有实例的配置。

在这里插入图片描述

1、在nacos中添加配置文件

在这里插入图片描述

然后在弹出的表单中，填写配置信息：

在这里插入图片描述

项目的核心配置，需要热更新的配置才有放到nacos管理的必要，基本不会变更的一些配置还是保存在微服务本地比较好

后缀名填完整的yaml更好

2、引入nacos-config依赖

首先，在user-service服务中，引入nacos-config的客户端依赖：

<!--nacos配置管理依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

3、添加bootstrap.yaml

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。

为了实现在尚未读取application.yml的情况下获取配置信息，因此spring引入了一种新的配置文件 bootstrap.yaml 文件，这个文件会在application.yml之前被读取。

在这里插入图片描述

所以在user-service中添加一个bootstrap.yaml文件，内容如下：

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境，这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

nacos地址：spring.cloud.nacos.server-addr，即 localhost:8848

文件id：${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}，即 userservice-dev.yaml

先通过nacos地址连接nacos服务器，再根据文件id来读取配置。

4、读取nacos配置

在user-service中的UserController中添加业务逻辑，读取pattern.dateformat配置：

package cn.itcast.user.web;

import cn.itcast.user.pojo.User;
import cn.itcast.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @Value("${pattern.dateformat}")
    private String dateformat;
    
    @GetMapping("now")
    public String now(){
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
    }
    // ...略
}

在页面访问，可以看到效果：

在这里插入图片描述

配置热更新

修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是配置热更新。

注意：

不是所有的配置都适合放到配置中心，维护起来比较麻烦
建议将一些关键参数，需要运行时调整的参数放到nacos配置中心，一般都是自定义配置

要实现配置热更新，可以使用两种方式：

1、通过＠Value注解注入，结合＠RefreshScope来刷新

在@Value注入的变量所在类上添加注解@RefreshScope：

在这里插入图片描述

2、通过＠ConfigurationProperties注入，自动刷新

使用@ConfigurationProperties注解代替@Value注解，在user-service服务中，添加一个类，读取patterrn.dateformat属性：

package cn.itcast.user.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
}

在UserController中使用这个类代替@Value：

package cn.itcast.user.web;

import cn.itcast.user.config.PatternProperties;
import cn.itcast.user.pojo.User;
import cn.itcast.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @Autowired
    private PatternProperties patternProperties;

    @GetMapping("now")
    public String now(){
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
    }
}