阅读 263

14. SpringCloud Alibaba Nacos服务注册和配置中心


项目地址: https://github.com/coderTomato/mscloud_H

1. Nacos简介

1.1 为什么叫Nacos?

前四个字母分别为Naming和Configuration的前两个字母,最后的s为Service

1.2 是什么

一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台
Nacos就是注册中心+配置中心的组合

1.3 能干嘛

替代Eureka作服务注册中心
替代Config做服务配置中心

1.4 去哪下

https://github.com/alibaba/Nacos

1.5 各注册中心比较

2. 安装并运行Nacos

本地Java8+Maven环境已经OK
先从官网下载Nacos
解压安装包,直接运行bin目录下的startup.cmd
mac 下执行 sh startup.sh -m standalone
命令运行成功后直接访问http://localhost:8848/nacos 用户名密码都是nacos

3. Nacos作为服务注册中心演示

3.1 官方文档 https://spring-cloud-alibaba-group.github.io/github-pages/greenwich/spring-cloud-alibaba.html

3.2 基于Nacos的服务提供者

新建模块cloudalibaba-provider-payment9001
pom文件

<dependencies>
    <!-- nacos-discovery-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <!-- 引入自己定义的api通用包-->
    <dependency>
        <groupId>com.jd.springcloud</groupId>
        <artifactId>cloud-api-commons</artifactId>
        <version>${project.version}</version>
    </dependency>
    <!-- boot web actuator-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <!-- devtools-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
复制代码

yml文件

server:
  port: 9001

spring:
  application:
    name: nacos-payment-provider
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

management:
  endpoints:
    web:
      exposure:
        include: '*'
复制代码

主启动类

@EnableDiscoveryClient
@SpringBootApplication
public class PaymentMain9001 {
    public static void main(String[] args) {
        SpringApplication.run(PaymentMain9001.class, args);
    }
}
复制代码

业务类

@RestController
public class PaymentController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/payment/nacos/{id}")
    public String getPayment(@PathVariable("id") Integer id){
        return "nacos registry, serverPort:"+serverPort+"\t id"+id;
    }
}
复制代码

3.3 测试

  • 启动nacos注册中心
  • 再启动工程 cloudalibaba-provider-payment9001
  • 访问 http://localhost:9001/payment/nacos/1
  • 在nacos注册中心查看

    说明nacos服务注册中心+服务提供者9001都OK了

3.4 基于9001新建9002 演示nacos负载均衡

3.5 基于Nacos的服务消费者

新建模块 cloudalibaba-consumer-nacos-order83

pom文件

<dependencies>
    <!-- nacos-discovery-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <!-- 引入自己定义的api通用包-->
    <dependency>
        <groupId>com.jd.springcloud</groupId>
        <artifactId>cloud-api-commons</artifactId>
        <version>${project.version}</version>
    </dependency>
    <!-- boot web actuator-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <!-- devtools-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
复制代码

yml文件

server:
  port: 83


spring:
  application:
    name: nacos-order-consumer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

#消费者将要访问的微服务名称(注册进nacos的微服务提供者)
service-url:
  nacos-user-service: http://nacos-payment-provider
复制代码

主启动类

@EnableDiscoveryClient
@SpringBootApplication
public class OrderNacosMain83 {

    public static void main(String[] args) {
        SpringApplication.run(OrderNacosMain83.class, args);
    }
}
复制代码

业务类

package com.jd.springcloud.alibaba.config;

import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class ApplicationContextConfig {

    @Bean
    @LoadBalanced
    public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }
}
复制代码

controller

@RestController
public class OrderNacosController {

    @Value("${service-url.nacos-user-service}")
    private String serverURL;

    @Resource
    private RestTemplate restTemplate;

    @GetMapping("/consumer/payment/nacos/{id}")
    public String paymentInfo(@PathVariable("id") Long id){
        return restTemplate.getForObject(serverURL+"/payment/nacos/"+id,String.class);
    }
}
复制代码

测试
启动nacos控制台
再启动9001/9002
最后启动consumer83

服务者消费者都注册进了nacos

访问 http://localhost:83/consumer/payment/nacos/13

3.6 服务注册中心对比

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'
复制代码

4. Nacos作为服务配置中心演示

