若依springcloud nacos 本地测试 springcloud nacos config

转载

月光倾城美 2024-03-13 21:16:40

文章标签 spring cloud java 微服务 spring 配置文件 文章分类 架构后端开发

一，服务配置中心介绍

二、Nacos config入门

实现服务配置的步骤：

1 搭建nacos环境【使用现有的nacos环境即可】

2 在微服务公共模块中引入nacos的依赖

3 在微服务service-product中添加nacos config的配置

4 在nacos中添加配置点击配置列表

5 注释本地的application.yaml中的内容，启动程序进行测试

三、Nacos config深入

3.1实现配置数据的动态刷新

方式①：硬编码处理

方式②：注解式（推荐）

配置共享

3.2 同一个微服务的不同环境之间共享配置

1 新建一个名为shop-product(spring.application.name).yml 配置存放商品微服务的公共配置

编辑

2 添加测试方法

3.3 不同微服务中间共享配置

1 在nacos中定义一个DataID为all-service.yaml的配置，用于所有微服务共享

编辑

2 修改bootstrap.yml

3 启动商品微服务进行测试

四、Nacos的几个概念

新建命名空间

一，服务配置中心介绍

首先我们来看一下,微服务架构下关于配置文件的一些问题：

配置文件相对分散。在一个微服务架构下，配置文件会随着微服务的增多变的越来越多，而且分散在各个微服务中，不好统一配置和管理。
配置文件无法区分环境。微服务项目可能会有多个环境，例如：测试环境、预发布环境、生产环境。每一个环境所使用的配置理论上都是不同的，一旦需要修改，就需要我们去各个微服务下手动维护，这比较困难。
配置文件无法实时更新。我们修改了配置文件之后，必须重新启动微服务才能使配置生效，这对一个正在运行的项目来说是非常不友好的。 基于上面这些问题，我们就需要配置中心的加入来解决这些问题。

配置中心的思路是：

首先把项目中各种配置全部都放到一个集中的地方进行统一管理，并提供一套标准的接口。
当各个服务需要获取配置的时候，就来配置中心的接口拉取自己的配置。
当配置中心中的各种参数有更新的时候，也能通知到各个服务实时的过来同步最新的信息，使之动态更新。

当加入了服务配置中心之后，我们的系统架构图会变成下面这样：

若依springcloud nacos 本地测试 springcloud nacos config_微服务

在业界常见的服务配置中心，有下面这些：

Apollo Apollo是由携程开源的分布式配置中心。特点有很多，比如：配置更新之后可以实时生效，支持灰度发布功能，并且能对所有的配置进行版本管理、操作审计等功能，提供开放平台API。并且资料也写的很详细。
Disconf Disconf是由百度开源的分布式配置中心。它是基于Zookeeper来实现配置变更后实时通知和生效的。
SpringCloud Config 这是Spring Cloud中带的配置中心组件。它和Spring是无缝集成，使用起来非常方便，并且它的配置存储支持Git。不过它没有可视化的操作界面，配置的生效也不是实时的，需要重启或去刷新。
Nacos 这是SpingCloud alibaba技术栈中的一个组件，前面我们已经使用它做过服务注册中心。其实它也集成了服务配置的功能，我们可以直接使用它作为服务配置中心。

二、Nacos config入门

使用nacos作为配置中心，其实就是将nacos当做一个服务端，将各个微服务看成是客户端，我们将各个微服务的配置文件统一存放在nacos上，然后各个微服务从nacos上拉取配置即可。

接下来我们以商品微服务为例，学习nacos config的使用。

实现服务配置的步骤：

1 搭建nacos环境【使用现有的nacos环境即可】
2 在微服务公共模块中引入nacos的依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

注：由于配置中心的依赖在多个微服务中都需要引入，所以此处建议将其加入到公共模块中。
3 在微服务service-product中添加nacos config的配置
1）不能使用原来的application.yml作为配置文件，而是新建一个bootstrap.yml作为配置文件；
2）在bootstrap和application数据项相同时，bootstrap中的配置不会被覆盖；
3）配置文件优先级(由高到低):
bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml
spring: application: name: shop-product cloud: nacos: config: server-addr: localhost:8848 # nacos的服务端地址 file-extension: yml # 配置文件格式 profiles: active: dev # 环境标识
说明：之所以需要配置 spring.application.name ，是因为它是构成 Nacos 配置管理 dataId字段的一部分。在 Nacos Spring Cloud 中，dataId 的完整格式如下：
${prefix}-${spring.profiles.active}.${file-extension}
prefix：默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置
spring.profiles.active：即为当前环境对应的 profile。 注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变
file-exetension：为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。
配置完成之后，请启动微服务shop-product并查看控制台日志信息：
这个时候可以很明显发现启动项目之后，已经开始从nacos配置中心拉去相应配置信息了，只是现在还没有到nacos配置中心去配置而已。
4 在nacos中添加配置点击配置列表
，点击右边+号，新建配置。在新建配置过程中，要注意下面的细节：
1）Data ID不能随便写，要跟配置文件中的对应，对应关系如图所示 2）配置文件格式要跟配置文件的格式对应，且目前仅仅支持YAML和Properties 3）配置内容按照上面选定的格式书写
成功

