docker容器相关操作

back

Nacos配置管理

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

统一配置管理

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

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

在nacos中添加配置文件

如何在nacos中管理配置呢?

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

从微服务拉取配置

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

但如果尚未读取application.yml,又如何得知nacos地址呢?因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:

1)引入nacos-config依赖
首先,在category-service服务中,引入nacos-config的客户端依赖:

implementation 'com.alibaba.cloud:spring-cloud-starter-alibaba-nacos-config'
implementation 'org.springframework.cloud:spring-cloud-starter-bootstrap'

2)添加bootstrap.yaml
然后,在user-service中的resource目录添加一个bootstrap.yml文件,这个文件是引导文件,优先级高于application.yml,内容如下:

spring:
  application:
    name: categoryservice # 服务名称
  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,来读取配置。

本例中,就是去读取categoryservice-dev.yaml:

3) 在category-service中将pattern.dateformat这个属性注入到CatagoryController中做测试:

@RestController
@RequestMapping("/category")
public class CategoryController {
    // 注入nacos中的配置属性
    @Value("${pattern.dateformat}")
    private String dateformat;
    // 编写controller,通过日期格式化器来格式化现在时间并返回
    @GetMapping("now")
    public String now(){
        return LocalDate.now().format( DateTimeFormatter.ofPattern(dateformat, Locale.CHINA) );
    }
    // ... 略
}

配置热更新

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

方式一:在@Value注入的变量所在类上添加注解@RefreshScope:

@RestController
@RequestMapping("/category")
@RefreshScope
public class CategoryController {
    // 注入nacos中的配置属性
    @Value("${pattern.dateformat}")
    private String dateformat;
    // 编写controller,通过日期格式化器来格式化现在时间并返回
    @GetMapping("now")
    public String now(){
        return LocalDate.now().format( DateTimeFormatter.ofPattern(dateformat, Locale.CHINA) );
    }
    // ... 略
}

方式二:使用@ConfigurationProperties注解代替@Value注解

在category-service服务中,添加一个类,读取patterrn.dateformat属性:

package edu.uestc.canary.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;
}

使用这个类代替@Value

package edu.uestc.canary.web;

import edu.uestc.canary.config.PatternProperties;
import edu.uestc.canary.pojo.User;
import edu.uestc.canary.service.CategoryService;
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("/category")
public class UserController {
    @Autowired
    private CategoryService service;

    @Resource
    private PatternProperties patternProperties;

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

配置共享

其实微服务启动时,会去nacos读取多个配置文件,例如:

而[spring.application.name].yaml不包含环境,因此可以被多个环境共享。

配置共享的优先级

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