微服务系列:nacos配置中心实战

水深无声 2022-10-22 11:58 389阅读 0赞

### 文章目录 ###

*  前言
 *  一、官方文档
 *  二、nacos环境说明
 *  三、作为配置中心使用
 *   *  1.添加依赖：
     *  2、bootstrap.properties配置
     *  3、在命名空间bank1下添加配置文件
 *  四、效果测试
 *   *  1、项目启动
     *  2、获取配置
     *  3、刷新配置
 *  五、思考
 *  总结

--------------------

# 前言 #

上一篇文章对nacos的功能和安装部署做了些简单介绍，今天介绍下nacos作为配置中心，如何在spring cloud中使用。

--------------------

# 一、官方文档 #

官方文档：[https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html][https_nacos.io_zh-cn_docs_quick-start-spring-cloud.html]

# 二、nacos环境说明 #

安装的nacos版本为NACOS2.0.0-BETA  
没有采用默认的public命名空间。  
新建命名空间bank1，并新建用户nacos\_bank1，新建角色bank1\_admin，在权限管理界面中，给角色bank1\_admin绑定bank1命名空间的读写权限。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 1]

# 三、作为配置中心使用 #

新建spring boot工程bank1，测试Nacos作为配置中心的使用。  
通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-config 实现配置的动态变更。

## 1.添加依赖： ##

<dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        <version>${latest.version}</version>
    </dependency>

注意：版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。

更多版本对应关系参考：[版本说明 Wiki][Wiki]

spring-cloud-starter-alibaba-nacos-config和spring boot的版本对应关系，我更推荐直接通过maven仓库查看，更加直接明了。  
在[maven仓库官网][maven]搜索spring-cloud-starter-alibaba-nacos-config。  
这里我选择了下载次数最多的版本2.2.1.RELEASE。然后查看下面的依赖。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 2]  
spring-cloud-starter-alibaba-nacos-config 2.2.1.RELEASE的版本依赖。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 3]  
所以spring-boot-starter-parent版本，我选择了2.2.5.RELEASE。  
完整的依赖为：

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.5.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.laowan</groupId>
        <artifactId>spring-cloud</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>bank1</name>
        <description>实战spring cloud</description>
        <properties>
            <java.version>1.8</java.version>
            <skipTests>true</skipTests>
        </properties>
        <dependencies>
            
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
                <version>2.2.1.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>

注意：这里的版本依赖关系非常重要，不然项目启动会直接出现jar包冲突的异常，导致启动失败。

## 2、bootstrap.properties配置 ##

在 **bootstrap.properties** 中配置 Nacos server 的地址和应用名

spring.application.name=bank1
    server.port=8010
    spring.profiles.active=dev
            
    spring.cloud.nacos.username=nacos_bank1
    spring.cloud.nacos.password=123456
    spring.cloud.nacos.config.server-addr=localhost:8848
    spring.cloud.nacos.config.namespace=a284481e-b623-4c7d-a65a-e9009cba5f57

说明：之所以需要配置 spring.application.name ，是因为它是构成 Nacos 配置管理 dataId字段的一部分。  
**这里的spring.cloud.nacos.config.namespace指定的属性就是对应Nacos 配置管理 中的命名空间bank1的id值：a284481e-b623-4c7d-a65a-e9009cba5f57。**

**注意：**  
这里一定要在bootstrap.properties中配置配置中心的相关属性，而不能直接在application.properties中配置。原因是bootstrap.properties会在application.properties之前加载。具体bootstrap和application的区别自己可以网上找资料查看下。

这里用户命和密码需要配置在bootstrap.properties中才能生效，如果配置在application.properties中，启动时读取不到对应的属性。  
这样因为这里的认证类SecurityProxy中读取的属性是BootstrapPropertySource 。根据名称就知道，这里加载的是Bootstrap中的属性。

spring.cloud.nacos.username
    spring.cloud.nacos.password

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 4]  
![在这里插入图片描述][20210319171233488.png]

## 3、在命名空间bank1下添加配置文件 ##

在 Nacos Spring Cloud 中，dataId 的完整格式如下：

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

**说明：**  
1、prefix 默认为 spring.application.name 的值，也可以通过配置项spring.cloud.nacos.config.prefix来配置。  
2、spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档。 注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成  p r e f i x . \{prefix\}. prefix.\{file-extension\}  
3、file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。**目前只支持 properties 和 yaml 类型。**

选择bank1命名空间，点击加号➕  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 5]

**新建配置文件：**  
其中Data ID为bank1-dev.properties 需要注意Data ID的命名规则。  
Group一般都是采用默认值。  
配置格式采用Properties。个人习惯，不是太喜欢使用YAML，格式比较难调整，格式错误难发现，属性搜索也不是很方便。  
配置内容：bank.name=bank1 dev  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 6]

4、通过@Value使用属性

@RestController
    @RequestMapping("/config")
    public class ConfigController { 
    
        @Value("${bank.name}")
        private String bankName;
    
        @RequestMapping("/get")
        public String get() { 
            return bankName;
        }
    }

5、添加@RefreshScope注解

@Slf4j
    @SpringBootApplication
    @RefreshScope
    public class Bank1Application { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(Bank1Application.class, args);
    		log.info("bank1服务启动成功");
    	}
    }

# 四、效果测试 #

## 1、项目启动 ##