5 注释本地的application.yaml中的内容，启动程序进行测试
如果依旧可以成功访问程序，说明我们nacos的配置中心功能已经实现

三、Nacos config深入

3.1实现配置数据的动态刷新

方式①：硬编码处理

@RestController
//@requestMapping("载化路径")
public class NacosConfigController {
	@Autowired
	private ConfigurableApplicationContext applicationContext;
	//1 硬编码方式
	@GetMapping("/test1")
	public String nacosConfingTest1() {
		return applicationContext.getEnvironment().getProperty("config.appName");
	}
}

完整代码：

package com.ljj.shopproduct.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("nacos-config")
public class NacosConfigController {
	@Autowired
	private ConfigurableApplicationContext applicationContext;
	//1 硬编码方式
	@GetMapping("/test1")
	public String nacosConfingTest1() {
		return applicationContext.getEnvironment().getProperty("config.appName");
	}


}

若依springcloud nacos 本地测试 springcloud nacos config_微服务_07

读取成功

若依springcloud nacos 本地测试 springcloud nacos config_spring cloud_08

修改

若依springcloud nacos 本地测试 springcloud nacos config_微服务_09

刷新网址：

若依springcloud nacos 本地测试 springcloud nacos config_配置文件_10

这样的话我们在读取我们在Nacos配置中心中添加的config.appName就可以读写到了节省了我们在开发过程中很繁琐的重启

方式②：注解式（推荐）

@RestController
@RefreshScope//只需要在需要动态读取配置的类上添加此注解就可以
public class NacosConfigController {
	@Value("${config.appName}")
	private String appName;
	//2 注解方式
	@GetMapping("/test2")
	public String nacosConfingTest2() {
		return appName;
	}
}

完整代码

package com.ljj.shopproduct.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("nacos-config")
@RefreshScope
public class NacosConfigController {
	@Autowired
	private ConfigurableApplicationContext applicationContext;
	//1 硬编码方式
	@GetMapping("/test1")
	public String nacosConfingTest1() {
		return applicationContext.getEnvironment().getProperty("config.appName");
	}

		@Value("${config.appName}")
		private String appName;
		//2 注解方式
		@GetMapping("/test2")
		public String nacosConfingTest2() {
			return appName;
		}
}

若依springcloud nacos 本地测试 springcloud nacos config_spring cloud_11

注入配置文件属性:@Value @ConfigurationProperties应的bean的后置处理器为 ConfigurationPropertiesBindingPostProcessor,它是实现了BeanPostProcessor接口，在bean被实例化后，会调用后置处理，递归的查找属性，通过反射注入值，属性需提供其setter和getter方法。

配置共享

当配置越来越多的时候，我们就发现有很多配置是重复的，这时候就考虑可不可以将公共配置文件提取出来，然后实现共享呢？当然是可以的。接下来我们就来探讨如何实现这一功能。

3.2 同一个微服务的不同环境之间共享配置

如果想在同一个微服务的不同环境之间实现配置共享，其实很简单。只需要提取一个以spring.application.name 命名的配置文件，然后将其所有环境的公共配置放在里面即可。

同一个微服务不同环境的共享配置步骤：

1 新建一个名为shop-product(spring.application.name).yml 配置存放商品微服务的公共配置

2 添加测试方法

//3 读取shop-product所有环境共享配置
	@Value("${config.os}")
	private String os;
	@RequestMapping("/test3")
	public String nacosConfingTest3() {
		return os;
	}

测试的方法：
小刘另外准备了一个商品服务的测试环境用于测试
修改yml文件中的服务环境为test环境然后启动服务，访问我们的测试方法路径，
然后再改为dev 开发环境再次访问，是否全部为windows 若是即成功
修改测试环境 test
访问为windows 是公共配置中的信息
修改开发环境 dev
访问为windows 是公共配置中的信息
成功！！！
若不想使用公共配置中的信息，只要在自己的所属环境中添加同样的配置信息覆盖即可
覆盖成功

3.3 不同微服务中间共享配置

思考以下情况：用户微服务商品微服务订单微服务存在某一组件或者框架的配置是一样的

就比如：每个服务之间都有一个application.yml文件对于这种情况我们可以一个地方定义多个地方利用

不同为服务之间实现配置共享的原理类似于文件引入，就是定义一个公共配置，然后在当前配置中引入。

1 在nacos中定义一个DataID为all-service.yaml的配置，用于所有微服务共享
2 修改bootstrap.yml

extension-configs[0]:
 data-id: all-service.yml
 group: DEFAULT_GROUP
 refresh: true
 
shared-configs[0]:
 data-id: all-service.yml
 group: DEFAULT_GROUP
 refresh: true
extension-configs的优先级高于shared-configs

3 启动商品微服务进行测试

//4 读取不同服务间的共享配置
	@Value("${config.rabbitMQ}")
	private String ip;
	@RequestMapping("/test4")
	public String nacosConfingTest4() {
		return ip;
	}

四、Nacos的几个概念

命名空间(Namespace) 命名空间可用于进行不同环境的配置隔离。一般一个环境划分到一个命名空间
配置分组(Group) 配置分组用于将不同的服务可以归类到同一分组。一般将一个项目的配置分到一组
配置集(Data ID) 在系统中，一个配置文件通常就是一个配置集。一般微服务的配置就是一个配置集