SpringBoot 整合 Nacos 实现统一配置中心
作者:mmseoamin日期:2023-12-20

目录

1. Nacos 功能

1.1 配置中心

2. SpringBoot 整合 Nacos 实现统一配置中心

2.1 Nacos 的部署安装

2.1.1 安装并启动 Nacos

2.1.2 开启Nacos控制台授权登录

2.1.3 将 Nacos 的数据源切换为 MySQL

2.2 实现配置中心

2.2.1 创建配置信息

2.2.2 SringBoot 使用配置中心


1. Nacos 功能

  • 配置中心
  • 注册中心

    1.1 配置中心

            在实际开发中,我没有测试组,开发组,运维组,我们希望的是大家使用的是一套配置。而配置中心就是一种集中化管理配置的服务,它还可以将配置云端化。

    它的作用有以下几点:

    1. 集中管理配置信息:将不同的服务的配置信息集中统一管理;

    2. 动态更新配置:配置中心可以通过操作页面或 API 进行动态更新,无需重启服务就可以更新配置信息;

    3. 配置信息共享:不同的服务实例可以共享一套配置信息;

    4. 配置信息安全:提供了安全管理、权限控制;

    5. 信息追溯:支持版本管理和对比、查看历史记录等高级功能。

    2. SpringBoot 整合 Nacos 实现统一配置中心

    2.1 Nacos 的部署安装

    Nacos 有三种部署方式:

    1. 单机模式:(单机测试使用)
    2. 集群模式:多个节点共享同一个数据源
    3. 多集群模式:多个集群共享同一个数据源(高可用性)

    此处演示单机模式的部署和安装:

    2.1.1 安装并启动 Nacos

    ① 准备环境

    Nacos 的安装和运行需要依赖 JDK 环境(JDK 8+),最好是使用 JDK 17。

    ② 安装 Nacos

    ”编译压缩包安装“

    1. 下载压缩包:从 https://github.com/alibaba/nacos/releases 下载最新编译后的压缩包;
    2. 解压压缩包:tar -xvf nacos-server-$version.tar.gz

    Nacos 安装注意事项:

    1. 不要将 Nacos 安装在系统盘;

    2. 安装包不能出现在中文路径下。

    ③ 启动 Nacos

    1. CMD 进入 Nacos 运行目录:cd nacos/bin

    SpringBoot 整合 Nacos 实现统一配置中心,第1张

    2. 启动 Nacos 服务:

    • Linux:sh startup.sh -m starndalone 启动 Nacos 单机模式;
    • Windows:startup.cmd -m standalone 启动 Nacos 单机模式。

      Nacos 启动遇到问题怎么解决:

      1. 是否是权限问题;

      2. 本地 JDK 是否有,并且大于JDK 8(使用 cmd 命令:java -version 查看)。如果不会安装和配置 JDK 17,或者配置环境出现问题的,可以根据这篇博客来搞:
      https://blog.csdn.net/HeyVIrBbox/article/details/125635535

      3. 是否使用单机模式 "-m standalone"。

      启动之后,如果出现下图字样,并且没有任何报错信息,才算启动成功:

      SpringBoot 整合 Nacos 实现统一配置中心,第2张

       启动成功后,就可以拿着链接 http://10.43.97.143:8848/nacos/index.html 去访问 Nacos 的控制台了。

      在没有修改配置之前,访问会出现:"当前集群没有开启鉴权". 所以我们需要开启 Nacos 的权限:

      2.1.2 开启Nacos控制台授权登录

      ① 找到 Nacos 的配置文件,使用 VSCode 打开

      SpringBoot 整合 Nacos 实现统一配置中心,第3张

      ② 修改以下几处配置

      nacos.core.auth.enabled=true
      nacos.core.auth.plugin.nacos.token.secret.key=SecretKey012345678901234567890123456789012345678901234567890123456789
      nacos.core.auth.server.identity.key=nacos
      nacos.core.auth.server.identity.value=nacos

      ③ 重启Nacos服务

      多按几次 Ctrl  C 停止服务,再使用启动命令开启服务。

      ④ 再次访问 Nacos 控制台,输入用户名密码:nacos,nacos

      就能看到这样的界面了:

      SpringBoot 整合 Nacos 实现统一配置中心,第4张

      配置管理是用来实现配置中心,服务管理是用来实现注册中心,权限控制用于管理用户的权限的。

      【思考】

      当我们在权限控制里边新建一个用户后,再重启 Nacos 服务,数据会丢失吗 ?

      SpringBoot 整合 Nacos 实现统一配置中心,第5张

      答案是不会丢失的,因为 Nacos 的数据默认是存储在内置的嵌入式数据库 Derby 中的,但是 Derby 不适合承载生产环境大规模部署,因为它有以下限制:

      • 存储存储容量最大只要 2GB;
      • 不支持集群模式下数据的高可用复制;
      • 性能和并发能力有限

        因此我们需要将数据源切换为 MySQL。

        2.1.3 将 Nacos 的数据源切换为 MySQL

        具体步骤:

        1. 数据库版本要求:5.6.5+;

        2. 初始化 MySQL 数据库,数据库初始化文件如下:

        drop DATABASE if EXISTS nacos;
        CREATE DATABASE nacos CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
        use nacos;
        /******************************************/
        /*   表名称 = config_info                  */
        /******************************************/
        CREATE TABLE `config_info` (
          `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
          `data_id` varchar(255) NOT NULL COMMENT 'data_id',
          `group_id` varchar(128) DEFAULT NULL COMMENT 'group_id',
          `content` longtext NOT NULL COMMENT 'content',
          `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
          `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
          `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
          `src_user` text COMMENT 'source user',
          `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
          `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
          `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
          `c_desc` varchar(256) DEFAULT NULL COMMENT 'configuration description',
          `c_use` varchar(64) DEFAULT NULL COMMENT 'configuration usage',
          `effect` varchar(64) DEFAULT NULL COMMENT '配置生效的描述',
          `type` varchar(64) DEFAULT NULL COMMENT '配置的类型',
          `c_schema` text COMMENT '配置的模式',
          `encrypted_data_key` text NOT NULL COMMENT '密钥',
          PRIMARY KEY (`id`),
          UNIQUE KEY `uk_configinfo_datagrouptenant` (`data_id`,`group_id`,`tenant_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info';
        /******************************************/
        /*   表名称 = config_info_aggr             */
        /******************************************/
        CREATE TABLE `config_info_aggr` (
          `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
          `data_id` varchar(255) NOT NULL COMMENT 'data_id',
          `group_id` varchar(128) NOT NULL COMMENT 'group_id',
          `datum_id` varchar(255) NOT NULL COMMENT 'datum_id',
          `content` longtext NOT NULL COMMENT '内容',
          `gmt_modified` datetime NOT NULL COMMENT '修改时间',
          `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
          `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
          PRIMARY KEY (`id`),
          UNIQUE KEY `uk_configinfoaggr_datagrouptenantdatum` (`data_id`,`group_id`,`tenant_id`,`datum_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='增加租户字段';
        /******************************************/
        /*   表名称 = config_info_beta             */
        /******************************************/
        CREATE TABLE `config_info_beta` (
          `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
          `data_id` varchar(255) NOT NULL COMMENT 'data_id',
          `group_id` varchar(128) NOT NULL COMMENT 'group_id',
          `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
          `content` longtext NOT NULL COMMENT 'content',
          `beta_ips` varchar(1024) DEFAULT NULL COMMENT 'betaIps',
          `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
          `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
          `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
          `src_user` text COMMENT 'source user',
          `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
          `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
          `encrypted_data_key` text NOT NULL COMMENT '密钥',
          PRIMARY KEY (`id`),
          UNIQUE KEY `uk_configinfobeta_datagrouptenant` (`data_id`,`group_id`,`tenant_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_beta';
        /******************************************/
        /*   表名称 = config_info_tag              */
        /******************************************/
        CREATE TABLE `config_info_tag` (
          `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
          `data_id` varchar(255) NOT NULL COMMENT 'data_id',
          `group_id` varchar(128) NOT NULL COMMENT 'group_id',
          `tenant_id` varchar(128) DEFAULT '' COMMENT 'tenant_id',
          `tag_id` varchar(128) NOT NULL COMMENT 'tag_id',
          `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
          `content` longtext NOT NULL COMMENT 'content',
          `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
          `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
          `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
          `src_user` text COMMENT 'source user',
          `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
          PRIMARY KEY (`id`),
          UNIQUE KEY `uk_configinfotag_datagrouptenanttag` (`data_id`,`group_id`,`tenant_id`,`tag_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_tag';
        /******************************************/
        /*   表名称 = config_tags_relation         */
        /******************************************/
        CREATE TABLE `config_tags_relation` (
          `id` bigint(20) NOT NULL COMMENT 'id',
          `tag_name` varchar(128) NOT NULL COMMENT 'tag_name',
          `tag_type` varchar(64) DEFAULT NULL COMMENT 'tag_type',
          `data_id` varchar(255) NOT NULL COMMENT 'data_id',
          `group_id` varchar(128) NOT NULL COMMENT 'group_id',
          `tenant_id` varchar(128) DEFAULT '' COMMENT 'tenant_id',
          `nid` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'nid, 自增长标识',
          PRIMARY KEY (`nid`),
          UNIQUE KEY `uk_configtagrelation_configidtag` (`id`,`tag_name`,`tag_type`),
          KEY `idx_tenant_id` (`tenant_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_tag_relation';
        /******************************************/
        /*   表名称 = group_capacity               */
        /******************************************/
        CREATE TABLE `group_capacity` (
          `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',
          `group_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Group ID,空字符表示整个集群',
          `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '配额,0表示使用默认值',
          `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用量',
          `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个配置大小上限,单位为字节,0表示使用默认值',
          `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '聚合子配置最大个数,,0表示使用默认值',
          `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个聚合数据的子配置大小上限,单位为字节,0表示使用默认值',
          `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大变更历史数量',
          `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
          `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
          PRIMARY KEY (`id`),
          UNIQUE KEY `uk_group_id` (`group_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='集群、各Group容量信息表';
        /******************************************/
        /*   表名称 = his_config_info              */
        /******************************************/
        CREATE TABLE `his_config_info` (
          `id` bigint(20) unsigned NOT NULL COMMENT 'id',
          `nid` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'nid, 自增标识',
          `data_id` varchar(255) NOT NULL COMMENT 'data_id',
          `group_id` varchar(128) NOT NULL COMMENT 'group_id',
          `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
          `content` longtext NOT NULL COMMENT 'content',
          `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
          `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
          `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
          `src_user` text COMMENT 'source user',
          `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
          `op_type` char(10) DEFAULT NULL COMMENT 'operation type',
          `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
          `encrypted_data_key` text NOT NULL COMMENT '密钥',
          PRIMARY KEY (`nid`),
          KEY `idx_gmt_create` (`gmt_create`),
          KEY `idx_gmt_modified` (`gmt_modified`),
          KEY `idx_did` (`data_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='多租户改造';
        /******************************************/
        /*   表名称 = tenant_capacity              */
        /******************************************/
        CREATE TABLE `tenant_capacity` (
          `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',
          `tenant_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Tenant ID',
          `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '配额,0表示使用默认值',
          `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用量',
          `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个配置大小上限,单位为字节,0表示使用默认值',
          `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '聚合子配置最大个数',
          `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个聚合数据的子配置大小上限,单位为字节,0表示使用默认值',
          `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大变更历史数量',
          `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
          `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
          PRIMARY KEY (`id`),
          UNIQUE KEY `uk_tenant_id` (`tenant_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='租户容量信息表';
        CREATE TABLE `tenant_info` (
          `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
          `kp` varchar(128) NOT NULL COMMENT 'kp',
          `tenant_id` varchar(128) default '' COMMENT 'tenant_id',
          `tenant_name` varchar(128) default '' COMMENT 'tenant_name',
          `tenant_desc` varchar(256) DEFAULT NULL COMMENT 'tenant_desc',
          `create_source` varchar(32) DEFAULT NULL COMMENT 'create_source',
          `gmt_create` bigint(20) NOT NULL COMMENT '创建时间',
          `gmt_modified` bigint(20) NOT NULL COMMENT '修改时间',
          PRIMARY KEY (`id`),
          UNIQUE KEY `uk_tenant_info_kptenantid` (`kp`,`tenant_id`),
          KEY `idx_tenant_id` (`tenant_id`)
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='tenant_info';
        CREATE TABLE `users` (
        	`username` varchar(50) NOT NULL PRIMARY KEY COMMENT 'username',
        	`password` varchar(500) NOT NULL COMMENT 'password',
        	`enabled` boolean NOT NULL COMMENT 'enabled'
        );
        CREATE TABLE `roles` (
        	`username` varchar(50) NOT NULL COMMENT 'username',
        	`role` varchar(50) NOT NULL COMMENT 'role',
        	UNIQUE INDEX `idx_user_role` (`username` ASC, `role` ASC) USING BTREE
        );
        CREATE TABLE `permissions` (
            `role` varchar(50) NOT NULL COMMENT 'role',
            `resource` varchar(255) NOT NULL COMMENT 'resource',
            `action` varchar(8) NOT NULL COMMENT 'action',
            UNIQUE INDEX `uk_role_permission` (`role`,`resource`,`action`) USING BTREE
        );
        INSERT INTO users (username, password, enabled) VALUES ('nacos', 'a$EuWPZHzz32dJN7jexM34MOeYirDdFAZm2kuWj7VEOJhhZkDrxfvUu', TRUE);
        INSERT INTO roles (username, role) VALUES ('nacos', 'ROLE_ADMIN');

        3. 修改 Nacos 安装目录下的 conf/application.properties 文件,修改配置如下:

        spring.datasource.platform=mysql
        # 数据分片用的
        db.num=1
        db.url.0=jdbc:mysql://localhost:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
        db.user.0=你mysql的用户名
        db.password.0=你mysql的密码

                此时再重启 Nacos 服务,之前创建的张三就没有了,此时再创建一条记录,在 MySQL 中对应的数据库下的数据表就会出现对应的数据了。

        2.2 实现配置中心

        2.2.1 创建配置信息

        依次点击图中两处地方:

        SpringBoot 整合 Nacos 实现统一配置中心,第6张

        然后创建具体的配置:注意 Data ID 一定要和 SpringBoot 中的配置信息保持一致

        SpringBoot 整合 Nacos 实现统一配置中心,第7张

         例如给配置文件格式设为 properties,然后在配置内容里面设置键值对

        myconfig=www.zhangsan

        2.2.2 SringBoot 使用配置中心

        实现步骤如下:

        1. 在项目中添加 nacos-config 依赖
        2. 在项目配置文件中设置 Nacos 相关信息;
        3. 使用 @Value 注解和 @RefreshScope 实现配置的读取和自动更新。

        ① 创建 SpringBoot 项目

        SpringBoot 整合 Nacos 实现统一配置中心,第8张

        ② 设置 Nacos 依赖

        SpringBoot 整合 Nacos 实现统一配置中心,第9张

        ③ 设置 Nacos 相关信息

        # Nacos帮助文档: https://nacos.io/zh-cn/docs/concepts.html
        # Nacos认证信息
        spring.cloud.nacos.config.username=nacos
        spring.cloud.nacos.config.password=nacos
        spring.cloud.nacos.config.contextPath=/nacos
        # 设置配置中心服务端地址
        spring.cloud.nacos.config.server-addr=localhost:8848
        # Nacos 配置中心的namespace。需要注意,如果使用 public 的 namcespace ,
        # 请不要填写这个值,直接留空即可
        # spring.cloud.nacos.config.namespace=
        #spring.cloud.nacos.config.group=
        # 将 DataID 设置到 nacos: 协议后面
        spring.config.import=nacos:nacos-config-example

        此处的 nacos-config-example 就是创建配置信息中的 Data ID。

        ④ 读取配置信息

        @RestController
        @RefreshScope  // 动态更新配置信息
        public class TestController {
            @Value("${myconfig}")
            private String myconfig;  // 懒加载
            @RequestMapping("/getconfig")
            public String getMyConfig() {
                return myconfig;
            }
        }
        

                最后启动项目,使用 8080 端口访问 controller,就打印前边在配置中心所配置的信息了,并且当我们去配置中心修改对应的配置后,刷新浏览器,可以进行动态的更新。

        SpringBoot 整合 Nacos 实现统一配置中心,第10张