【微服务】4、NACOS 配置管理

这篇具有很好参考价值的文章主要介绍了【微服务】4、NACOS 配置管理。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

一、Nacos 和 Eureka 异同

🎼 服务注册到 Nacos 时，可以选择注册为临时实例或非临时实例
🎼 临时实例宕机时，会从 Nacos 的服务列表中剔除；非临时实例宕机不会从服务列表中剔除
🎼 注册到 Nacos 中的服务默认是非临时实例（除非设置 ephemeral 属性为 false）
nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

同:
📔 都支持服务注册和服务拉取
📔 都支持服务提供者心跳方式做健康检测

异:
📖 Nacos 支持服务端主动检测提供者状态：临时实例采用心跳模式，非临时实例采用主动检测模式
📖 临时实例心跳不正常会被剔除，非临时实例则不会被剔除（只是标记该实例挂了而已）
📖 Nacos 支持服务列表变更的消息推送模式，服务列表更新更及时（Eureka 只能是定时拉取服务列表信息）
📖 Nacos 集群默认采用 AP 方式，当集群中存在非临时实例时采用 CP 模式；Eureka 采用 AP 方式

如何设置为非临时实例：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务地址
      discovery:
        ephemeral: false # 非临时实例

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

二、Nacos 配置管理

✏️ Nacos 的统一配置管理可实现配置更改的热更新（更新之后自动起效果，无法重启服务）

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

项目启动后会执行的操作（关于配置文件）：
nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

(1) 引入 Nacos 配置管理客户端依赖

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

(2) 在服务的 resource 目录下添加 bootstrap.yml 文件（该文件是引导文件，优先级高于 application.yml）

spring:
  application:
    name: userservice
  profiles:
    active: dev # 当前环境（dev 是开发环境的意思）
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos 服务的地址
      config:
        file-extension: yaml # 文件后缀名（yaml 或 properties）

三、Nacos 配置管理 —— 热更新

📝 Nacos 中的配置文件变更后，微服务无需重启就可以感知
📝 实现热更新还需要有一些配置（两种）

✏️① 在 @Value 注入的变量所在类上添加 @RefreshScope 注解

@RestController
@RequestMapping("/users")
@RefreshScope // Nacos 配置管理热更新（设置了该注解才会热更新）
public class UserController {

    @Value("${pattern.dateformat}")
    private String dateFormat;

    @GetMapping("/getCurTime")
    public String getCurTime() {
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
        return sdf.format(new Date());
    }
}

✏️② 使用 @ConfigurationProperties 注解进行配置文件属性读取的使用默认就是热更新

@Component
@Data
@ConfigurationProperties(prefix = "pattern") // 默认就是热更新
public class PatternProperties {

    private String dateformat;

}

@RestController
@RequestMapping("/tests")
public class TestController {

    @Resource
    private PatternProperties patternProperties;

    @GetMapping("/getCurTime")
    public String getCurTime() {
        SimpleDateFormat sdf = new SimpleDateFormat(patternProperties.getDateformat());
        return sdf.format(new Date());
    }

}

四、多环境配置共享

🎺 把无论是生产环境还是开发环境都相同的参数配置到 Nacos 中
🎺 无论是何种环境这些配置都是一样的（只需配置一次）

微服务启动时会从 Nacos 读取多个配置文件：

🎄① [spring.application.name]-[spring.profiles.active].yaml（如 userservice-dev.yaml）

🎄② [spring.application.name].yaml（如 userservice.yaml）

无论 profile 如何变化，[spring.application.name].yaml 配置文件一定会加载。所以，多环境共享的配置可写入到该文件中

配置文件优先级:
服务名-profile.yaml > 服务名.yaml > 本地配置

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

五、Nacos 集群搭建

☘️ 在生产环境中，Nacos 一定要集群搭建

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

☘️ Nginx 把请求分发到不同的 Nacos 节点

搭建集群 Nacos 步骤：
☘️ ① 搭建数据库，初始化数据库表结构
☘️ ② 下载 Nacos 安装包
☘️ ③ 配置 Nacos
☘️ ④ 启动 Nacos 集群
☘️ ⑤ Nginx 反向代理

(1) 搭建数据库

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 COMMENT '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_configinfobeta_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 (`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) 下载 Nacos 安装包

https://github.com/alibaba/nacos/tags

(3) 配置 Nacos

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

☘️ 进入 nacos 的 conf 目录，修改配置文件 cluster.conf.example（重命名为 cluster.conf）
☘️ 配置 nacos 集群的每个 nacos 结点的 IP 地址和端口号
nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

#it is ip
#example
127.0.0.1:8887
127.0.0.1:8886
127.0.0.1:8885

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

☘️ 修改 nacos 目录下的 conf 目录下的 applicatioin.properties 文件（添加数据库配置）

### If use MySQL as datasource:
spring.datasource.platform=mysql

### Count of DB:
db.num=1

### Connect URL of DB:
db.url.0=jdbc:mysql://127.0.0.1:3306/naocs_crowd?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=root
db.password.0=root

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

☘️ 将 nacos 文件夹复制多份后分别修改它们的 config 目录下的 application.properties 文件夹中的 server.port 为不同的端口号

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

(4) 启动 Nacos 集群

☘️ 分别启动三个 nacos 结点

startup.cmd

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

(5) Nginx 反向代理

☘️ 通过 Nginx 做反向代理和负载均衡

nacos指定ip,SpringCloud 相关,微服务,java,spring cloud

☘️ 修改 nginx.conf 文件的内容如下：

upstream nacos-cluster {
    server 127.0.0.1:8887;
	server 127.0.0.1:8886;
	server 127.0.0.1:8885;
}

server {
    listen       888;
    server_name  localhost;

    location /nacos {
        proxy_pass http://nacos-cluster;
    }
}

☘️ 启动 nginx 服务
nacos指定ip,SpringCloud 相关,微服务,java,spring cloud