Java nacos动态配置实现流程详解
作者:洛祁枫 发布时间:2021-06-04 19:18:30
一、前言
使用动态配置的原因: properties 和 yaml 是写到项目中的,好多时候有些配置需要修改,每次修改就要重新启动项目,不仅增加了系统的不稳定性,也大大提高了维护成本,非常麻烦,且耗费时间。
使用动态配置,则可以避免这些麻烦,可以动态的修改配置,不需要重新启动项目。
nacos配置中心,可以使得配置标准化、格式统一化,当配置信息发生变动时,修改实时生效,无需要重新重启服务器,就能够自动感知相应的变化,并将新的变化统一发送到相应程序上,快速响应变化。
本次环境使用版本:NACOS1.4.2; spring-boot 2.3.9.RELEASE;nacos-config-spring-boot-starter 0.2.1
二、在nacos上创建配置文件
创建配置文件
在默认命名空间中,创建一个配置文件
配置说明
Data ID —— 用于项目读取名称,spring-nacos 动态配置命名规范为 :{prefix}-{spring.profiles.active}.{file-extension}
prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
spring.profiles.active 即为当前环境对应的 profile,就是环境的命名,比如 test 环境, dev 环境;spring.profiles.active 可以为空,为空着不区分环境信息,dataId 的拼接格式变成 {prefix}.{file-extension}。
file-exetension 为配置内容的数据格式,一般常用 properties 和 yaml 类型。
说明:
我这次修改的项目是网关,项目名称 :gateway(spring.application.name= gateway)
没有使用环境配置
所以 nacos 的配置文件为: {prefix}.{file-extension} 即 gateway.yml
如果有配置环境的,可以为 {prefix}-{spring.profiles.active}.{file-extension} 即 gateway-dev.yml
本次配置文件名称为 gateway.yml
注意: 项目启动时,nacos-config 会自动加载以下文件,故以下文件名称都可以作为默认动态配置的文件格式。
icp-gateway-dev.yml,icp-gateway.yml,icp-gateway,(说明,这三个文件,可以指定命名 nacos 分组)
common.yml (该文件为默认分组,DEFAULT_GROUP)
添加测试使用的配置 nacosConfigDemmo: NAME1
说明: 本次配置项目,分组名称为 ICP_PLATFORM (注意:分组名称建议使用下划线 _ ,不建议使用 中横线 - ,中横线会有几率出现不能读取的问题,使用连接符请注意使用;分组名可以自定,如果要区分命名空间,需要到 nacos 命名空间 中新建 命名空间)
发布并检查配置文件
编辑完成之后,直接点击发布,会提示新建完成
点击确定,然后点击返回配置中心,在配置列表中能找到自己的配置文件,确保文件内容正确即可
至此,配置文件完成,接下来在项目中使用这个配置文件。
三、 修改项目配置与动态读取配置文件
添加 nacos 动态配置依赖
在 pom.xml 文件中,添加依赖。
<dependency>
<groupId>com.alibaba.boot</groupId>
<artifactId>nacos-config-spring-boot-starter</artifactId>
<version>0.2.1</version>
</dependency>
修改项目配置文件,读取 nacos 中的配置内容
# 指定启动端口
server:
port: 7200
spring:
application:
# 指定服务名称
name: gateway
# 项目运行环境,可以搭配在 nacos 动态配置文件名上面,不同环境使用不同的动态配置
profiles:
active: dev
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848 #nacos 的注册地址
file-extension: yml #动态配置文件的 格式。就是 nacos 中的动态配置,这里是 yml
group: ICP_PLATFORM #nacos 动态配置的分组,要与 nacos 配置文件保持一致
# namespace: #namespace 是nacos 的命名空间,我这儿是默认空间,就不配置了
在controller与service中使用动态配置
controller 代码:
import com.insupro.search2.service.IIndexService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api/demo")
public class nacosConfigDemmo {
@Autowired
private DemoService demoService;
@GetMapping("/name")
public Object showDemoName(){
return demoService.showDemoName();
}
}
service 接口代码:
public interface IIndexService {
Object showDemoName();
}
service 实现代码:
import com.insupro.search2.service.demoService;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Service;
@Service
// 注意,要自动刷新配置,需要 @RefreshScope 这个注解
@RefreshScope
public class demoServiceImpl implements demoService{
/**
* 使用在上面nacos 中添加的测试使用配置。
*/
@Value("${nacosConfigDemmo}")
private String demoName;
@Override
public Object showDemoName(){
return demoName;
}
}
运行,请求接口地址,得到响应值:
postman 请求,第一次响应,值为 NAME2
修改 nacos 配置文件,将 nacosConfigDemmo: NAME1 改为 nacosConfigDemmo: NAME2 并发布
等待控制台打印: Refresh keys changed: [nacosConfigDemmo],则动态配置已经生效
再次请求,发现返回值已经改变:
请求结果,NAME1 已经变成 NAME2,项目不需要重启,动态配置已经生效。
四、 动态配置网关的使用
导入配置,网关不进行权限校验的路径
获取配置文件,生成 bean
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cloud.context.config.annotation.RefreshScope;
// 自动刷新机制,需要 get 方法支撑
@Setter
@Getter
// 获取配置文件
@ConfigurationProperties(prefix = "security.ignore")
// 开启自动刷新
@RefreshScope
public class SecurityProperties {
private PermitProperties ignore = new PermitProperties();
}
配置文件实体类
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class PermitProperties {
/**
* 设置不用认证的url
*/
private String[] httpUrls = {};
public String[] getUrls() {
if (httpUrls == null || httpUrls.length == 0) {
return new ArrayList<>();
}
List<String> list = new ArrayList<>();
for (String url : httpUrls) {
list.add(url);
}
return list.toArray(new String[list.size()]);
}
}
至此,导入自动配置完成,可以根据自己的业务代码进行网关的配置与使用。
但是!!注意!! 如果在配置文件中调用配置,则需要在配置文件中使用 @RefreshScope 注解,用于刷新配置。因为配置文件在项目启动时便已经完成加载。
例如:
@Configuration
public class ResourceServerConfiguration {
@Autowired
private SecurityProperties securityProperties;
// 使用了 @Configuration 定义配置文件,并在配置类中使用 @Bean 装配 bean,此时如果在自动装配出没有使用 @RefreshScope 注解,则自动配置不会生效。
@Bean
@Autowired(required = false)
@RefreshScope
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
if (securityProperties.getIgnore().getUrls().length > 0) {
authorizeExchange.pathMatchers(securityProperties.getIgnore().getUrls()).permitAll();
}
// TODO 余下自行业务代码 …………
return http.build();
}
}
来源:https://blog.csdn.net/hongchen006/article/details/126586367
猜你喜欢
- JPanel是面板组件,非顶层容器,一个界面只有可以有一个JFrame窗体组件,但可以有多个Jpanel面板,而JPanel上也可以使用Fl
- 在本次项目中,由于时间紧张直接使用DWR做Ajax请求!要求的是动态展示,那就需要使用DWR轮询请求,但是需要做异常情况下的一些处理!特别是
- springboot URL带有斜杠的转义字符百分之2F导致的400错误今天项目上出现一个问题,是前端的GET请求url中带有路径参数,这个
- 如下所示:if(str.indexOf(",") >= 0) System.out.println(&
- 现象在日志配置文件 logback-spring.xml 中,无论怎么修改级别,mybatis 的 sql 日志都会打印出来。原因在 app
- 简介在 Java 开发领域,热部署一直是一个难以解决的问题,目前的 Java 虚拟机只能实现方法体的修改热部署,对于整个类的结构修改,仍然需
- 本文实例讲述了Java二叉搜索树基础原理与实现方法。分享给大家供大家参考,具体如下:前言:本文通过先通过了解一些二叉树基础知识,然后在转向学
- 由于jdk 1.8 之后sun.misc 包下的 BASE64Decode的依赖 被移除我们需要在自己的项目中引入EncodeUtils 工
- 我们很多时候会碰到这样的问题,使用多线程刷一个表的数据时需要多个线程不能重复提取数据,那么这个时候就需要使用到线程的排他锁了。在c#里面其实
- C#实现修改文件的创建、修改和访问时间方法,主要是用到了File类的SetCreationTime、SetLastWriteTime、Set
- finalize方法是什么finalize方法是Object的protected方法,Object的子类们可以覆盖该方法以实现资源清理工作,
- 这篇文章主要介绍了Java实现inputstream流的复制代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习
- JDK * :利用反射机制生成一个实现代理接口的匿名类,在调用具体方法前调用InvokeHandler来处理。CGlib * :利用AS
- 一个基于Java Socket协议之上文件传输的完整示例,基于TCP通信完成。除了基于TCP的二进制文件传输,还演示了JAVA Swing的
- 自动装配的含义在SpringBoot程序main方法中,添加@SpringBootApplication或者@EnableAutoConfi
- springboot项目还是ssm等java常用框架都会有这样的问题,解决办法通用问题场景前端发送Post请求,前端返回400 Bad Re
- 1.官方地址:http://mybatis.plus/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%
- 为什么要使用克隆? 想对一个对象进行处理,又想保留原有的数据进行接下来的操作,就需要克隆了,Java语言中克隆针对的是类的实例。如何实现对象
- 单例:Singleton,是指仅仅被实例化一次的类。饿汉单例设计模式一、饿汉设计模式public class SingletonHungry
- 在LINUX上部署带有JAR包的JAVA项目首先eclipse上要装上一个小插件,叫做Fat Jar点击Fat Jar红框里选上主类点击Ne