2021-03-19 17:31:29.285  INFO 45872 --- [           main] b.c.PropertySourceBootstrapConfiguration : Located property source: [BootstrapPropertySource {name='bootstrapProperties-bank1-dev.properties,DEFAULT_GROUP'}, BootstrapPropertySource {name='bootstrapProperties-bank1.properties,DEFAULT_GROUP'}, BootstrapPropertySource {name='bootstrapProperties-bank1,DEFAULT_GROUP'}]
    2021-03-19 17:31:29.305  INFO 45872 --- [           main] com.laowan.bank1.Bank1Application        : The following profiles are active: dev

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 7]  
在启动日志中发现，**同时加载了bootstrapProperties-bank1-dev.properties和bootstrapProperties-bank1.properties的文件。**

**注意：**  
bank1.properties会先于bank1-dev.properties被程序加载，后加载的属性会覆盖先加载的属性。所以2个文件中如果有相同的属性，最终bank1-dev.properties中的才会生效。  
利用这个特性，我们一般会存放一些通用的公共属性放在bank1.properties文件中。

**示例：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 8]  
bank1.properties 公共属性  
bank1-dev.properties 开发环境属性  
bank1-test.properties 测试环境属性  
bank1-pro.properties 生产环境属性

## 2、获取配置 ##

请求链接：[http://localhost:8010/config/get][http_localhost_8010_config_get]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 9]  
成功获取到配置。

## 3、刷新配置 ##

在nacos中修改配置：

bank.name=bank1 dev  update

不重启项目，直接重新请求http://localhost:8010/config/get获取配置。发现配置刷新成功。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 10]

# 五、思考 #

**1、多环境如何共用一个nacos服务？**

*  相同命名空间：

简单的使用，只需在相同命名空间下利用Data ID中的spring.profiles.active属性来区分即可。  
缺点主要是访问权限不能放开控制。多个环境的文件在同一个命名空间，容易出现误操作。

*  不同命名空间：  
    可以如下，分别建立名称为dev，test，pro的命名空间。这种情况下，可以忽略spring.profiles.active属性的作用，利用命名空间来区分不同的属性环境。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 11]  
    项目中bootstrap.properties的配置文件对应关系：  
    公共属性配置：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 12]  
    dev属性配置：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 13]  
    **bootstrap-dev.properties的配置说明：**

spring.cloud.nacos.username=nacos-dev（dev环境对应的用户）
    spring.cloud.nacos.password=123456
    spring.cloud.nacos.config.server-addr=localhost:8848（dev对应访问地址）
    spring.cloud.nacos.config.namespace=dev对应命名空间id

**2、多环境下怎么独立使用各自的nacos服务？**  
实际项目中，开发环境，测试环境，生产环境一般都有比较严格的网络隔离和访问权限控制，同时为了避免属性误操作，不可能共用同一个nacos服务。  
可以参考上面不同命名空间的处理：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 13]  
**3、nacos的命名空间是以项目为纬度，还是以开发环境、测试环境等环境为纬度控制好？**  
由于考虑到真实环境下，开发环境，生产环境等不同配置环境一般不会使用同一套nacos服务，往往都是各自独立部署。  
所以同一个项目，利用命名空间来分环境控制配置属性这样的使用场景非常有限，意义不是很大。所以建议命名空间以项目为纬度就可以了。

# 总结 #

本文主要介绍了Nacos作为配置中心在Spring boot项目中的使用。  
主要需要注意一下几点：  
1、spring-cloud-starter-alibaba-nacos-config和Spring boot的版本依赖关系。如果版本对应出错，会出现依赖冲突问题。  
2、注意在Nacos控制台添加配置时，Data ID的命名规则： p r e f i x − \{prefix\}- prefix−\{spring.profiles.active\}.$\{file-extension\}  
3、Nacos的权限管理的粒度是命名空间级别。一定要注意配置的用户具有对应命名空间的**读写权限。**  
4、在拓展思考中，说明了多环境下Nacos作为配置中心的使用方式。

[https_nacos.io_zh-cn_docs_quick-start-spring-cloud.html]: https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70]: /images/20221022/626015a80dc847508f6f2f5881e77be9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 1]: /images/20221022/458df676643343f4853aa4969eaa915d.png
[Wiki]: https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E
[maven]: https://mvnrepository.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 2]: /images/20221022/ff2e82b07ea947b2bc29975c6b16984d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 3]: /images/20221022/7b44a585719c45ea98f07a541036add8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 4]: /images/20221022/f5485bbd53e0497e8ec44c7e281a5ffe.png
[20210319171233488.png]: /images/20221022/da0645ae46af471c8b17240511bf6c0a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 5]: /images/20221022/8c9870dd687a4ac7ae81e0b1684a57ca.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 6]: /images/20221022/c9624d8a62ff4d3aba5c99addead6fab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 7]: /images/20221022/0e7758af31564256babe1d0a8d9b5731.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 8]: /images/20221022/3ffd3dd47ac04cc592225fe539be5094.png
[http_localhost_8010_config_get]: http://localhost:8010/config/get
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 9]: /images/20221022/2c5b449867c14702a7c1a2b680142eb2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 10]: /images/20221022/4c177595c0ed484299373c1ee68fe30b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 11]: /images/20221022/292d569172b94cb7bb35475e9e1b1061.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 12]: /images/20221022/f22b74fc41bd4512bbb885d3809bee06.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3cxMDE0MDc0Nzk0_size_16_color_FFFFFF_t_70 13]: /images/20221022/16cf8e4c5c6b420ba8a220c6a8411547.png