搭建nacos环境(保姆级教程)

Bertha 。 2024-03-29 15:27 107阅读 0赞

#### **2.2.1 服务发现中心** ####

根据上节讲解的网关的架构图，要使用网关首先搭建Nacos。

首先搭建Nacos服务发现中心。

在搭建Nacos服务发现中心之前需要搞清楚两个概念：namespace和group

namespace：用于区分环境、比如：开发环境、测试环境、生产环境。

group：用于区分项目，比如：xuecheng-plus项目、xuecheng2.0项目

首先在nacos配置namespace:

登录Centos，启动Naocs，使用sh /data/soft/restart.sh将自动启动Nacos。

访问：[http://192.168.101.65:8848/nacos/][http_192.168.101.65_8848_nacos]

账号密码：nacos/nacos

登录成功，点击左侧菜单“命名空间”进入命名空间管理界面，

![50803c68ba01f50b61caf308b8e1ca7c.png][]

点击“新建命名空间”，填写命名空间的相关信息。如下图：

![62b3c7bd841d3b36abd51240d946fba2.png][]

使用相同的方法再创建“测试环境”、"生产环境"的命名空间。

![3e584d23cf8e6a843debf9dc0b55590f.png][]

![bce6d6eb43bb4968cc0e212f19f75ee7.png][]

创建成功，如下图：

![407eebe23d5ca7f120d6b36e6452b89d.png][]

这里创建具体班级的命名空间，假如创建1010班级的命名空间，如下：

![86d0b58408d553cd65843bf52dde1101.png][]

首先完成各服务注册到Naocs，下边将内容管理服务注册到nacos中。

##### 1) 在xuecheng-plus-parent中添加依赖管理 #####

<table> 
 <thead> 
 <tr> 
 <th>XML com.alibaba.cloud spring-cloud-alibaba-dependencies ${spring-cloud-alibaba.version} pom import </th> 
 </tr> 
 </thead> 
</table>

##### 2）在内容管理模块的接口工程、系统管理模块的接口工程中添加如下依赖 #####

<table> 
 <thead> 
 <tr> 
 <th>XML com.alibaba.cloud spring-cloud-starter-alibaba-nacos-discovery </th> 
 </tr> 
 </thead> 
</table>

##### 3）配置nacos的地址 #####

在系统管理的接口工程的配置文件中配置如下信息：

<table> 
 <thead> 
 <tr> 
 <th>YAML#微服务配置 spring: application: name: system-service cloud: nacos: server-addr: 192.168.101.65:8848 discovery: namespace: dev group: xuecheng-plus-project</th> 
 </tr> 
 </thead> 
</table>

在内容管理的接口工程的配置文件中配置如下信息：

<table> 
 <thead> 
 <tr> 
 <th>YAMLspring: application: name: content-service cloud: nacos: server-addr: 192.168.101.65:8848 discovery: namespace: dev group: xuecheng-plus-project</th> 
 </tr> 
 </thead> 
</table>

##### 4）重启内容管理服务、系统管理服务。 #####

待微服务启动成功，进入Nacos服务查看服务列表

![cd30199fccb1c63bbcaa59598f8404e3.png][]

在 “开发环境” 命名空间下有两个服务实例。微服务在Nacos注册成功。

点击其它一个微服务的“详情”

![cb8a871ae4d444d513c4fc0956db47f9.png][]

通过上图可以查看微服务实例的地址。

#### **2.2.2 配置中心** ####

##### **2.2.2.1 配置三要素** #####

搭建完成Nacos服务发现中心，下边搭建Nacos为配置中心，其目的就是通过Nacos去管理项目的所有配置。

先将项目中的配置文件分分类：

1、每个项目特有的配置

是指该配置只在有些项目中需要配置，或者该配置在每个项目中配置的值不同。

比如：spring.application.name每个项目都需要配置但值不一样，以及有些项目需要连接数据而有些项目不需要，有些项目需要配置消息队列而有些项目不需要。

2、项目所公用的配置

是指在若干项目中配置内容相同的配置。比如：redis的配置，很多项目用的同一套redis服务所以配置也一样。

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

1、通过namespace、group找到具体的环境和具体的项目。

2、通过dataid找到具体的配置文件，dataid有三部分组成，

比如：content-service-dev.yaml配置文件 由（content-service）-（dev）. (yaml)三部分组成

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

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

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

所以，如果我们要配置content-service工程的配置文件:

在开发环境中配置content-service-dev.yaml

在测试环境中配置content-service-test.yaml

在生产环境中配置content-service-prod.yaml

##### **2.2.2.2 配置content-service** #####

下边以开发环境为例对content-service工程的配置文件进行配置，进入nacos，进入开发环境。

![1bf3d1cbca2247378db17152c8e18599.png][]

点击 加号，添加一个配置

![76bb0327895f0e59919ec912b09aabd6.png][]

输入data id、group以及配置文件内容。

为什么没在nacos中配置下边的内容 ？

<table> 
 <thead> 
 <tr> 
 <th>YAMLspring: application: name: content-service</th> 
 </tr> 
 </thead> 
</table>

因为刚才说了dataid第一部分就是spring.application.name，nacos 客户端要根据此值确定配置文件 名称，所以spring.application.name不在nacos中配置，而是要在工程的本地进行配置。

本地配置文件现在是application.yaml需要修改为bootstrap.yaml，因为SpringBoot读取配置文件 的顺序如下：

![fdfc97ae370d5f485c8111ddf0e29dab.png][]

所以在content-service工程 中添加bootstrap.yaml，内容如下：

<table> 
 <thead> 
 <tr> 
 <th>YAMLspring: application: name: content-service cloud: nacos: server-addr: 192.168.101.65:8848 discovery: namespace: ${spring.profiles.active} group: xuecheng-plus-project config: namespace: ${spring.profiles.active} group: xuecheng-plus-project file-extension: yaml refresh-enabled: true #profiles默认为dev profiles: active: dev</th> 
 </tr> 
 </thead> 
</table>

最后删除原来的application.yaml。

在内容管理模块的接口工程和service工程、系统管理的接口工程和service工程配置依赖：

<table> 
 <thead> 
 <tr> 
 <th>XML com.alibaba.cloud spring-cloud-starter-alibaba-nacos-config </th> 
 </tr> 
 </thead> 
</table>

配置完成，运行content-service工程 的单元测试文件，能否正常测试。

通过运行观察控制台打印出下边的信息：

<table> 
 <thead> 
 <tr> 
 <th>Plain Text[NacosRestTemplate.java:476] - HTTP method: POST, url: <a href="http://192.168.101.65:8848/nacos/v1/cs/configs/listener," rel="nofollow">http://192.168.101.65:8848/nacos/v1/cs/configs/listener,</a> body: {Listening-Configs=content-service.yaml?xuecheng-plus-project??dev?content-service-dev.yaml?xuecheng-plus-project?88459b1483b8381eccc2ef462bd59182?dev?content-service?xuecheng-plus-project??dev?, tenant=dev}</th> 
 </tr> 
 </thead> 
</table>

NacosRestTemplate.java通过Post方式去nacos读取配置信息。

跟踪单元测试方法可以正常读取数据库的数据，说明从nacos读取配置信息正常。

##### **2.2.2.3配置content-api** #####

以相同的方法配置content-api工程的配置文件，在nacos中的开发环境中配置content-api-dev.yaml，内容如下：

<table> 
 <thead> 
 <tr> 
 <th>YAMLserver: servlet: context-path: /content port: 63040 # 日志文件配置路径 logging: config: classpath:log4j2-dev.xml # swagger 文档配置 swagger: title: “学成在线内容管理系统” description: “内容系统管理系统对课程相关信息进行业务管理数据” base-package: com.xuecheng.content enabled: true version: 1.0.0</th> 
 </tr> 
 </thead> 
</table>

在content-api工程 的本地配置bootstrap.yaml，内容如下：

<table> 
 <thead> 
 <tr> 
 <th>YAML#server: # servlet: # context-path: /content # port: 63040 #微服务配置 spring: application: name: content-api cloud: nacos: server-addr: 192.168.101.65:8848 discovery: namespace: ${spring.profiles.active} group: xuecheng-plus-project config: namespace: s p r i n g . p r o f i l e s . a c t i v e g r o u p : x u e c h e n g − p l u s − p r o j e c t f i l e − e x t e n s i o n : y a m l r e f r e s h − e n a b l e d : t r u e e x t e n s i o n − c o n f i g s : − d a t a − i d : c o n t e n t − s e r v i c e − {spring.profiles.active} group: xuecheng-plus-project file-extension: yaml refresh-enabled: true extension-configs: - data-id: content-service- spring.profiles.activegroup:xuecheng−plus−projectfile−extension:yamlrefresh−enabled:trueextension−configs:−data−id:content−service−{spring.profiles.active}.yaml group: xuecheng-plus-project refresh: true profiles: active: dev # 日志文件配置路径 logging: config: classpath:log4j2-dev.xml # swagger 文档配置 swagger: title: “学成在线内容管理系统” description: “内容系统管理系统对课程相关信息进行业务管理数据” base-package: com.xuecheng.content enabled: true version: 1.0.0</th> 
 </tr> 
 </thead> 
</table>

注意：因为api接口工程依赖了service工程 的jar，所以这里使用extension-configs扩展配置文件 的方式引用service工程所用到的配置文件。

<table> 
 <thead> 
 <tr> 
 <th>YAML extension-configs: - data-id: content-service-${spring.profiles.active}.yaml group: xuecheng-plus-project refresh: true</th> 
 </tr> 
 </thead> 
</table>

如果添加多个扩展文件，继续在下添加即可，如下：

<table> 
 <thead> 
 <tr> 
 <th>YAML extension-configs: - data-id: content-service-${spring.profiles.active}.yaml group: xuecheng-plus-project refresh: true - data-id: 填写文件 dataid group: xuecheng-plus-project refresh: true</th> 
 </tr> 
 </thead> 
</table>

启动content-api工程，查询控制台是否打印出了请求nacos的日志，如下:

<table> 
 <thead> 
 <tr> 
 <th>Bash[NacosRestTemplate.java:476] - HTTP method: POST, url: <a href="http://192.168.101.65:8848/nacos/v1/cs/configs/listener" rel="nofollow">http://192.168.101.65:8848/nacos/v1/cs/configs/listener</a></th> 
 </tr> 
 </thead> 
</table>

并使用Httpclient测试课程查询接口是否可以正常查询。

#### **2.2.3 公用配置** ####

还有一个优化的点是如何在nacos中配置项目的公用配置呢？

nacos提供了shared-configs可以引入公用配置。

在content-api中配置了swagger，所有的接口工程 都需要配置swagger，这里就可以将swagger的配置定义为一个公用配置，哪个项目用引入即可。

单独在xuecheng-plus-common分组下创建xuecheng-plus的公用配置，进入nacos的开发环境，添加swagger-dev.yaml公用配置

![bf716afd55263e3bd09b9f18eaa8c9d7.png][]

删除接口工程中对swagger的配置。

项目使用shared-configs可以引入公用配置。在接口工程的本地配置文件 中引入公用配置，如下：

<table> 
 <thead> 
 <tr> 
 <th>YAMLspring: application: name: content-api cloud: nacos: server-addr: 192.168.101.65:8848 discovery: namespace: dev group: xuecheng-plus-project config: namespace: dev group: xuecheng-plus-project file-extension: yaml refresh-enabled: true extension-configs: - data-id: content-service- s p r i n g . p r o f i l e s . a c t i v e . y a m l g r o u p : x u e c h e n g − p l u s − p r o j e c t r e f r e s h : t r u e s h a r e d − c o n f i g s : − d a t a − i d : s w a g g e r − {spring.profiles.active}.yaml group: xuecheng-plus-project refresh: true shared-configs: - data-id: swagger- spring.profiles.active.yamlgroup:xuecheng−plus−projectrefresh:trueshared−configs:−data−id:swagger−{spring.profiles.active}.yaml group: xuecheng-plus-common refresh: true - data-id: logging-${spring.profiles.active}.yaml group: xuecheng-plus-common refresh: true profiles: active: dev</th> 
 </tr> 
 </thead> 
</table>

再以相同 的方法配置日志的公用配置。

![22b9d9232f1576aedab162efefd8615f.png][]

在接口工程和业务工程，引入loggin-dev.yaml公用配置文件

![d8d3e488798f0c15eda389a4c2739bf2.png][]

配置完成，重启content-api接口工程，访问http://localhost:63040/content/swagger-ui.html 查看swagger接口文档是否可以正常访问，查看控制台log4j2日志输出是否正常。

#### **2.2.4 系统管理配置** ####

按照上边的方法 自行将系统管理服务的配置信息在nacos上进行配置。

#### **2.2.5 配置优先级** ####

到目前为止已将所有微服务的配置统一在nacos进行配置，用到的配置文件有本地的配置文件 bootstrap.yaml和nacos上的配置文件，引入配置文件的形式有：

1、通过dataid方式引入

2、以扩展配置文件方式引入

3、以共享配置文件 方式引入

下边测试这几种配置文件方式的优先级。

我们使用内容管理服务中的配置文件，首先在共享配置文件 swagger-dev.yaml中配置四个配置项，如下：

![c90389fa08ec132b3c5e09e5f0b8e48e.png][]

配置完成发布。

下边在content-api工程的启动类中添加如下代码读取这四个配置项的值

<table> 
 <thead> 
 <tr> 
 <th>Javapackage com.xuecheng; import com.spring4all.swagger.EnableSwagger2Doc; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Bean; @EnableSwagger2Doc @SpringBootApplication public class ContentApplication { @Value(“ t e s t c o n f i g . a " ) S t r i n g a ; @ V a l u e ( " {test_config.a}") String a; @Value(" testconfig.a")Stringa;@Value("{test_config.b}”) String b; @Value(“ t e s t c o n f i g . c " ) S t r i n g c ; @ V a l u e ( " {test_config.c}") String c; @Value(" testconfig.c")Stringc;@Value("{test_config.d}”) String d; @Bean public Integer getTest(){ System.out.println(“a=”+a); System.out.println(“b=”+b); System.out.println(“c=”+c); System.out.println(“d=”+d); return new Integer(1); } public static void main(String[] args) { SpringApplication.run(ContentApplication.class, args); } }</th> 
 </tr> 
 </thead> 
</table>

启动content-api工程，在return new Integer(1);处打断点，运行到断点处，如下：

![487fe618f712a1d7ac170248d4f4572c.png][]

这说明已经成功读取到 四个配置项的值。

下边在content-api工程的扩展配置文件 conent-service-dev.yaml中配置三个配置项，如下：

![6c7f5e566cea796383f7038a2657f9dd.png][]

再次重启content-api工程，在return new Integer(1);处打断点，运行到断点处，如下：

![43bf1878d240f22ac813dadfd919688c.png][]

从结果可以看出，扩展配置文件比共享配置文件优先级高。

下边继续content-api-dev.yaml中配置两个配置项，如下：

![ddebb3139b563e64b0ea5fc55de1f37e.png][]

再次重启内容管理接口工程，在return new Integer(1);处打断点，运行到断点处，如下：

![a6595a972bf3ed28e1028b3e1570e55a.png][]

从结果可以看出，通过工程的应用名找到配置文件 content-api-dev.yaml优先级比扩展配置文件 高。

下边我们在content-api工程的本地配置文件bootstrap.yaml中配置如下：

<table> 
 <thead> 
 <tr> 
 <th>YAMLtest_config: a: 4a b: 4b c: 4c d: 4d</th> 
 </tr> 
 </thead> 
</table>

再次重启内容管理接口工程，在return new Integer(1);处打断点，运行到断点处，如下：

![646c9827a60a43328312d7b8966c5674.png][]

这说明本地配置文件配置的内容没有起作用，原因是nacos配置文件中的相同的配置项覆盖了本地的配置项。

到这可以总结各各配置文件 的优先级：项目应用名配置文件 > 扩展配置文件 > 共享配置文件 > 本地配置文件。

有时候我们在测试程序时直接在本地加一个配置进行测试，这时我们想让本地最优先，可以在nacos配置文件 中配置如下即可实现：

<table> 
 <thead> 
 <tr> 
 <th>YAML#配置本地优先 spring: cloud: config: override-none: true</th> 
 </tr> 
 </thead> 
</table>

再次重启content-api工程，在return new Integer(1);处打断点，运行到断点处，如下：

![890ea321944d325ab4bdbd8f7ad51555.png][]

可以看出此时本地配置最优先。

#### **2.2.6 导入配置文件** ####

课程资料中提供了系统用的所有配置文件nacos\_config\_export.zip，下边将nacos\_config\_export.zip导入nacos。

进入具体的命名空间，点击“导入配置”

![1cc02c199fbad541e7d0d6e3dfa8d5cc.png][]

打开导入窗口

![1f39f1dea30b8183a637167c219df3a7.png][]

相同的配置选择覆盖配置。

点击“上传文件”选择nacos\_config\_export.zip开始导入。

[http_192.168.101.65_8848_nacos]: http://192.168.101.65:8848/nacos/
[50803c68ba01f50b61caf308b8e1ca7c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/fd4d525b32fb488790b88b7d38d1e817.png
[62b3c7bd841d3b36abd51240d946fba2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/0e09958ab7084db0983a045a22b4526c.png
[3e584d23cf8e6a843debf9dc0b55590f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/f291b75e23b74105a739e35a0370349b.png
[bce6d6eb43bb4968cc0e212f19f75ee7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/5e3053e10cfe4c088c4e5ad7902b6e62.png
[407eebe23d5ca7f120d6b36e6452b89d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/af7174dc1a474728acb5e419977f264a.png
[86d0b58408d553cd65843bf52dde1101.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/b4b2515bc5574f57905fcb1ffd55925b.png
[cd30199fccb1c63bbcaa59598f8404e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/fabdaf9717de48ecbccc535095318025.png
[cb8a871ae4d444d513c4fc0956db47f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/c99152cb33fd49d6a36fcd0147ea593f.png
[1bf3d1cbca2247378db17152c8e18599.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/738c204a633d4bda904ebc382d5fa30b.png
[76bb0327895f0e59919ec912b09aabd6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/224ae66c71464f4abb55dd3bfde1017f.png
[fdfc97ae370d5f485c8111ddf0e29dab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/c6de00cc7bdb4403b2e95a586f64d7f6.png
[bf716afd55263e3bd09b9f18eaa8c9d7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/5859649ed5fa4665a020f6eee06d16ea.png
[22b9d9232f1576aedab162efefd8615f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/dbb5bc6da267481686d179ea3814b982.png
[d8d3e488798f0c15eda389a4c2739bf2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/d8325fe3a84940f7ace84fb249886b62.png
[c90389fa08ec132b3c5e09e5f0b8e48e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/ade72944298e41ab81762094b3e5a989.png
[487fe618f712a1d7ac170248d4f4572c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/fbfac38ff6a14549b1f4123f539cbe51.png
[6c7f5e566cea796383f7038a2657f9dd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/5d5b074f5e2b468a869e48455e144ea8.png
[43bf1878d240f22ac813dadfd919688c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/a7f9b7bd95a04fd7a34bfca90d592764.png
[ddebb3139b563e64b0ea5fc55de1f37e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/903a00ee13334d9686b432ec31f78478.png
[a6595a972bf3ed28e1028b3e1570e55a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/730343e3d8f34b22a91975d0e09c566c.png
[646c9827a60a43328312d7b8966c5674.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/761edc33c1694cd488b38db88ab04ab6.png
[890ea321944d325ab4bdbd8f7ad51555.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/4831538bd51a4d5990ecb6d8c89b6105.png
[1cc02c199fbad541e7d0d6e3dfa8d5cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/215b55c09fbe4e3092fc630cb00f0932.png
[1f39f1dea30b8183a637167c219df3a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/82a2367218b24750a6235f904a5c882e.png