您的位置:首页 > 编程语言 > Java开发

SpringCloud alibaba -- Nacos

2020-07-06 21:37 176 查看

Nacos

  • 配置中心
  • 持久化
  • 总结
  • 介绍

    springcloud的Netflix 公司的组件系列后,由于Netflix 的组件大多数 已经闭源了,所以现在很多公司都开始采用springcloud alibaba来开发,当然也有些大公司采用的自己研发的组件模块;今天我们介绍的是SpringCloud alibaba中比较优秀的一个组件,Nacos

    Nacos 支持基于 DNS 和基于 RPC 的服务发现(可以作为springcloud的注册中心)、动态配置服务(可以做配置中心)、动态 DNS 服务。

    安装

    nacos的安装还是比较简单的,目前我们之介绍windows的安装,Linux的安装,可以参考官方文档

    1. 下载
      我们需要在GitHub上下载nacos下载
    2. 解压
      之后解压打开目录
    3. 启动
      在bin目录中可以看到

      双击即可启动项目,之后打开就可以访问
      http://localhost:8848/nacos/

    注:当然可以修改端口,在config中

    注册中心

    注册中心的使用方法基本上跟eureka差不多的,唯一的方便不需要创建一个微服务单独出来

    实现案例

    创建一个父工程
    pom

    <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.2.RELEASE</version>
    <relativePath/>
    </parent>
    
    <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
    <spring-cloud.version>2.2.0.RELEASE</spring-cloud.version>
    </properties>
    
    <dependencyManagement>
    <dependencies>
    <dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>2.1.0.RELEASE</version>
    <type>pom</type>
    <scope>import</scope>
    </dependency>
    </dependencies>
    </dependencyManagement>
    
    <dependencies>
    <!--lombok-->
    <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    </dependency>
    </dependencies>
    
    <build>
    <plugins>
    <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>
    </plugins>
    </build>
    • 创建服务提供者
      pom
    <dependencies>
    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    </dependencies>

    启动器

    @SpringBootApplication(exclude= {DataSourceAutoConfiguration.class})
    @EnableDiscoveryClient
    public class UserApplication {
    public static void main(String[] args) {
    SpringApplication.run(UserApplication.class, args);
    }
    }

    配置文件

    server:
    port: 8081
    spring:
    application:
    name: user-service # 应用名称
    cloud:
    nacos:
    discovery:
    server-addr: 127.0.0.1:8848

    Controller

    @RestController
    @Slf4j
    public class UserController {
    
    @Autowired
    private UserService userService;
    
    @GetMapping("/user/{id}")
    public User queryById(@PathVariable("id") Long id) {
    return userService.queryById(id);
    }
    }

    service

    @Service
    public class UserService {
    
    public User queryById(Long id) {
    User user = new User();
    user.setId(id);
    user.setAge(24);
    user.setName("ace");
    user.setNote("测试服务调用");
    user.setPassword("123456");
    user.setSex(1);
    user.setUserName("nacos");
    user.setBirthday(new Date());
    user.setCreated(new Date());
    user.setUpdated(new Date());
    return user;
    }
    }

    实体类

    @Data
    public class User {
    private Long id;
    
    private String userName; // 用户名
    
    private String password; // 密码
    
    private String name;// 姓名
    
    private Integer age;// 年龄
    
    private Integer sex;// 性别,1男性,2女性
    
    private Date birthday;// 出生日期
    
    private Date created;// 创建时间
    
    private Date updated;// 更新时间
    
    private String note;// 备注
    }
    • 创建服务消费者
      pom 启动类 配置文件 和服务提供者基本一样

    controller

    @RestController
    @RequestMapping("consumer")
    @Slf4j
    public class ConsumerController {
    
    @Autowired
    private RestTemplate restTemplate;
    @Autowired
    //springcloud中的服务发现
    private DiscoveryClient discoveryClient;
    
    @GetMapping("{id}")
    public User queryById(@PathVariable("id") Long id){
    // 根据服务id(spring.application.name),获取服务实例列表
    List<ServiceInstance> instances = discoveryClient.getInstances("user-service");
    // 取出一个服务实例
    ServiceInstance instance = instances.get(0);
    // 从实例中获取host和port,组成url
    String url = String.format("http://%s:%s/user/%s", instance.getHost(), instance.getPort(), id);
    User user = restTemplate.getForObject(url, User.class);
    return user;
    }
    }
    • 测试
      完成搭建后,启动微服务可以在nacos中,发现注册的微服务信息

      发现可以访问消费者,会成功获取提供者的数据

    总结

    Nacos的AP和CP模式切换
    C是所有节点在同一时间看到的数据是一致的;
    A的定义是所有请求都会收到响应。
    何时选用哪种模式?

    一般来说,如果不需要存储服务级别的信息且服务实例是通过nacos-client注册,并能够保持心跳上报,那么就可以选择AP模式。当前主流的服务如Spring Cloud 和 Dubbo服务,都适用于AP模式,AP模式为了服务的可能性而减弱了一致性,因此AP模式下只支持注册临时实例。

    如果需要在服务级别编辑或者存储配置信息,那么CP是必须的,K8S服务和DNS服务则适用于CP模式。CP模式下支持注册持久化实例,此时则是以Raft协议为集群运行模式,该模式下注册实例之前必须先注册服务,如果服务不存在,则会返回错误。

    curl -X PUT '$NACOS_SERVER:8848/nacos/v1/ns/operator/switches?entry=serverMode&value=CP'

    配置中心

    nacos比起eureka好用的地方就是他即可以成为注册中心,也可以当做配置中心使用,可以将配置文件放在nacos中,服务启动时候获取即可;

    基础配置

    这里为了方便区分,单独在创建了一个微服务来获取nacos的信息

    1. 创建项目
      pom
    <artifactId>nacos-config</artifactId>
    <dependencies>
    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
    <dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    </dependencies>
    1. 创建启动器
    @EnableDiscoveryClient
    @SpringBootApplication
    public class NacosConfigApplication
    {
    public static void main(String[] args) {
    SpringApplication.run(NacosConfigApplication.class, args);
    }
    }
    1. 配置文件
      在这里我们配置两个配置文件,因为nacos同微服务项目一样,在项目初始化的时候,要保证先从配置中心获取配置信息,才能保证项目的正常启动,所以为了能提前获取项目信息,我们需要配置bootstrap文件,因为他在springboot中优先级高于application文件
      bootstrap.yml
    server:
    port: 8088
    
    spring:
    application:
    name: nacos-config-client
    cloud:
    nacos:
    discovery:
    server-addr: localhost:8848 #服务注册中心地址
    config:
    server-addr: localhost:8848 #配置中心地址
    file-extension: yaml #指定yaml格式的配置

    application.yml

    spring:
    profiles:
    active: test

    说明:之所以需要配置 spring.application.name ,是因为它是构成 Nacos 配置管理 dataId字段的一部分。

    在 Nacos Spring Cloud 中,dataId 的完整格式如下:

    ${prefix}-${spring.profile.active}.${file-extension}
    • prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
    • spring.profile.active 即为当前环境对应的 profile,详情可以参考 Spring Boot文档。 注意:当 spring.profile.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成 prefix.{prefix}.prefix.{file-extension}
    • file-exetension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。
    1. 代码获取配置文件
    @RestController
    @RefreshScope //springcloud的注解 用于动态刷新获取配置中心信息
    public class ConfigClientController
    {
    @Value("${config.info}")
    private String configInfo;
    
    @GetMapping("/config/info")
    public String getConfigInfo() {
    return configInfo;
    }
    }
    1. nacos配置中心配置
      新建一个配置

      配置信息

      完成配置以后,点击发布就可以了,之后输入url就可以获取对应的配置信息了

    分类配置

    在完成上述以后,可以了解nacos作为配置中心的功能还是很强大的,但是nacos不仅仅可以这样,还可以分环境配置,

    在我们日常开发中,需要先在开发环境开发,之后在测试环境测试,测试完成后,提交发布到生产环境中,这几个环境中的配置是不一样的,nacos可以将环境分布开

    1. 配置结构
      nacos采用了namespace,group和dataId来将配置文件层级区分开来的,

      会根据其层级包裹来需要对应的层级关系的
    • 微服务会先根据 namespace的配置寻找命名空间(没有配置默认public)
    • 之后在根据组别(group)查找(没有配置默认DEFAULT_GROUP)
    • 之后在根据dataid来查找(如果没有查找对应的配置文件会报错的)
    1. 实现
      这个我们在nacos中配置对应的层级关系,
      创建namespace

      创建group

    之后在配置文件中配置即可
    bootstrap.yml

    server:
    port: 8088
    
    spring:
    application:
    name: nacos-config-client
    cloud:
    nacos:
    discovery:
    server-addr: localhost:8848 #服务注册中心地址
    config:
    server-addr: localhost:8848 #配置中心地址
    file-extension: yaml #指定yaml格式的配置group: TEST_GROUP  #组别
    namespace: 5ae6334f-f851-4b02-9ddb-360ac9589e4b # 命名空间如果生成时候没配置的话,会是一堆字符串
    

    appliaction.yml

    spring:
    profiles:
    active: test

    持久化

    Nacos默认自带的是嵌入式数据库derby,如果先要实现nacos的持久化的话,需要将其修改为mysql配置

    derby到mysql切换配置步骤

    1. nacos-server-1.1.4\nacos\conf目录下找到sql脚本
    2. 执行脚本生成数据表
    CREATE DATABASE nacos_config;
    USE nacos_config;
    
    /*   数据库全名 = nacos_config   */
    /*   表名称 = 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(255) DEFAULT NULL,
    `content` longtext NOT NULL COMMENT 'content',
    `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
    `gmt_create` datetime NOT NULL DEFAULT '2010-05-05 00:00:00' COMMENT '创建时间',
    `gmt_modified` datetime NOT NULL DEFAULT '2010-05-05 00:00:00' COMMENT '修改时间',
    `src_user` text COMMENT 'source user',
    `src_ip` varchar(20) 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 '2010-05-05 00:00:00' COMMENT '创建时间',
    `gmt_modified` datetime NOT NULL DEFAULT '2010-05-05 00:00:00' COMMENT '修改时间',
    `src_user` text COMMENT 'source user',
    `src_ip` varchar(20) 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 '2010-05-05 00:00:00' COMMENT '创建时间',
    `gmt_modified` datetime NOT NULL DEFAULT '2010-05-05 00:00:00' COMMENT '修改时间',
    `src_user` text COMMENT 'source user',
    `src_ip` varchar(20) 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 '2010-05-05 00:00:00' COMMENT '创建时间',
    `gmt_modified` datetime NOT NULL DEFAULT '2010-05-05 00:00:00' 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 '2010-05-05 00:00:00',
    `gmt_modified` datetime NOT NULL DEFAULT '2010-05-05 00:00:00',
    `src_user` text,
    `src_ip` varchar(20) 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 '2010-05-05 00:00:00' COMMENT '创建时间',
    `gmt_modified` datetime NOT NULL DEFAULT '2010-05-05 00:00:00' 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
    );
    
    INSERT INTO users (username, password, enabled) VALUES ('nacos', '$2a$10$EuWPZHzz32dJN7jexM34MOeYirDdFAZm2kuWj7VEOJhhZkDrxfvUu', TRUE);
    
    INSERT INTO roles (username, role) VALUES ('nacos', 'ROLE_ADMIN');
    1. 配置数据库信息
      nacos-server-1.1.4\nacos\conf目录下找到application.properties

      之后将配置文件中的配置数据源修改 即可

    总结

    nacos是阿里开发的一套不错的组件,既可以实现注册中心,也可以实现配置中心,同时提供了多语言的接入操作,在目前这个时候eureka2.0闭源,是个不错的选择,也是springcloud alibaba推荐的体系之一

    内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
    标签: