【Java项目】从0到1完成Nacos配置文件扩展和共享

今天药忘吃喽~ 2024-03-16 14:45 27阅读 0赞

#### 文章目录 ####

*  环境配置
 *  配置文件
 *  名称空间和组
 *  扩展配置
 *  共享配置文件
 *  配置文件优先级

使用nacos作用配置中心的好处在于我们可以在云端上修改配置文件之后，使得本地的配置重新生效，从而做到不用重启项目也可以加载新的配置。

## 环境配置 ##

首先引入依赖，我们知道，SpringBoot的版本和SpringCloud以及SpringCloudAlibaba的版本是有对应关系的，也就是使用对应的关系，能减少bug的出现。  
下面配置文件中的前三行我先列出了我的版本。  
配置完毕版本之后，首先需要引入Spring-boot-starter-web，否则使用Nacos将会失效。  
然后，如果你的项目需要将服务注册到注册中心，那么就需要引入discovery这个依赖，他是服务发现依赖，而如果你不需要进行服务注册，则不需要引入这个依赖。  
config这个依赖则是使用nacos的配置中心，所以这个依赖我们需要引入。

<spring-boot.version>2.3.7.RELEASE</spring-boot.version>
            <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
            <spring-cloud-alibaba.version>2.2.6.RELEASE</spring-cloud-alibaba.version>
    
            
           <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
           </dependency>
     	   <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            </dependency>

## 配置文件 ##

#微服务配置
    spring:
      application:
        name: towelove
      cloud:
        nacos:
          server-addr: 192.168.146.114:8848
          discovery: # 开启服务发现
            namespace: 默认public
            group: 默认为DEFAULT_GROUP
          config: # 开启配置中心
            namespace: 默认public
            group: 默认为DEFAULT_GROUP
            file-extension: yaml # 配置文件类型
            refresh-enabled: true # 开启动态刷新
      #profiles默认为dev
      profiles:
        active: dev

上面的代码比较好理解，spring.application.name是必须的，他代表了这个服务的服务名称，spring.profiles.active就是你的开发环境，比如dev开发，prod生产，test测试环境。

**到目前位置我们看上去好像没有映入任何的配置文件对吗？**

其实不是的，Nacos默认此时已经去寻找了一个dataId如下的配置文件：

${
        prefix}-${
        spring.profiles.active}.${
        file-extension}

prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。

spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档。 注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，  
dataId 的拼接格式变成\{prefix\}-\{file-extension\}

file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

所以，以上面的为例，此时这个服务一旦启动，就会先去配置中心中查找一个叫做  
towelove-dev.yaml的配置文件。如果找到了就加载，没找到就不加载。

到此为止，我们已经简单的完成了一个服务的注册，下面我们讲解一下比较重要的概念。

## 名称空间和组 ##

我们还需要知道nacos如何去定位一个具体的配置文件，即配置的三要素：namespace、group、dataid.

1、通过namespace、group找到具体的环境和具体的项目。  
2、通过dataid找到具体的配置文件，dataid有三部分组成，  
比如：towelove-dev.yaml配置文件 由（towelove）-（dev）. (yaml)三部分组成

towelove：第一部分，它是在application.yaml中配置的应用名，即spring.application.name的值。

dev：第二部分，它是环境名，通过spring.profiles.active指定，

Yaml: 第三部分，它是配置文件 的后缀，目前nacos支持properties、yaml等格式类型，本项目选择yaml格式类型。

所以，如果我们要配置towelove工程的配置文件:  
在开发环境中配置towelove-dev.yaml  
在测试环境中配置towelove-test.yaml  
在生产环境中配置towelove-prod.yaml

namespace和group  
namespace：用于区分环境、比如：开发环境、测试环境、生产环境。  
group：用于区分项目，比如：towelove项目、towelove2.0项目

