SpringBoot使用Nacos配置中心

Posted 戈博小刀

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot使用Nacos配置中心相关的知识，希望对你有一定的参考价值。

注意：

1.配置文件格式设置为properties无法发布，js报错，可以设置为text格式
2.springboot项目的配置文件不能为application，要为bootstrap

还有项目发布必须先启动nacos，配置dataid，如果nacos比子系统后启动，再去配dataid等信息，动态刷新永远无法生效，这个也是比较坑的点

 

转：

 参考：

SpringBoot使用Nacos作为配置中心服务和服务注册中心

 

主要：

Nacos（四）：SpringCloud项目中接入Nacos作为配置中心

 

前言

通过前两篇文章：

相信大家已经对Nacos作为注册中心的基本使用已经有了一定的了解。

然而，Nacos远远不止于此，本文我们来看一下Nacos作为配置中心在SpringCloud中的使用

我的环境

  • Windows10
  • JDK8
  • SpringCloud：Finchley.RELEASE
  • SpringBoot：2.0.4.RELEASE
  • spring-cloud-alibaba-dependencies：0.2.2.RELEASE
  • Nacos-server：1.0.1

本文的项目Demo继续沿用之前文章中的聚合工程Nacos,若小伙伴还没有之前的环境，可至源码地址中下载

启动Nacos-Server

进入bin文件夹（目录：nacos-server-1.0.1 acosin），直接双击执行startup.cmd文件，这里具体的启动细节就不再说明

新建配置

在Nacos-Server中新建配置，其中Data ID它的定义规则是：${prefix}-${spring.profile.active}.${file-extension}

  • prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix 来配置。
  • spring.profile.active 即为当前环境对应的 profile，可以通过配置项 spring.profile.active 来配置。
  • file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

注意：当 spring.profile.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}

这里我创建Data Id 为nacos-config.yml的配置文件，其中Group为默认的DEFAULT_GROUP，配置文件的格式也相应的选择yaml，其内添加配置nacos.config=hello_nacos，如图所示

技术图片

创建应用

1、在聚合工程Nacos下新建Module，创建一个名为nacos-config的子工程，其pom.xml文件内容如下

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <parent>
  6. <artifactId>Nacos</artifactId>
  7. <groupId>com.study.www</groupId>
  8. <version>0.0.1-SNAPSHOT</version>
  9. </parent>
  10. <groupId>com.larscheng.www</groupId>
  11. <artifactId>nacos-config</artifactId>
  12. <version>0.0.1-SNAPSHOT</version>
  13. <name>nacos-config</name>
  14. <description>Demo project for Spring Boot</description>
  16. <properties>
  17. <java.version>1.8</java.version>
  18. </properties>
  20. <dependencies>
  21. <dependency>
  22. <groupId>org.springframework.cloud</groupId>
  23. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  24. </dependency>
  25. <dependency>
  26. <groupId>org.springframework.cloud</groupId>
  27. <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
  28. </dependency>
  29. </dependencies>
  31. <build>
  32. <plugins>
  33. <plugin>
  34. <groupId>org.springframework.boot</groupId>
  35. <artifactId>spring-boot-maven-plugin</artifactId>
  36. </plugin>
  37. </plugins>
  38. </build>
  40. </project>

2、创建配置文件名为bootstrap.yml,注意是bootstrap.xxx，而不是application或者其他。原因如下

Nacos同springcloud-config一样，在项目初始化时，要保证先从配置中心进行配置拉取，拉取配置之后，才能保证项目的正常启动。springboot中配置文件的加载是存在优先级顺序的，bootstrap优先级高于application

这里的配置文件类型可以根据个人习惯选择，我这里用的时yml类型，配置内容如下

  1.  
  2. spring:
  3. application:
  4. name: nacos-config
  5. cloud:
  6. nacos:
  7. discovery:
  8. server-addr: 127.0.0.1:8848
  9. config:
  10. server-addr: 127.0.0.1:8848
  11. file-extension: yml

可以看到必须可少的配置项spring.application.name

spring.cloud.nacos.discovery.server-addr指定注册中心的地址，如果你不需要注册该服务，也可以去掉该项，并删除discovery依赖

spring.cloud.nacos.config.server-addr指定配置中心的地址

file-extension指定配置中心中配置文件的格式

上面的配置是为了保证服务的正常注册和配置获取，以及配置DataID的正确性

3、创建对外接口来从nacos中读取配置，NacosConfigApplication.java修改如下

  1. @SpringBootApplication
  2. @EnableDiscoveryClient
  3. @RestController
  4. @RefreshScope
  5. public class NacosConfigApplication {
  7. public static void main(String[] args) {
  8. SpringApplication.run(NacosConfigApplication.class, args);
  9. }
  11. @Value("${nacos.config}")
  12. private String config;
  14. @RequestMapping("/getValue")
  15. public String getValue() {
  16. return config;
  17. }
  18. }

其中通过@Value注解，去读取key为nacosconfig的配置的值，并通过/getValue接口返回。

加入@RefreshScope注解，可以使当前类下的配置支持动态更新。

到此代码部分的工作已经完成

启动测试

  1. 保证Nacos-Server已经启动
  2. 检查配置文件是否已经添加
  3. 启动nacos-config项目

启动成功后在Nacos控制台中可以看到我们注册的服务

技术图片

此时调用接口进行测试 http://127.0.0.1:8080/getValue ，可以看到返回结果

hello_nacos

此时说明已经成功读取到配置，下面我将Nacos-Server上的配置修改为hello_lars,看看能否动态更新

技术图片

调用接口进行测试 http://127.0.0.1:8080/getValue ，返回结果如下

hello_lars

可以看到我通过Nacos-server的控制台进行配置的修改，客户端服务nacos-config也相应的进行热更新。

总结

通过上面的测试，可见Nacos做配置中心，在SpringCloud项目中，也可以做到无缝衔接，切换到Nacos可以说知识修改配置的问题，成本也很低

项目的其他配置不变，只需要指定配置中心地址，同时将配置文件外部管理。

本文源码：https://github.com/larscheng/larscheng-learning-demo/tree/master/Nacos

参考

Nacos Spring Cloud

以上是关于SpringBoot使用Nacos配置中心的主要内容，如果未能解决你的问题，请参考以下文章

nacos使用-服务注册中心和配置中心

在SpringBoot项目中快速搭建一个Nacos配置中心，再也不用修改配置文件上传了

SpringBoot开发案例Nacos配置管理中心

SpringBoot整合Nacos注册中心

微服务架构SpringBoot+SpringCloud+VUE三 || 服务注册与配置中心Nacos

Docker下Nacos配置应用开发