nacos

配置文件读取流程

  1. 项目启动

  2. bootstrap.yaml:存放nacos的配置,例如nacos地址信息

  3. nacos配置:因为读取nacos配置在application之前,所以需要先配置bootstrap文件的nacos地址

  4. 读取application.yaml

  5. 创建spring容器

服务端配置

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中添加一个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,来读取配置。

如果想自定义文件读取

spring:
  application:
    name: user-service
  cloud:
    nacos:
      #     server-addr: nacos.jecyp.cn
      server-addr: localhost:8848
      discovery:
        namespace: dev
        group: local
        cluster-name: jecyp
        ephemeral: false
        username: nacos
        password: nacos
      config:
        server-addr: localhost:8848
        namespace: dev
        group: local
        prefix: userService
        fileExtension: yaml
        username: nacos
        password: nacos

配置热更新

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

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

方式一@Value

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

@Slf4j
@RestController
@RequestMapping("/user")
@RefreshScope
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));
    }

方式二

使用@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;
}

采用@ConfigurationProperties的形式,即可完成配置热更新。需要使用的地方,自动注入即可

多环境配置

如果不修改prefix配置,按照${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。

可以实现多环境配置读取。

服务名-profile.fileSuffix>服务名.fileSuffix>服务名>本地配置