【微服务】Nacos配置管理

举报
观止study 发表于 2023/05/23 21:13:34 2023/05/23
【摘要】 Nacos除了可以做配置管理,同样可以当作注册中心来使用。 一.引入当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。由此我们可以引入Nacos用于统一的配置管理:一方面可以用于将配置集中管理。另一方可以在配置变更时,及时通知微服务,实现配置的热更新。 二.统一配置管理 (1) 在nacos...

Nacos除了可以做配置管理,同样可以当作注册中心来使用。

image.png

一.引入

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

  • 由此我们可以引入Nacos用于统一的配置管理:
    • 一方面可以用于将配置集中管理。
    • 另一方可以在配置变更时,及时通知微服务,实现配置的热更新。
      image.png

二.统一配置管理

(1) 在nacos中添加配置文件

如何在nacos中管理配置呢?

1.点击右侧配置列表
image.png

  1. 在弹出的表单中,填写配置信息:
    image.png
  • 注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

(2) 在微服务拉取配置

(2.1) 前言

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

  • 但如果尚未读取application.yml,又如何得知nacos地址呢?

  • 因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:
    image.png

(2.2) 引入依赖

在user-service服务中,引入nacos-config的客户端依赖:

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

注意:如果未在工程中统一管理依赖版本,此处需要指定具体版本

(2.3) 新建bootstrap.yaml

在user-service中添加一个bootstrap.yaml文件,内容如下:

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

这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。

本例中,就是去读取userservice-dev.yaml
image.png

(2.4) 测试

在user-service中的UserController中添加业务逻辑,尝试读取nacos中配置的pattern.dateformat:
image.png

完整代码:

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));
    }
    // ...略
}

在页面访问,可以看到效果:
image.png

说明已经成功读取到了我们在nacos中配置的日期格式。

三.配置热更新

(1) 引入

我们的目的之一是当我们修改nacos中的配置后,无需重启微服务即可让配置即可生效,也就是配置热更新

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

(2) 方式一

在@Value注入的变量所在类上添加注解@RefreshScope
image.png

(3) 方式二

使用@ConfigurationProperties注解代替@Value注解。

  1. 在user-service微服务中,新建一个类,读取nacos中配置的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;
}
  1. 在UserController中使用这个读取配置类代替@Value直接注入:
    image.png

(4) 测试

修改nacos中配置后直接刷新网页后可以看到服务已经成功读取到修改后的配置~
image.png

四.配置共享

(1) 前言

在微服务启动时,会去nacos按顺序读取多个配置文件,例如:

  • [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml

  • [spring.application.name].yaml,例如:userservice.yaml

[spring.application.name].yaml不包含环境,每种环境都会去读取,因此可以被多个环境共享。

(2) 使用

(2.1) 添加一个环境共享配置

我们在nacos中添加一个userservice.yaml文件:
image.png

(2.2) 读取共享配置

  1. 在user-service服务中,修改PatternProperties类,读取新添加的属性:
    image.png

  2. 在user-service服务中,修改UserController,添加一个方法:
    image.png

  3. 运行两个UserApplication,修改UserApplication2这个启动项,改变其profile值:
    image.png
    image.png

UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test。

  1. 启动UserApplication和UserApplication2

访问http://localhost:8081/user/prop,结果:
image.png

访问http://localhost:8082/user/prop,结果:
image.png

可以看出来,不管是dev,还是test环境,都读取到了envSharedValue这个属性的值。

(3) 配置共享的优先级

当nacos、服务本地同时出现相同配置属性时,优先级有高低之分:
image.png

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。