SpringCloud(若依微服务版)读取Nacos中的配置以及多个服务共享Nacos配置的使用

怼烎@ 2022-11-16 04:55 1117阅读 0赞

# 场景 #

若依微服务版手把手教你本地搭建环境并运行前后端项目：

[https://blog.csdn.net/BADAO\_LIUMANG\_QIZHI/article/details/109363303][https_blog.csdn.net_BADAO_LIUMANG_QIZHI_article_details_109363303]

在上面介绍了使用SpringCloud(若依微服务版)搭建项目的基础上，在业务开发中需要将某些配置

存放在配置文件中，比如上传文件的地址、第三方接口的地址端口等。然后在使用的地方动态配置。这样在配置需要进行

修改时就只需要修改配置文件即可。就不需要修改代码了。

注：

博客：  
[https://blog.csdn.net/badao\_liumang\_qizhi][https_blog.csdn.net_badao_liumang_qizhi]  
关注公众号  
霸道的程序猿  
获取编程相关电子书、教程推送与免费下载。

# 实现 #

那么如果使用了Nacos作为配置中心，又是怎样获取Nacos中的配置文件的内容那。

首先在需要用到动态配置的服务下所对应的Nacos中的配置文件中，添加配置，比如这里需要在system这个服务下添加动态配置。

找到Nacos中对应的配置文件，将需要添加的配置在后面追加上

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70][]

然后在对应的服务下面的包路径下新建config目录，在config目录下新建读取配置文件的配置类

import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.context.annotation.Configuration;
    
    
    /**
     * 读取服务器上传文件磁盘路径
     * @author badao
     */
    @Configuration
    @RefreshScope
    @ConfigurationProperties(prefix = "file")
    public class FilePathProperties {
        /**
         * 传文件磁盘路径
         */
        private String path;
    
        public String getPath()
        {
            return path;
        }
    
        public void setPath(String path)
        {
            this.path = path;
        }
    }

注意这里的prefix前缀，上面的配置文件是从file开头写的，file下面对应的是path节点。

所以这里的配置类的前缀和属性也要对应。

然后重启Nacos和服务，就可以在此对应的服务下面，首先引入

@Autowired
        private FilePathProperties filePathProperties;

然后通过

filePathProperties.getPath()

去获取动态配置了

那么问题又来了，如果这是在SpringBoot单个服务的系统中这样使用，就可以在任何需要用到配置

的地方动态配置引用。

但是如果要是在微服务架构下，在多个服务下都需要动态配置这个路径的话，岂不是需要在每个服务下面

都要配置一遍。

那么可以通过Maven依赖的方式在一个公共的子模块中读取配置文件，然后在运行和打包时会将此公共模块下的子模块添加到各个服务下面，然后再在每个服务的配置文件中设置共享配置文件，那么就可以在一个共享配置文件中配置一次，然后在每个服务下都能读取了。

## Nacos共享配置实现 ##

首先Nacos是支持共享配置文件的，具体可以参照其官方文档

[https://spring-cloud-alibaba-group.github.io/github-pages/greenwich/spring-cloud-alibaba.html\#\_more\_information\_about\_nacos\_config\_starter\_configurations][https_spring-cloud-alibaba-group.github.io_github-pages_greenwich_spring-cloud-alibaba.html_more_information_about_nacos_config_starter_configurations]

搜索shared-dataids

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1][]

官方文档原文描述

To share the data id among multiple applications in a clearer manner, you can also use the following method:

spring.cloud.nacos.config.shared-dataids=bootstrap-common.properties,all-common.properties
    spring.cloud.nacos.config.refreshable-dataids=bootstrap-common.properties

We can see that:

*  Multiple shared data ids can be configured using `spring.cloud.nacos.config.shared-dataids` , and the data ids are separted by commas.
 *  `spring.cloud.nacos.config.refreshable-dataids` is used to control which data ids will be refreshed dynamically when configurations are updated, and that the latest configuration values can be retrieved by applications. Data ids are separated with commas. If not specified, all shared data ids will not be dynamically refreshed.

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>When using&nbsp;<code>spring.cloud.nacos.config.shared-dataids</code>&nbsp;to configure multiple shared data ids, we agree on the following priority between the shared configurations: Priorities are decided based on the order in which the configurations appear. The one that occurs later is higher in priority than the one that appears first.</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>When using&nbsp;<code>spring.cloud.nacos.config.shared-dataids</code>, the data Id must have a file extension, and it could be properties or yaml/yml. And the configuration in&nbsp;<code>spring.cloud.nacos.config.file-extension</code>&nbsp;does not have any impact on the customized Data Id file extension.</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;"> <p>&nbsp;</p> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>When&nbsp;<code>spring.cloud.nacos.config.refreshable-dataids</code>&nbsp;specifies the data ids that support dynamic refresh, the corresponding values of the data ids should also specify file extensions.</p> </td> 
  </tr> 
 </tbody> 
</table>

我们打开system服务下的resource下的bootstrap.yml,这里的配置文件默认是加了共享文件配置的

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 2][]

只不过这里的配置文件的完整名是使用的上面的变量

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 3][]

所以在system服务下配置的共享文件就是application-dev.yml

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 4][]

所以我们在application-dev.yml中添加配置内容，配置IM服务器地址

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 5][]

若依微服务的架构将ruoyi-common下的ruoyi-common-core会作为每个服务下的子模块，所以在此子模块添加读取配置文件的配置类

在运行或打包时就会将此配置类添加到每个服务下。然后在每个服务下的bootstrap.yml中都添加了共享配置的配置，就都能获取到

该配置内容了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 6][]

在common下新建配置类，添加注解来读取配置文件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 7][]

注意这里使用的是@Component注解，然后在此公共模块下配置好了之后，在需要用到此配置的服务下的启动类上

添加注解来定义扫描路径

@ComponentScan(basePackages = {"com.ruoyi"})

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 8][]

因为上面的那个common-core中的配置类中直接使用了配置文件中获取到的配置，所以在各个服务下都能使用这个工具类

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 9][]

[https_blog.csdn.net_BADAO_LIUMANG_QIZHI_article_details_109363303]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/109363303
[https_blog.csdn.net_badao_liumang_qizhi]: https://blog.csdn.net/badao_liumang_qizhi
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70]: /images/20221022/f5532b62035a4e1f9ae2c536e8a0eb54.png
[https_spring-cloud-alibaba-group.github.io_github-pages_greenwich_spring-cloud-alibaba.html_more_information_about_nacos_config_starter_configurations]: https://spring-cloud-alibaba-group.github.io/github-pages/greenwich/spring-cloud-alibaba.html#_more_information_about_nacos_config_starter_configurations
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1]: /images/20221022/4b958ee235d343738b25df70b93b4b16.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 2]: /images/20221022/1e58a7582e2944fea14bd6723bb4b860.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 3]: /images/20221022/9c1032a20f314649ae291b37166a9b4f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 4]: /images/20221022/f98310d65f1f49d6a531c8f77002efe6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 5]: /images/20221022/f879012e6b2843c3bcfd6e1722b25d86.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 6]: /images/20221022/2dceeedf0b9b40b0935a6384946d8bc1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 7]: /images/20221022/21837071c0274c8bae582985ef0ce537.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 8]: /images/20221022/8bcd5920adf743c1a068265726b9cbfa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 9]: /images/20221022/b5e9e7e1f37b43cd9932678612dbb855.png