SpringCloud2-Nacos配置管理

Nacos配置管理

Nacos除了可以做注册中心，同样可以做配置管理来使用。
Nacos可以将配置集中管理，在配置变更时，及时通知微服务，实现配置的热更新。

注意：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。

在nacos中管理配置

从微服务拉取配置

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

因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取，后合并

步骤：

在Nacos中添加配置文件
在微服务中引入nacos的config依赖
在微服务中添加bootstrap.yml，配置nacos地址、当前环境、服务名称、文件后缀名。

1）引入nacos-config依赖，在user-service服务pom.xml中，引入nacos-config的客户端依赖：

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

2）添加bootstrap.yaml

然后，在user-service/src/main/resources/下添加文件：bootstrap.yml

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地址

测试验证测试userservice-dev.yaml

pattern:
  dateformat: yyyy-MM-dd HH:mm:ss

再根据上面的bootstrap.yml里的三个部分的值：识别出userservice-dev.yaml

$spring.application.name\ast \ast -\ast \ast${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}

3）读取nacos配置

在user-service/src/main/java/cn/itcast/user/web/UserController.java中添加业务逻辑，读取pattern.dateformat配置：

package cn.itcast.user.web;
...
    //注入nacos中的配置属性
    @Value("${pattern.dateformat}")
    private String dateformat;
    //通过日期格式化器来格式化现在的时间，并返回
    @GetMapping("now")
    public String now(){
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
    }
    // ...略
}

在页面访问localhost:8081/user/now 可以看到格式化的时间效果

配置热更新

方法一：
在@Value注入的变量所在class上面添加注解@RefreshScope：

pattern:
  dateformat: yyyy年MM月dd日 HH:mm:ss

修改后，nacos重新发布测试

方法二：

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

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

package cn.itcast.user.config;
...

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

1.3.配置共享

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

[spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml

[spring.application.name].yaml，例如：userservice.yaml

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

1）添加一个环境共享配置

我们在nacos中添加一个userservice.yaml文件发布：

pattern:
  envShareValue: 共享属性值

2）在user-service中读取共享配置

在user-service服务中，修改PatternProperties类，读取新添加的属性：

[root@test cloud-demo]# cat user-service/src/main/java/cn/itcast/user/config/PatternProperties.java
package cn.itcast.user.config;

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;
    private String envSharedValue;      //添加属性值
    private String name;
}

在user-service服务中，修改UserController，添加一个方法：

[root@test cloud-demo]# cat user-service/src/main/java/cn/itcast/user/web/UserController.java
...
@Slf4j
@RestController
@RequestMapping("/user")
// @RefreshScope
public class UserController {
...
    @Autowired
    private PatternProperties properties;

    @GetMapping("prop")
    public PatternProperties properties(){
        return properties;
    }
...

localhost:8081/user/prop     可以读取到envSharedValue，以及dev环境的时间

微服务会从nacos读取的配置文件：
获取的属性值优先级：
[服务名]-[环境].yaml > [服务名].yaml > 本地配置

    return properties;
}

…

localhost:8081/user/prop 可以读取到envSharedValue，以及dev环境的时间

微服务会从nacos读取的配置文件：
获取的属性值优先级：
[服务名]-[环境].yaml  >  [服务名].yaml  >  本地配置