SpringBoot+Nacos实现配置中心

た入场券 2023-03-06 03:37 19阅读 0赞

### 为什么需要配置中心 ###

不知道你是否遇到过以下情况：

*  同一个项目有多套配置，分布在不同的配置文件中，需要修改时，要改多个文件，有时候会遗漏配置
 *  某天突然需要修改线上的一个配置，只能修改、提交，重启服务
 *  项目外包时，一些秘钥配置不想提供给第三方

这些问题都可以引入配置中心来解决

### 配置中心一般提供什么功能 ###

*  统一管理不同环境、不同集群的配置
 *  配置修改实时生效（热发布）
 *  版本管理，每次配置的修改都会有版本记录，可随时回滚
 *  权限管理。配置中心可交给专人来管理，做到配置的权限管理

这些都是配置中心提供的最基础的功能，基本上已经可以满足日常开发中的需求了

### Nacos ###

Nacos 是阿里巴巴的新开源项目，其核心定位是 “一个更易于帮助构建云原生应用的动态服务发现、配置和服务管理平台”。

Nacos 的关键特性包括:

*  服务发现和服务健康监测
 *  动态配置服务
 *  动态 DNS 服务
 *  服务及其元数据管理

使用 Nacos 简化服务发现、配置管理、服务治理及管理的解决方案，让微服务管理、共享、组合更加容易

本文主要介绍Nacos实现的动态配置服务，也就是配置中心的实现

### Nacos实现配置中心 ###

在使用配置中心之前，我们一般这样实现配置：

1、在配置文件增加配置（application.yml）

datasource:
      url: localhost:3306
      username: root
      password: root

2、使用@Value来引用配置

@RestController
    public class NacosTest { 
    
        @Value("${datasource.url}")
        private String url;
    
        @Value("${datasource.username}")
        private String username;
    
        @Value("${datasource.password}")
        private String password;
    
        @RequestMapping("/getMessage")
        public String getMessage(){ 
            System.out.println(url);
            System.out.println(username);
            System.out.println(password);
            return "url:" + url + "</br>username:" + username + "</br>password:" + password;
        }
    }

启动服务，访问 http://localhost8080/getMessage 返回信息

url:localhost:3306
    username:root
    password:root

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

以上是使用配置中心之前的模式，把配置都放到配置文件中，Java代码通过@Value去拿配置或者通过@PropertySource来进行配置

下面我们来看一下使用配置中心之后，是怎样一种配置方式

1、安装nacos  
nacos的安装其实非常简单，从官网下载包，解压、运行就好了（我使用的是windows版，可直接启动），其他版本可参考官网来启动运行，启动后如下图所示

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70]

访问：http://localhost:8848/nacos/index.html

用户名: nacos 密码：nacos

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70 1]

2、新建配置项

nacos里面是通过命名空间来区分配置，首先我们建一个命名空间

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70 2]

注意：命令空间ID是非必填的，如果没有填，系统会自动生成一个，这个ID将用于读取配置

命名空间建好之后，就可以新增配置项了

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70 3]

这里的Data ID和Group这两个配置很关键，会影响到你项目中的读取

3、开始写代码了

依赖

compile'org.springframework.boot:spring-boot-starter-web:2.0.9.RELEASE'
        compile 'org.springframework.boot:spring-boot-starter-test:2.0.9.RELEASE'
        compile 'org.springframework.boot:spring-boot-configuration-processor:2.0.9.RELEASE'
        compile 'org.springframework.cloud:spring-cloud-alibaba-nacos-config:0.2.2.RELEASE'

新建配置bootstrap.yml文件

spring:
      application:
        name: nacos-demo
      cloud:
        nacos:
          config:
            server-addr: localhost:8848
            namespace: eb0658a2-abdf-4dfb-81d4-63cdee8feb23
            group: group-test
            file-extension: yml
            refresh-enabled: true
            prefix: test

为什么要新建bootstrap.yml配置文件，而不是直接在原来的application.yml中新增配置呢？是因为要实现nacos配置中心里面的配置要优先于系统配置文件中的配置，假如两个地方同时配置了，会优先取nacos的配置

配置说明：

*  spring.application.name 配置应用的名称，用于获取配置
 *  spring.cloud.nacos.config.server-addr 配置nacos服务的地址
 *  spring.cloud.nacos.config.namespace 配置命名空间（填入前面新建的命名空间ID）
 *  spring.cloud.nacos.config.group 配置分组
 *  spring.cloud.nacos.config.file-extension 配置文件后缀，用于拼接配置配置文件名称
 *  spring.cloud.nacos.config.refresh-enabled 配置自动刷新
 *  spring.cloud.nacos.config.prefix 配置文件的前缀

这里需要说明一下配置文件的拼接规则，也就是nacos会根据配置怎么找到对应的配置文件？

prefix−{ spring.profile.active}.${ file-extension}

说明：

*  prefix表示配置文件前缀，默认是spring.application.name的值，如果配置了spring.cloud.nacos.config.prefix就取prefix的值
 *  spring.profile.active 表示项目使用的profile.active配置，没有则配置文件中没有此段名称
 *  file-extension 表示配置文件的后缀，目前只支持yml和properties

所以如上配置得到的配置文件名称为：test.yml，也就是说你的nacos对应的命名空间下必须要有一个dataId为test.yml的配置，才能被读取到，要不然就无法读到配置

配置好了之后，写段代码测试一下

@RestController
    public class NacosTest { 
    
        @Value("${datasource.url}")
        private String url;
    
        @Value("${datasource.username}")
        private String username;
    
        @Value("${datasource.password}")
        private String password;
    
        @RequestMapping("/getMessage")
        public String getMessage(){ 
            return "url:" + url + "</br>username:" + username + "</br>password:" + password;
        }
    }

启动项目，访问 http://localhost8080/getMessage 返回信息

url:nacos-server:3306
    username:nacos-root
    password:nacos-root

说明已经读到nacos中的配置了，而且本地配置文件和nacos中同时配置的，取的是nacos中的配置

### 配置自动刷新 ###

在配置的类增加@RefreshScope就可以实现自动刷新配置，当nacos中的配置修改后，项目无需重启就可以自动生效，这个在实际生产环境中是很有用的，有时候你需要修改线上的配置，如果没有配置中心，你需要重启服务

### 最后 ###

至此就完成了一个简单的配置中心

配置中心一般用于管理复杂的配置，比如在分布式项目中的配置管理

虽然配置中心可以简化配置，但如果是很小的项目就没有必要把配置单独出来，其实就放在项目中还方便一些

总之，不要因为技术而技术，引入一项新的技术必然是为了解决某个痛点和问题，不要因为别人用你也用，到头来凭空给自己制造麻烦

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70_pic_center_pic_center_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70]: /images/20230208/90dd70e7218e410ba2295e61b6b50cc0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70 1]: /images/20230208/ed9837d5215c446cad97817b6a485fbd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70 2]: /images/20230208/fbe870bd8485417399e30c3cdf295d6d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70 3]: /images/20230208/3306288929384bb9a6015959f1c6495f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B6anRpYW4_size_16_color_FFFFFF_t_70_pic_center_pic_center_pic_center]: /images/20230208/fbd90ae5683f48299d06f1688ab78578.png