开发者

Nacos配置管理实践(手把手教你搭建Nacos集群)

目录
  • Nacos配置管理
    • 统一配置管理
    • 配置热更新
    • 多环境配置共享
    • 搭建Nacos集群
      • 1.集群结构图
      • 2.搭建集群
  • 总结

    Nacos配置管理

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    统一配置管理

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    以上把某些配置放到了nacos中,那微服务应该如何从nacos中获取配置呢?

    • 去哪读取?–bootstrap.yml
    • 读取谁?-读nacos地址

    注意:与nacos地址和nacos配置文件有关的内容均放在bootstrap.yml中

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    操作如下:

    1.在服务(这里选userservice)的pom文件中引入Nacos的配置管理客户端依赖:

    <!--nacos配置管理依赖-->
    <dependency>
    	<groupId>com.alibaba.cloud</groupId>   
    	<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
    

    2.在服务(这里选userservice)中的resource目录添加一个bootstrap.yml文件,这个文件是引导文件,优先级高于application.yml:

    spring:
      application:
        name: userservice
      profiles:
        active: dev #环境
      cloud:
        nacos:
          server-addr: localhost:8848 #nacos地址
          config:
            file-extension: yaml # 后缀名
            namespace: 995033ad-3d70-485d-9c55-9e60a4815ea9 #命名空间id
    
    

    添加到bootstrap.yml中(先创建bootstrap.yml),然后可以将application.yml中与bootstrap.yaml中相同的项删除

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    新建一个接口测试,看是否能读取到

    @RestController
    @RequestMapping("/user")
    public class UserController {
    
        //读nacos中的配置字段,若dateformat有值,则代表读去nacos配置成功
        @Value("${pattern.dateformat}")//读配置文件中的字段,到dateformat
        private String dateformat;
    
        @GetMapping("now")
        public String now(){
            return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
        }
    }
    

    访问 http://localhost:8081/user/now http://localhost:8082/user/now 结果如下

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    表示已经读取到nacos配置,因为只有nacos中配置了pattern.dateformat 字段,其他没有配置

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    配置热更新

    配置热更新:配置文件更新后,不用重启服务,即可将更新后的配置文件应用到服务上去

    • @RefreshScope

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    推荐用方法二

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    @RestController
    @RequestMapping("/user")
    //@RefreshScope //nacos配置更新后 自动更新到代码 ////方法一
    public class UserController {
    
        @Autowired
        private UserService userService;
    
        ////方法一
        //读nacos中的配置字段,若dateformat有值,则代表读去nacos配置成功
    //    @Value("${pattern.dateformat}")//读配置文件中的字段,到dateformat
    //    private String dateformat;
    
        @Autowired
        private PatternProperties properties;////方法二
    
        @GetMapping("now")
        public String now(){
            ////方法一
            return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
            ////方法二
            return LocalDateTime.now().format(DateTimeFormatter.ofPattern(properties.getDateformat()));
        }
    
     
    }
    
    
    ////方法二 在config包下新建这样一个类,将其注入spring容器中
    @Data
    @Component //把PatternProperties类注册成spring的一个bean,这样就可以被任意使用
    @ConfigurationProperties(prefix = "pattern") //指定配置文件中以"pattern"开头的属性
    public class PatternProperties {
        private String dateformat;
    }
    
    

    小结

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    多环境配置共享

    微服务配置共享

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    dev和test环境都能拿到nacos中userservice.yaml中的值,而test环境拿不到dev环境的特有的值,当然dev也拿不到test的值(但这里test里面没http://www.devze.com设置)

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    问题一:nacos中userservice.yaml 与 userservice-dev.yaml中假如有相同的配置项,则以哪个为准呢?(哪个优先级高)

    问题二:本地,nacos远程 都有相同的配置,以哪个为准呢?

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    用案例回答上述答案,配上一个相同的案例

    在本地yaml中加入配置 pattern.name = 本地环境local,并把name放入配置类中

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    重启服务,显示本地环境local,因为此时只有本地有这个配置

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    接下来我们在远程端加入该配置

    在userservice.yaml加入该配置项

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    刷新网页(无需重启服务),显示的是userservice.yaml中的配置,而不显示本地的配置

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    再在userservice-dev.yaml写入配置

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    刷新网页(无需重启服务),显示的是userservice-dev.yaml中的配置,而不显示本地的配置,也不显示userservice.yaml中的配置

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    总结

    • 配置优先级:服务名-profile.yaml(userservice-dev.yaml) > 服务名.yaml(userservice.yaml) > 本地配置

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    小结

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    搭建Nacos集群

    1.集群结构图

    官方给出的Nacos集群图:

    • SLB:负载均衡器

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    其中包含3个nacos节点,然后一个负载均衡器代理3个Nacos。这里负载均衡器可以使用nginx。

    • 我们计划的集群结构:

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    三个nacos节点的地址:

    节点ipport
    nacos110.0.4.948845
    nacos210.0.4.948846
    nacos310.0.4.948847

    2.搭建集群

    搭建集群的基本步骤:

    • 搭建数据库,初始化数据库表结构 (nacos官方提供)
    • 下载nacos安装包
    • 配置nacos
    • 启动nacos集群
    • nginx反向代理
    2.1.初始化数据库

    Nacos默认数据存储在内嵌数据库Derby中,不属于生产可用的数据库。

    官方推荐的最佳实践是使用带有主从的高可用数据库集群,主从模式的高可用数据库可以参考传智教育的后续高手课程。

    这里我们以单点的数据库为例来讲解。

    • 首先新建一个数据库,命名为nacos,而后导入下面的SQL:
    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(255) DEFAULT NULL,
      `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 COMMEN编程客栈T 'source user',
      `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
      `app_name` varchar(128) DEFAULT NULL,
      `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
      `c_desc` varchar(256) DEFAULT NULL,
      `c_use` varchar(64) DEFAULT NULL,
      `effect` varchar(64) DEFAULT NULL,
      `type` varchar(64) DEFAULT NULL,
      `c_schema` text,
      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';
    
    /******************************************/
    /*   数据库全名 = nacos_config   */
    /*   表名称 = 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(255) 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,
      `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='增加租户字段';
    
    
    /******************************************/
    /*   数据库全名 = nacos_config   */
    /*   表名称 = 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 '租户字段',
      PRIMARY KEY (`id`),
      UNIQUE KEY `uk_configinfohttp://www.devze.combeta_datagrouptenant` (`data_id`,`group_id`,`tenant_id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_beta';
    
    /******************************************/
    /*   数据库全名 = nacos_config   */
    /*   表名称 = 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';
    
    /******************************************/
    /*   数据库全名 = nacos_config   */
    /*   表名称 = 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,
      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';
    
    /******************************************/
    /*   数据库全名 = nacos_config   */
    /*   表名称 = 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容量信息表';
    
    /******************************************/
    /*   数据库全名 = nacos_config   */
    /*   表名称 = his_config_info   */
    /******************************************/
    CREATE TABLE `his_config_info` (
      `id` bigint(64) unsigned NOT NULL,
      `nid` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
      `data_id` varchar(255) NOT NULL,
      `group_id` varchar(128) NOT NULL,
      `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
      `content` longtext NOT NULL,
      `md5` varchar(32) DEFAULT NULL,
      `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
      `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
      `src_user` text,
      `src_ip` varchar(50) DEFAULT NULL,
      `op_type` char(10) DEFAULT NULL,
      `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
      PRIMARY KEY android(`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='多租户改造';
    
    
    /******************************************/
    /*   数据库全名 = nacos_config   */
    /*   表名称 = 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,
    	`password` varchar(500) NOT NULL,
    	`enabled` boolean NOT NULL
    );
    
    CREATE TABLE `roles` (
    	`username` varchar(50) NOT NULL,
    	`role` varchar(50) NOT NULL,
    	UNIQUE INDEX `idx_user_role` (`username` ASC, `role` ASC) USING BTREE
    );
    
    CREATE TABLE `permissions` (
        `role` varchar(50) NOT NULL,
        `resource` varchar(255) NOT NULL,
        `action` varchar(8) NOT NULL,
        UNIQUE INDEX `uk_role_permission` (`role`,`resource`,`action`) USING BTREE
    );
    
    INSERT INTO users (username, password, enabled) VALUES ('nacos', '$2a$10$EuwpZHzz32dJN7jexM34MOeYirDdFAZm2kuWj7VEOJhhZkDrxfvUu', TRUE);
    
    INSERT INTO roles (username, role) VALUES ('nacos', 'ROLE_ADMIN');
    
    2.2.下载nacos

    nacos在github上有下载地址:https://github.com/alibaba/nacos/tags,可以选择任意版本下载。

    本例中才用1.4.1版本:

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    2.3.配置Nacos

    将这个包解压到任意非中文目录下,如图:

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    目录说明:

    • bin:启动脚本
    • conf:配置文件

    进入nacos的conf目录,修改配置文件cluster.conf.example,重命名为cluster.conf:

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    然后添加内容:

    127.0.0.1:8845
    127.0.0.1.8846
    127.0.0.1.8847
    

    然后修改application.properties文件,添加数据库配置

    spring.datasource.platform=mysql
    
    db.num=1
    
    db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
    db.user.0=root
    db.password.0=123456
    
    2.4.启动

    将nacos文件夹复制三份,分别命名为:nacos1、nacos2、nacos3

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    然后分别修改三个文件夹中的application.properties,

    • nacos1:
    server.port=8845
    
    • nacos2:
    server.port=8846
    
    • nacos3:
    server.port=8847
    

    然后分别启动三个nacos节点: 直接启动在终端输入startup.cmd(因为nacos默认启动就是集群启动) 不需要startup.cmd -m standalone

    startup.cmd
    
    2.5.nginx反向代理

    找到课前资料提供的nginx安装包:

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    解压到任意非中文目录下:

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    修改conf/nginx.conf文件,配置如下:

    upstream nacos-cluster {
        server 127.0.0.1:8845;
    	server 127.0.0.1:8846;
    	server 127.0.0.1:8847;
    }
    
    server {
        listen       80;
        server_name  localhost;
    
        location /nacos {
            proxy_pass http://nacos-cluster;
        }
    }
    

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    而后在浏览器访问:http://localhost/nacos即可。

    代码中application.yml文件配置如下:

    spring:
      cloud:
        nacos:
          server-addr: localhost:80 # Nacos地址
    

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    重启服务,进入nacos页面 http://localhost/nacos

    Nacos配置管理实践(手把手教你搭建Nacos集群)

    2.6.优化
    • 实际部署时,需要给做反向代理的nginx服务器设置一个域名,这样后续如果有服务器迁移nacos的客户端也无需更改配置.
    • Nacos的各个节点应该部署到多个不同服务器,做好容灾和隔离

    总结

    以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程客栈(www.devze.com)。

    0

    上一篇:

    下一篇:

    精彩评论

    暂无评论...
    验证码 换一张
    取 消

    最新开发

    开发排行榜