我们可以创建一个名称空间，比如我们创建一个dev开发环境，**注意，这里的dataId一定要自己去填写，不然你就得在上面配置文件的地方自己复制过来她随机给你生成的dataId了！！**。  
![在这里插入图片描述][9f19ee3742be44af8cb47f35a942daab.png]  
创建完毕名称空间之后，我们就可以在对应的名称空间下创建配置文件了。  
当然，我这个项目并没有用到towelove-dev.yaml这个配置文件，我不太需要。因为我想尽可能确保见面知意。  
![在这里插入图片描述][b77e048e81994d26937438597bddc41c.png]  
上面我们已经说过，默认的group和namespace不定义的话，使用的就是DEFAULT\_GROUP和默认的这个public这个namespace。当然，对于新手来说这样子最友好。  
不过我们也可以简单的配置一下。也不难，如下：  
对于group，你填写好你自己设定的group即可，  
对于dataId，要注意的是一定要记得自己加上文件的后缀哦，如图。  
![在这里插入图片描述][d4834212d73045099e5449f8e3dbef91.png]

![在这里插入图片描述][5b90b5c6646d490b838cb448624a2eaa.png]  
上面的这张图片表示会选择namespace为dev，并且组为towelove-group的配置文件。

## 扩展配置 ##

上面我们说过，一个服务启动的时候，默认会去寻找  
$ \{prefix\}-$ \{spring.profiles.active\}.$\{file-extension\}这个配置文件。  
但是，作为SpringCloud项目，我们很可能会需要去引入其他模块的配置文件。  
例如我的项目就是，controller层单独放了一个包，也就是提供API接口，而service以及下层，都放在另一个叫做service的包中，这样子，我就可以做到独立开发两个模块的功能了。

那么其实我们知道，controller层不再需要再一次引入mysql的配置，而只需要在service包中引入，因为我们的数据库操作都是在service完成开发和测试的，那么，service包中就会需要用到mysql的配置，而controller在启动的时候也需要。  
那么，我们就可以让controller这个包去引入service的服务，同时他也会吧service包的配置文件一起读过来。  
那么我们此时就可以让controller这个服务去扩展service的配置文件。  
![在这里插入图片描述][32e5e5c42fdc421380e212049338c949.png]  
这个时候，只需要在towelove-service-dev.yaml中引入mysql的配置，那么我在做service的接口开发的时候能够成功，controller这个项目他也能成功运行。

## 共享配置文件 ##

可以在上面的图中看到我用了一个shared-configs，他代表的其实就是多个项目之间都共同使用的一些配置文件。  
比如，redis，rocketmq啊这些配置文件，他们都是共享的，那么我就可以使用共享配置文件的方式来引入他们。  
这样子我就不需要重复编写配置文件了。

## 配置文件优先级 ##

刚才说了dataid第一部分就是spring.application.name，nacos 客户端要根据此值确定配置文件 名称，所以spring.application.name不在nacos中配置，而是要在工程的本地进行配置。  
本地配置文件现在是application.yaml需要修改为bootstrap.yaml，因为SpringBoot读取配置文件 的顺序如下：  
![在这里插入图片描述][028b9c1a63f14972a320713f69617db3.png]  
因此，我们如果想要吧服务注册到Nacos，我们需要在bootstrap中配置nacos的地址。  
同时，如果说我们的配置文件他们有相同的属性怎么办？谁的优先级更高？  
我们引入配置文件的方式有：  
1：以项目应用名引入  
2：以扩展配置文件方式引入  
3：以共享配置文件方式引入  
4：本地配置文件  
那么这些配置文件的优先级如下：  
**以项目应用名引入 > 以扩展配置文件方式引入 > 以共享配置文件方式引入 > 本地配置文件**

如果本地优先级这么低的话，会让我们如果要启动多个服务的时候，不好修改端口，所以我们可以编写如下配置  
spring.cloud.config.override-none=true  
也就是关闭覆盖功能，这样子就能使得本地的配置文件不被覆盖

[9f19ee3742be44af8cb47f35a942daab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/e563bed72fd741bbbaae0e60ac618612.png
[b77e048e81994d26937438597bddc41c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/b2acbf8d49154974884ecece1b06f4e9.png
[d4834212d73045099e5449f8e3dbef91.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/5bbbc870119644f3998acf3799001a5b.png
[5b90b5c6646d490b838cb448624a2eaa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/b70b478d6fbe4f34b45e9b46698243d8.png
[32e5e5c42fdc421380e212049338c949.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/4153af1bb7094962bd04ec38c05c94ca.png
[028b9c1a63f14972a320713f69617db3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/674b3ff5db494a41a18c0b902fb3f87f.png