Nacos 2.2.x
- 一、安装和鉴权
- 二、项目中配置集成
- 1.位置问题
- 2.namespace命名空间
- 3.username和password
- 4.group
- 5.file-extension
- 6.prefix
- 7.shared-configs
- 三、实战
- 1.新建一个命名空间,取名wq-config(这个你随意),会随机生成一个命名空间ID
- 2.新建下面几个测试的配置
- 3.我们用代码验证一下新增的几个配置
你说这人到了二十七八,怎么就那么爱忘事,前面写了nacos的安装:Docker安装nacos并开启鉴权,本来打算接着写一篇nacos具体使用配置的,但是不知道怎么就忘了,然后今天突然想到了nacos一个问题,还得去百度查,所以还是整篇文章记录下,查百度不如查自己。
一、安装和鉴权
安装就不多谈了,大家移步我前面一篇文章:Docker安装nacos并开启鉴权
没有用docker,直接去官网:https://nacos.io/download/nacos-server/下载二进制安装包,开箱即用,也非常方便。
二、项目中配置集成
由于我用的是SpringCloud Alibaba的集成,所以配置前缀就是下面这样:
spring:
cloud:
nacos:
discovery:
server-addr: 172.16.72.133:8848
namespace: e8942369-0b37-44a0-b711-3927db1796ad
username: nacos
password: nacos
config:
server-addr: 172.16.72.133:8848
namespace: 76dae550-4133-44d8-b591-dc82f5f97b6e
username: nacos
password: nacos
group: MY_GROUP
file-extension: yaml
prefix: application
shared-configs:
- data-id: test-shared.yaml
group: MY_GROUP
- data-id: test-shared-another-group.yaml
group: ANOTHER_GROUP
这里的spring.cloud.nacos.discovery配置主要用作服务的注册与发现的,是配套使用的,所以先写在这里
我们重点看下面的spring.cloud.nacos.config,我会挑一些常用的,根据配置顺序依次讲解。
1.位置问题
spring.cloud.nacos.config这个配置,必须要写在bootstrap.properties或者bootstrap.yml中,这个是必须的,不能改,bootstrap和application的区别,bootstrap是系统级别的配置,application是模块级别的配置,而且加载优先级yml高于properties,同名称的配置文件,properties会覆盖yml,但是配置优先级:properties的优先级大于yml
2.namespace命名空间
创建方式
这是nacos的第一层配置隔离(group是第二层),一般情况下,不同命名空间下面的配置不能互通。
3.username和password
nacos 2.2.x版本开启鉴权后,每个配置nacos的地方,都得加上用户名和密码,不然就报错
4.group
这是nacos的第二层配置隔离,同一个namespace下面,如果group不同,那么一般情况下,配置不互通
5.file-extension
这是新建配置的data-id的文件后缀
6.prefix
这是新建配置的data-id的文件前缀
7.shared-configs
前面我们讲到了配置隔离namespace和group,说的都是一般情况下,配置不互通,那么如果真有特殊需求怎么办,这就用到了shared-configs字段,代表共享配置,可以互通,格式就按照下面的来,有多个就平铺,group必须指定,不管是不是相同的group,不然配置都会找不到。
shared-configs:
- data-id: test-shared.yaml
group: MY_GROUP
- data-id: test-shared-another-group.yaml
group: ANOTHER_GROUP
三、实战
1.新建一个命名空间,取名wq-config(这个你随意),会随机生成一个命名空间ID
2.新建下面几个测试的配置
-
data-id为:application-dev.yaml
-
data-id为:application-common.yaml
-
data-id为:test-shared.yaml
-
data-id为:test-shared-another-group.yaml
我在这里详细解释一下创建者几个配置,是为了验证什么:
我们先回顾下前面的两个配置prefix前缀 和 file-extension后缀
1.首先说一下nacos,它会默认加载prefix.file-extension的为data-id的配置文件
2.其次,配合spring的配置spring.profiles.active,我们在application.properties文件中加入下面这个
spring.profiles.active=dev,common
- 我们都知道spring.profiles.active是为了切换开发环境和生产环境,除了切换外,在nacos这里它还有一个作用,就是指定加载某个配置文件。
- 比如我们的dev和common,我们在spring.profiles.active中配置了,就会去nacos加载prefix-[配置的名字].file-extension的文件,比如我们这里配置了dev,就会去加载application.dev.yaml的文件,至于dev你可以换个其他任意的名字。
- 如果我们nacos新增了application.dev.yaml的配置,但是在spring.profiles.active中不指定,就会加载报错加载不出来
3.我们用代码验证一下新增的几个配置
-
新建一个配置类,用spring的value注入,我们可以看到,@Value注解里面的内容,都是我们在nacos控制台上新增的配置中,yaml里面的内容。@RefreshScope注解是可以动态刷新配置,当nacos网页中的配置发生修改,代码中也能修改。
import lombok.Data; import org.springframework.beans.factory.annotation.Value; import org.springframework.cloud.context.config.annotation.RefreshScope; import org.springframework.context.annotation.Configuration; @Configuration @Data @RefreshScope public class TestConfiguration { @Value("${wq.name}") private String name; @Value("${wq.age}") private int age; @Value("${city.cityName}") private String cityName; @Value("${mail.address}") private String address; @Value("${wangqing.name}") private String wqName; }
这里思考一下,为什么我们在nacos控制台新增的配置,在代码中可以用@Value获取到?
其实是因为nacos本质会将网页中的配置本地化到项目中,这样就能通过代码获取,跟你在项目中的application.properties等文件配置一样。
-
写个接口去请求
@RestController @RequestMapping("/test") public class TestController { private static final Logger logger = LoggerFactory.getLogger(TestController.class); @Resource UserInfoService userInfoService; @Autowired TestConfiguration testConfiguration; @RequestMapping("/testOne") public void test() { System.out.println(testConfiguration.getName()); System.out.println(testConfiguration.getCityName()); System.out.println(testConfiguration.getAddress()); System.out.println(testConfiguration.getWqName()); } }
-
启动看看效果
其实这里,只要我们项目能成功启动,说明配置就是对的,不然就会报下面这个错误:
我们浏览器请求一下,看看控制台打印:
可以看到,是能正确打印的
而且@Value(“ c i t y . c i t y N a m e " ) 和 @ V a l u e ( " {city.cityName}")和@Value(" city.cityName")和@Value("{mail.address}”)能够成功打印,也验证了前面说到的shared-configs的配置。