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

统一配置管理

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

nacos配置Javahome linux nacos配置管理_热部署

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

1.Nacos中添加配置文件

nacos配置Javahome linux nacos配置管理_微服务_02

 这里注意一定要注意选择的namespace,创建的配置文件也是隔离namespace。否则很容易就出现读取不到配置文件的情况。

然后在弹出的表单中,填写配置信息:

nacos配置Javahome linux nacos配置管理_热部署_03

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

 2.微服务中拉取nacos配置

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

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

因为读取nacos的配置文件需要在读取application.yml之前,所以必须需要在得到application.yml之前读取到naocs地址,去nacos拉取到相关的配置,因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:

nacos配置Javahome linux nacos配置管理_nacos_04

 1)引入nacos-config依赖

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

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

2)添加bootstrap.yaml

然后,在user-service的resouce中添加一个bootstrap.yaml文件, yml也可以,内容如下:

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境,这里是dev
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      discovery:
        cluster-name: HZ
      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

nacos配置Javahome linux nacos配置管理_nacos_05

注意这里也可以不带环境,例如在nacos创建了userservice.yml的配置,这里只需要配置${spring.application.name}和${spring.application.name},就可以访问到userservice.yml

3)读取nacos配置

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

@Value("${pattern.dateformat}")
    private String dateFormat;

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

结果如下:

nacos配置Javahome linux nacos配置管理_热部署_06

3.配置热部署

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

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

3.1方式一

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

nacos配置Javahome linux nacos配置管理_nacos_07

 3.2方式二

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

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

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

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

nacos配置Javahome linux nacos配置管理_微服务_08

 根据上述的两种方式都可以达到nacos配置修改,热部署的效果,因为@Value需要配置@RefreshScope才可以实现效果,而@ConfigurationProperties就可以达到相同的效果,则推荐使用方式二。

4.共享配置

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

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

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

4.1添加一个环境共享配置

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

nacos配置Javahome linux nacos配置管理_spring_09

4.2在user-service中读取共享配置

nacos配置Javahome linux nacos配置管理_热部署_10

nacos配置Javahome linux nacos配置管理_热部署_11

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

nacos配置Javahome linux nacos配置管理_nacos_12

 则环境共享配置,无论是什么环境都能读取到这个配置

4.3配置共享的优先级

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

nacos配置Javahome linux nacos配置管理_spring cloud_13

 nacos配置 > 本地配置。 nacos环境配置 > nacos共享配置