4.1 Nacos作为配置中心-基础配置

4.1.1 新建模块 cloudalibaba-config-nacos-client3377

pom文件

<dependencies>
    <!-- nacos-config-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
    <!-- nacos-discovery-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <!-- 引入自己定义的api通用包-->
    <dependency>
        <groupId>com.jd.springcloud</groupId>
        <artifactId>cloud-api-commons</artifactId>
        <version>${project.version}</version>
    </dependency>
    <!-- boot web actuator-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <!-- devtools-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
复制代码

yml文件

bootstrap.yml

server:
  port: 3377

spring:
  application:
    name: nacos-config-client

  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置
复制代码

application.yml

spring:
  profiles:
    active: dev #表示开发环境
复制代码

主启动类

@SpringBootApplication
@EnableDiscoveryClient
public class NacosConfigClientMain3377 {

    public static void main(String[] args) {
        SpringApplication.run(NacosConfigClientMain3377.class, args);
    }
}
复制代码

业务类
ConfigClientController

@RestController
@RefreshScope //支持Nacos的动态刷新功能
public class ConfigClientController {

    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/config/info")
    public String getConfigInfo(){
        return configInfo;
    }
}
复制代码

在Nacos中添加配置信息

(1)Nacos中的匹配规则理论
Nacos中的dataid的组成格式及与SpringBoot配置文件中的匹配规则

官网
https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html


(2)Nacos中的匹配规则实操

(2.1)配置新增


(2.2)Nacos界面的配置对应

设置DataId小总结:

公式 ${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
prefix默认为spring.application.name的值
spring.profile.active 即为当前环境对应的profile,可以通过配置项spring.profile.active来配置。
file-exetension为配置内容的数据格式,可通过配置项spring.cloud.nacos.config.file-extension来配置
复制代码

小总结说明:


(2.3) 历史配置

Nacos会记录配置文件的历史版本默认保留30天,此外还有一键回滚功能

4.1.2 测试

启动前需要在nacos客户端-配置管理-配置管理栏目下有对应的yaml配置文件


运行cloud-config-nacos-client3377的主启动类

调用接口查看配置信息
http://localhost:3377/config/info

4.1.3 自带动态刷新

修改下Nacos中的yaml配置文件,再次调用查看配置的接口,就会发现配置已经刷新

4.2 Nacos作为配置中心-分类配置

4.2.1 多环境多项目管理

问题1
实际开发中,通常一个系统会准备dev开发环境、test测试环境、prod生产环境
如何保证指定环境启动时服务能正确读取到Nacos上相应环境的配置文件呢?

问题2
一个大型分布式微服务系统会有很多微服务子项目,每个微服务项目又都会有相应的开发环境、测试环境、预发环境、正式环境….
那怎么对这些微服务配置进行管理呢

4.2.2 Nacos的图形化管理界面
4.2.3 Namespace+Group+DataID 三者关系?为什么这么设计

是什么

类似Java里面的package名和类名
最外层的namespace是可以用于区分部署环境的,Group和DataID逻辑上区分两个目标对象

默认情况
Namespace=public, Group=DEFAULT_GROUP, 默认Cluster是DEFAULT
Nacos默认的命名空间是public、Namespace主要用来实现隔离
比方说我们现在有三个环境: 开发、测试、生产环境,我们就可以创建三个Namespace, 不同的Namespace之间是隔离的

Group默认是DEFAULT_GROUP, Group可以把不同的微服务划分到同一个分组里去
service就是微服务;一个Service可以包含多个Cluster(集群), Nacos默认Cluster是DEFAULT, Cluster是对指定微服务的一个虚拟划分。
比方说为了容灾,将Service微服务分别部署在了杭州机房和广州机房,这时就可以给杭州机房的Service微服务起一个集群名称HZ, 给广州机房的Service微服务起一个集群名称(GZ), 还可以尽量让同一个机房的微服务互相调用,以提升性能
最后是instance,就是微服务的实例

4.2.4 三种方案加载配置
4.2.4.1 DataID方案

指定spring.profile.active和配置文件的DataID来使不同环境下读取不同的配置
默认空间+默认分组+新建dev和test两个DataID


通过spring.profile.active属性就能进行多环境下配置文件的读取

测试

访问 http://localhost:3377/config/info

4.2.4.2 Group方案

通过Group实现环境区分 ->新建Group


在nacos图形界面控制台上面新建配置文件DataID


bootstrap+application配置如下
在config下增加一条group的配置即可。可配置为DEV_GROUP或TEST_GROUP

4.2.4.3 Namespace 方案

新建dev/test的Namespace


回到服务管理-服务列表查看


按照域名配置填写

YML文件

bootstrap.yml

cloud:
  nacos:
    discovery:
      server-addr: localhost:8848 #Nacos服务注册中心地址
    config:
      server-addr: localhost:8848 #Nacos作为配置中心地址
      file-extension: yaml #指定yaml格式的配置
      group: DEV_GROUP
      namespace: ff0dcf7d-06d4-47cd-a1eb-0feb8a396cec
复制代码

application.yml

spring:
  profiles:
    #active: info
    active: dev #表示开发环境
复制代码

5. Nacos集群和持久化配置

5.1 官网说明

https://nacos.io/zh-cn/docs/cluster-mode-quick-start.html
默认Nacos使用嵌入式数据库实现数据的存储。所以如果启动多个默认配置下的Nacos节点,数据存储是存在一致性问题的。为了解决这个问题,Nacos采用了集中式存储的方式来支持集群化部署,目前只支持MySQL的存储。

Nacos支持三种部署模式

  • 单机模式-用于测试和单机试用
  • 集群模式-用于生产环境,确保高可用
  • 多集群模式-用于多数据中心场景

https://nacos.io/zh-cn/docs/deployment.html

5.2 Nacos持久化配置解释

5.2.1 Nacos默认自带的是嵌入式数据库derby

https://github.com/alibaba/nacos/blob/develop/config/pom.xml

5.2.2 derby到mysql切换配置步骤
  • nacos-server-1.1.4/nacos/conf目录下找到nacos-mysql.sql脚本,执行
  • nacos-server-1.1.4/nacos/conf目录下找到application.properties文件,增加支持mysql数据源配置(目前只支持mysql),添加mysql数据源的url、用户名和密码。
spring.datasource.platform=mysql

db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=root
复制代码
5.2.3 启动Nacos,可以看到是全新的空记录界面,以前是记录进derby

5.3 Linux版Nacos+MySQL生产环境配置

预计需要,1个Nginx+3个nacos注册中心+1个mysql

5.3.1 Nacos下载Linux版本

官网 https://nacos.io/zh-cn/docs/cluster-mode-quick-start.html


下载地址: https://github.com/alibaba/nacos/releases/download/1.1.4/nacos-server-1.1.4.tar.gz

5.3.2 集群配置步骤

1.Linux服务器上mysql数据库配置
进入nacos解压目录
将nacos/conf目录下nacos-mysql.sql脚本内容拷贝然后到自己linux机器上的mysql数据库粘贴

2.application.properties配置

先备份一份

[robin@node02 conf]

[robin@node02 module] vi nacos/conf/application.properties


3.Linux服务器上nacos的集群配置cluster.conf

先备份出来

[robin@node02 conf]

[robin@node02 conf] vim cluster.conf

#it is ip
192.168.56.103:3333
192.168.56.103:4444
192.168.56.103:5555
这个IP不能写127.0.0.1,必须是Linux命令hostname -i 能够识别的IP
复制代码

4.编辑Nacos的启动脚本startup.sh,使它能够接受不同的启动端口

执行方式


5.Nginx的配置,由它作为负载均衡器

修改nginx的配置文件nginx.conf

[root@node02 conf]# vi /usr/local/nginx/conf/nginx.conf


启动nginx

[root@node02 sbin]# ./nginx -c /usr/local/nginx/conf/nginx.conf

6.截止到此,1个Nginx+3个nacos注册中心+1个mysql

启动nacos集群


查看是否启动成功

新建一个配置测试

linux服务器的mysql插入一条记录


测试通过nginx访问nacos

http://192.168.56.103:1111/nacos/#/login

5.3.3 测试

微服务cloudalibaba-provider-payment9002启动注册进nacos集群

yml文件

spring:
  application:
    namenacos-payment-provider
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.56.103:1111 #换成nginx的1111端口 做集群
复制代码

结果 成功注册进nacos集群