统一配置管理
当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。 Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。
在nacos中添加配置文件
打开管理配置
配置文件的id:[服务名称]-[profile].[后缀]
从服务拉取配置
微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。
但如果尚未读取application.yml,又如何得知nacos地址呢?因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取
引入依赖
首先,在user-service服务中,引入nacos-config的客户端依赖
<!--nacos配置管理依赖-->
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
添加yaml
然后,在user-service中添加一个bootstrap.yaml文件,内容如下 这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
作为文件id,用userservice-dev.yaml来读取配置
spring:application:name: userservice # 服务名称profiles:active: dev #开发环境,这里是dev cloud:nacos:server-addr: localhost:8848 # Nacos地址config:file-extension: yaml # 文件后缀名
读取配置
在user-service中的UserController中添加业务逻辑,读取pattern.dateformat配置
@Value("${pattern.dateformat}")private String dateformat;@GetMapping("now")public String now(){return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));}
在页面访问 ,可以看到效果 .
配置热更新
我们最终的目的,是修改nacos中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新 .
方式一
在@Value注入的变量所在类上添加注解@RefreshScope
方式二
使用@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;private String envSharedValue;private String name;
}
在UserController中使用这个类代替@Value
@Autowiredprivate PatternProperties properties;@GetMapping("prop")public PatternProperties properties(){return properties;}
配置共享
微服务启动时,会去nacos读取多个配置文件,例如:userservice-dev.yaml、userservice.yaml,
下面我们通过案例来测试配置共享。
添加环境共享配置
我们在nacos中添加一个userservice.yaml文件
读取共享配置
在user-service服务中,修改PatternProperties类,读取新添加的属性。
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 envValue;private String name;
}
user-service服务中,修改UserController,添加一个方法
@Autowiredprivate PatternProperties patternProperties;@GetMapping("prop")public PatternProperties prop(){return patternProperties;}
运行
运行两个UserApplication,使用不同的profile,修改UserApplication2这个启动项,改变其profile值
这样,UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test。
启动UserApplication和UserApplication2
访问http://localhost:8081/user/prop
访问http://localhost:8082/user/prop
配置共享的优先级
当nacos、服务本地同时出现相同属性时,优先级有高低之分