Nacos
除了可以做注册中心,同样可以做配置管理来使用。
当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。
Nacos
一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。
nacos
中添加配置文件如何在nacos
中管理配置呢?
然后在弹出的表单中,填写配置信息:
注意:项目的核心配置,需要热更新的配置才有放到
nacos
管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。
微服务要拉取nacos
中管理的配置,并且与本地的application.yml
配置合并,才能完成项目启动。
但如果尚未读取application.yml
,又如何得知nacos
地址呢?
因此spring
引入了一种新的配置文件:bootstrap.yaml
文件,会在application.yml
之前被读取,流程如下:
1)引入nacos-config
依赖
首先,在user-service
服务中,引入nacos-config
的客户端依赖:
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
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,来读取配置。
本例中,就是去读取userservice-dev.yaml
:
3)读取nacos
配置
在user-service
中的UserController
中添加业务逻辑,读取pattern.dateformat
配置:
完整代码:
package com.dcxuexi.user.web;
import com.dcxuexi.user.pojo.User;
import com.dcxuexi.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(){
System.out.println(dateformat);
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
}
/**
* 路径: /user/110
*
* @param id 用户id
* @return 用户
*/
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id) {
return userService.queryById(id);
}
}
在页面访问,可以看到效果:
我们最终的目的,是修改nacos
中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。
要实现配置热更新,可以使用两种方式:
在@Value
注入的变量所在类上添加注解@RefreshScope
:
使用@ConfigurationProperties
注解代替@Value
注解。
在user-service
服务中,添加一个类,读取patterrn.dateformat
属性:
package com.dcxuexi.user.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/***
* @Title PatternProperties
* @Description TOTD
* @Auter DongChuang
* @Date 2023/3/11 15:59
* @Version 1.0.0
*/
@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
private String dateformat;
}
在UserController
中使用这个类代替@Value
:
完整代码:
package com.dcxuexi.user.web;
import com.dcxuexi.user.config.PatternProperties;
import com.dcxuexi.user.pojo.User;
import com.dcxuexi.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
@Slf4j
@RestController
@RequestMapping("/user")
//@RefreshScope
public class UserController {
@Autowired
private UserService userService;
//@Value("${pattern.dateformat}")
//private String dateformat;
@Autowired
private PatternProperties patternProperties;
@GetMapping("now")
public String now(){
System.out.println(patternProperties.getDateformat());
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
}
/**
* 路径: /user/110
*
* @param id 用户id
* @return 用户
*/
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id) {
return userService.queryById(id);
}
}
其实微服务启动时,会去nacos
读取多个配置文件,例如:
[spring.application.name]-[spring.profiles.active].yaml
,例如:userservice-dev.yaml
[spring.application.name].yaml
,例如:userservice.yaml
而[spring.application.name].yaml
不包含环境,因此可以被多个环境共享。
下面我们通过案例来测试配置共享
我们在nacos
中添加一个userservice.yaml
文件:
user-service
中读取共享配置在user-service
服务中,修改PatternProperties
类,读取新添加的属性:
在user-service
服务中,修改UserController
,添加一个方法:
UserApplication
,使用不同的profile
修改UserApplication2
这个启动项,改变其profile
值:
这样,UserApplication(8081)
使用的profile
是dev
,UserApplication2(8082)
使用的profile
是test
。
启动UserApplication
和UserApplication2
访问http://localhost:8081/user/prop
,结果:
访问http://localhost:8082/user/prop
,结果:
可以看出来,不管是dev
,还是test
环境,都读取到了envSharedValue
这个属性的值。
当nacos
、服务本地同时出现相同属性时,优先级有高低之分: