02. Eureka、Nacos注册中心及负载均衡原理

发布时间:2024年01月08日

01小节中订单服务远程调用用户服务案例实现了跨服务请求,在微服务中一个服务可能是集群部署的,也就是一个服务有多个实例,但是我们在调用服务时需要指定具体的服务实例才能调用该服务,在集群模式下,服务地址应该写哪个,写具体某一个的话,集群模式就没有用了。我们这小节就来解决这个问题。

假如我们的服务提供者user-service部署了多个实例,如图:
在这里插入图片描述

大家思考几个问题:

  • order-service在发起远程调用的时候,该如何得知user-service实例的ip地址和端口?
  • 有多个user-service实例地址,order-service调用时该如何选择?
  • order-service如何得知某个user-service实例是否依然健康,是不是已经宕机?

一、Eureka的结构和作用

这些问题都需要利用SpringCloud中的注册中心来解决,其中最广为人知的注册中心就是Eureka,其结构如下:
在这里插入图片描述

图中由两部分组成:

  • eureka服务端:
    • 作用:
      • 记录服务信息
      • 心跳监测(每个30秒检测客户端中的对象是否存活,若不存活则剔除服务列表中对应的信息)
  • eureka客户端:
    • 服务消费者:向eureka服务端进行服务拉取,获取提供者的实例地址列表
    • 服务提供者

客户端中的每个服务(不管是消费者还是提供者,因为角色不是唯一的,消费者也可能会提供服务给别人消费)都在启动时都会在eureka服务端中进行注册。

回答之前的各个问题。

问题1:order-service如何得知user-service实例地址?

获取地址信息的流程如下:

  • user-service服务实例启动后,将自己的信息注册到eureka-server(Eureka服务端)。这个叫服务注册
  • eureka-server保存服务名称到服务实例地址列表的映射关系
  • order-service根据服务名称,拉取实例地址列表。这个叫服务发现或服务拉取

问题2:order-service如何从多个user-service实例中选择具体的实例?

  • order-service从实例列表中利用负载均衡算法选中一个实例地址
  • 向该实例地址发起远程调用

问题3:order-service如何得知某个user-service实例是否依然健康,是不是已经宕机?

  • user-service会每隔一段时间(默认30秒)向eureka-server发起请求,报告自己状态,称为心跳
  • 当超过一定时间没有发送心跳时,eureka-server会认为微服务实例故障,将该实例从服务列表中剔除
  • order-service拉取服务时,就能将故障实例排除了

注意:一个微服务,既可以是服务提供者,又可以是服务消费者,因此eureka将服务注册、服务发现等功能统一封装到了eureka-client端

因此,接下来我们动手实践的步骤包括:
在这里插入图片描述

1.搭建eureka-server

以下内容是基于01小节的进行搭建的,在原有项目上引入Eureka配置。

  • 增加一个eureka服务注册中心
  • 将原有的服务注册到eureka注册中心上

首先大家注册中心服务端:eureka-server,这必须是一个独立的微服务

1)创建eureka-server服务

在cloud-demo父工程下,创建一个子模块:
在这里插入图片描述

填写模块信息:
在这里插入图片描述

然后填写服务信息:eureka-server
在这里插入图片描述

2)引入eureka依赖

引入SpringCloud为eureka提供的starter依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>

3)编写启动类

给eureka-server服务编写一个启动类,一定要添加一个@EnableEurekaServer注解,开启eureka的注册中心功能:

package cn.itcast.eureka;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@SpringBootApplication
@EnableEurekaServer
public class EurekaApplication {
    public static void main(String[] args) {
        SpringApplication.run(EurekaApplication.class, args);
    }
}

4)编写配置文件

编写一个application.yml文件,内容如下:这里用于进行eureka服务注册,因为eureka本身也是一个服务,将其注册到eureka中,eureka服务端便能发现到它,当然也可以去掉,注意我们引入的依赖是eureka-server,表示服务端。

server:
  port: 10086
spring:
  application:
    name: eureka-server
eureka:
  client:
    #表示是否将自己注册到 Eureka Server
    register-with-eureka: false
    #表示是否从 Eureka Server 获取注册信息
    fetch-registry: false
    service-url: 
      defaultZone: http://127.0.0.1:10086/eureka

5)启动服务

启动微服务,然后在浏览器访问:http://127.0.0.1:10086

看到下面结果就是成功了:【Application有Eureka信息证明Eureka服务是注册到了Eureka上的,如果上面的register-with-eureka配置成false则没有这个服务】

在这里插入图片描述

Instances currently registered with Eureka表示注册到eureka中的实例,由于我们在配置文件中将eureka服务进行服务注册,所以这里能看到一个注册到eureka服务端的实例——eureka-server。

2.服务注册

下面,我们将user-service注册到eureka-server中去。

1)引入依赖

在user-service的pom文件中,引入下面的eureka-client依赖:这个依赖将当前服务注册到了eureka上,同时将也能拉取eureka上注册的服务。

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

2)配置文件

在user-service中,修改application.yml文件,添加服务名称、eureka地址:

spring:
  application:
    name: userservice
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka

3)启动多个user-service实例

为了演示一个服务有多个实例的场景,我们添加一个SpringBoot的启动配置,再启动一个user-service。
首先,复制原来的user-service启动配置:
在这里插入图片描述

然后,在弹出的窗口中,填写信息:-Dserver.port=8082
在这里插入图片描述

现在,SpringBoot窗口会出现两个user-service启动配置:

在这里插入图片描述

不过,第一个是8081端口,第二个是8082端口。

启动两个user-service实例:

在这里插入图片描述

查看eureka-server管理页面:
在这里插入图片描述

3.服务发现

下面,我们将order-service的逻辑修改:向eureka-server拉取user-service的信息,实现服务发现。

1)引入依赖

之前说过,服务发现、服务注册统一都封装在eureka-client依赖,因此这一步与服务注册时一致。

在order-service的pom文件中,引入下面的eureka-client依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

2)配置文件

服务发现也需要知道eureka地址,因此第二步与服务注册一致,都是配置eureka信息:

在order-service中,修改application.yml文件,添加服务名称、eureka地址:

spring:
  application:
    name: orderservice
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka

3)服务拉取和负载均衡

最后,我们要去eureka-server中拉取user-service服务的实例列表,并且实现负载均衡。

不过这些动作不用我们去做,只需要添加一些注解即可。

在order-service的OrderApplication启动类上,给RestTemplate这个Bean添加一个@LoadBalanced注解实现服务远程调用时的负载均衡,将服务注册到了eureka上,A服务通过向B服务的服务名发起远程调用就可以获取到B服务的服务实例列表进行远程调用同时可以进行负载均衡。发起请求时要指定注册到eureka上的服务名,如order-service,而不是具体的服务地址:http://localhost/8081

负载均衡实现条件:

  • 向RestTemplate添加注解@LoadBalanced
  • 发起请求时指定的是注册到eureka上的服务名,如order-service 而不是服务的详细地址

@Bean注解
我们在RestTemplate上添加了一个@Bean注解,表示将该类注册到Spring容器中,注册要两个条件:

  • @Bean要作用在具有返回值的方法上,表示将方法返回值注册到Spring容器中
  • @Bean修饰的方法要写在有@Component注解或其派生注解修饰的类中

在这里插入图片描述

修改order-service服务中的cn.itcast.order.service包下的OrderService类中的queryOrderById方法。修改访问的url路径,用服务名代替ip、端口:http://userservice/user/

在这里插入图片描述

spring会自动帮助我们从eureka-server端,根据userservice这个服务名称,获取实例列表,而后完成负载均衡。

我们开启负载均衡(默认的处理规则是区域内可用服务器进行轮询调度)同时开启多个UserController实例时,每向UserController发起一次请求时,第一个请求由第一个UserController进行处理,第二个请求由第二个UserController进行处理,一次类推,直至下次循环。

5.Ribbon负载均衡

我们添加了@LoadBalanced注解,即可实现负载均衡功能,这是什么原理呢?

二、负载均衡原理

SpringCloud底层其实是利用了一个名为Ribbon的组件,来实现负载均衡功能的。
在这里插入图片描述

那么我们发出的请求明明是http://userservice/,怎么变成了http://localhost:8081的呢?

1.源码跟踪

为什么我们只输入了service名称就可以访问了呢?之前还要获取ip和端口。

显然有人帮我们根据service名称,获取到了服务实例的ip和端口。它就是LoadBalancerInterceptor,这个类会在对RestTemplate的请求进行拦截,然后从Eureka根据服务id获取服务列表,随后利用负载均衡算法得到真实的服务地址信息,替换服务id。

我们进行源码跟踪:

1)LoadBalancerIntercepor

在这里插入图片描述

可以看到这里的intercept方法,拦截了用户的HttpRequest请求,然后做了几件事:

  • request.getURI():获取请求uri,本例中就是 http://user-service/user/8
  • originalUri.getHost():获取uri路径的主机名,其实就是服务id,user-service
  • this.loadBalancer.execute():处理服务id,和用户请求。

这里的this.loadBalancerLoadBalancerClient类型,我们继续跟入。

2)LoadBalancerClient

继续跟入execute方法:
在这里插入图片描述

代码是这样的:

  • getLoadBalancer(serviceId):根据服务id获取ILoadBalancer,而ILoadBalancer会拿着服务id去eureka中获取服务列表并保存起来。
  • getServer(loadBalancer):利用内置的负载均衡算法,从服务列表中选择一个。本例中,可以看到获取了8082端口的服务

放行后,再次访问并跟踪,发现获取的是8081:
在这里插入图片描述

果然实现了负载均衡。

3)负载均衡策略IRule

在刚才的代码中,可以看到获取服务使通过一个getServer方法来做负载均衡:
在这里插入图片描述

我们继续跟入:

在这里插入图片描述

继续跟踪源码chooseServer方法,发现这么一段代码:
在这里插入图片描述

我们看看这个rule是谁:

在这里插入图片描述

这里的rule默认值是一个RoundRobinRule,看类的介绍:
在这里插入图片描述

这不就是轮询的意思嘛。

到这里,整个负载均衡的流程我们就清楚了。

4)总结

SpringCloudRibbon的底层采用了一个拦截器,拦截了RestTemplate发出的请求,对地址做了修改。用一幅图来总结一下:
在这里插入图片描述

基本流程如下:

  • 拦截我们的RestTemplate请求http://userservice/user/1
  • RibbonLoadBalancerClient会从请求url中获取服务名称,也就是user-service
  • DynamicServerListLoadBalancer根据user-service到eureka拉取服务列表
  • eureka返回列表,localhost:8081、localhost:8082
  • IRule利用内置负载均衡规则,从列表中选择一个,例如localhost:8081
  • RibbonLoadBalancerClient修改请求地址,用localhost:8081替代userservice,得到http://localhost:8081/user/1,发起真实请求

2.负载均衡策略

2.1.负载均衡策略

负载均衡的规则都定义在IRule接口中,而IRule有很多不同的实现类:
在这里插入图片描述

不同规则的含义如下:

内置负载均衡规则类规则描述
RoundRobinRule简单轮询服务列表来选择服务器。它是Ribbon默认的负载均衡规则。
AvailabilityFilteringRule对以下两种服务器进行忽略: (1)在默认情况下,这台服务器如果3次连接失败,这台服务器就会被设置为“短路”状态。短路状态将持续30秒,如果再次连接失败,短路的持续时间就会几何级地增加。 (2)并发数过高的服务器。如果一个服务器的并发连接数过高,配置了AvailabilityFilteringRule规则的客户端也会将其忽略。并发连接数的上限,可以由客户端的..ActiveConnectionsLimit属性进行配置。
WeightedResponseTimeRule为每一个服务器赋予一个权重值。服务器响应时间越长,这个服务器的权重就越小。这个规则会随机选择服务器,这个权重值会影响服务器的选择。
ZoneAvoidanceRule以区域可用的服务器为基础进行服务器的选择。使用Zone对服务器进行分类,这个Zone可以理解为一个机房、一个机架等。而后再对Zone内的多个服务做轮询。
BestAvailableRule忽略那些短路的服务器,并选择并发数较低的服务器。
RandomRule随机选择一个可用的服务器。
RetryRule重试机制的选择逻辑

默认的实现就是ZoneAvoidanceRule,是一种轮询方案

2.2.自定义负载均衡策略

通过定义IRule实现可以修改负载均衡规则,有两种方式:

  1. 代码方式:在order-service中的OrderApplication类中,定义一个新的IRule:

    这种配置方式的作用范围为order-service访问任何一个服务时都将采用随机方式进行

@Bean
public IRule randomRule(){
    return new RandomRule();
}
  1. 配置文件方式:在order-service的application.yml文件中,添加新的配置也可以修改规则:

    这种配置方式的作用范围为order-service访问userservice服务时才采用随机方式进行

userservice: # 给某个微服务配置负载均衡规则,这里是userservice服务
  ribbon:
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule # 负载均衡规则 

注意,一般用默认的负载均衡规则,不做修改。

3.饥饿加载

Ribbon默认是采用懒加载,即第一次访问时才会去创建LoadBalanceClient,请求时间会很长。

而饥饿加载则会在项目启动时创建,降低第一次访问的耗时,通过下面配置开启饥饿加载:

ribbon:
  eager-load:
    enabled: true
    clients: userservice

三、Nacos注册中心

国内公司一般都推崇阿里巴巴的技术,比如注册中心,SpringCloudAlibaba也推出了一个名为Nacos的注册中心。

1.认识和安装Nacos

Nacos是阿里巴巴的产品,现在是SpringCloud中的一个组件。相比Eureka功能更加丰富,在国内受欢迎程度较高。
在这里插入图片描述

安装方式可以参考:Nacos安装指南

我已经将Nacos安装到了D盘

2.服务注册到nacos

Nacos是SpringCloudAlibaba的组件,而SpringCloudAlibaba也遵循SpringCloud中定义的服务注册、服务发现规范。因此使用Nacos和使用Eureka对于微服务来说,并没有太大区别。

主要差异在于:

  • 依赖不同
  • 服务地址不同

nacos启动:

  • 点击nacos的bin目录下的startup.cmd进行nacos启动

  • 或者在bin目录下通过cmd命令启动

startup.cmd -m standalone

1)引入依赖

在cloud-demo父工程的pom文件中的<dependencyManagement>中引入SpringCloudAlibaba的依赖:

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>2.2.6.RELEASE</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

然后在user-service和order-service中的pom文件中引入nacos-discovery依赖:

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

注意:不要忘了注释掉eureka的依赖。

2)配置nacos地址

在user-service和order-service的application.yml中添加nacos地址:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848

注意:不要忘了注释掉eureka的地址

3)重启

重启微服务后,登录nacos管理页面,可以看到微服务信息:
在这里插入图片描述

在eureka中配置的Ribbon负载均衡策略仍然可以在nacos配置的服务注册中使用,跟eureka的区别就是Nacos需要进行安装,但不需要进行eureka配置,直接在所需的服务中进行Nacos注册即可。

3.服务分级存储模型

一个服务可以有多个实例,例如我们的user-service,可以有:

  • 127.0.0.1:8081
  • 127.0.0.1:8082
  • 127.0.0.1:8083

假如这些实例分布于全国各地的不同机房,例如:

  • 127.0.0.1:8081,在上海机房
  • 127.0.0.1:8082,在上海机房
  • 127.0.0.1:8083,在杭州机房

Nacos就将同一机房内的实例 划分为一个集群

也就是说,user-service是服务,一个服务可以包含多个集群,如杭州、上海,每个集群下可以有多个实例,形成分级模型,如图:
在这里插入图片描述

微服务互相访问时,应该尽可能访问同集群实例,因为本地访问速度更快。当本集群内不可用时,才访问其它集群。例如:

杭州机房内的order-service应该优先访问同机房的user-service。

3.1.给user-service配置集群

修改user-service的application.yml文件,添加集群配置:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ # 集群名称

重启两个user-service实例后,我们可以在nacos控制台看到下面结果:
在这里插入图片描述

开启第二个集群:

方式一:我们再次复制一个user-service启动配置,添加属性:

-Dserver.port=8083 -Dspring.cloud.nacos.discovery.cluster-name=SH

配置如图所示:

在这里插入图片描述

方式二:修改user-service的application.yml文件,然后我们再次复制一个user-service启动配置:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ # 集群名称

启动UserApplication3后再次查看nacos控制台:

在这里插入图片描述

3.2.同集群优先的负载均衡

默认的ZoneAvoidanceRule并不能实现根据同集群优先来实现负载均衡。

因此Nacos中提供了一个NacosRule的实现,可以优先从同集群中挑选实例。

1)给order-service配置集群信息

修改order-service的application.yml文件,添加集群配置:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ # 集群名称

2)修改负载均衡规则

修改order-service的application.yml文件,修改负载均衡规则:

userservice:
  ribbon:
    NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule # 负载均衡规则 

注意上面的配置方式是同集群优先,如果同集群中的服务实例找不到时,就会找其他可用的服务实例,此时我们的控制台会出现警告信息,表示请求的实例为不同集群下的服务实例。

4.权重配置

实际部署中会出现这样的场景:

服务器设备性能有差异,部分实例所在机器性能较好,另一些较差,我们希望性能好的机器承担更多的用户请求。

但默认情况下NacosRule是同集群内随机挑选,不会考虑机器的性能问题。

因此,Nacos提供了权重配置来控制访问频率,权重越大则访问频率越高。

在nacos控制台,找到user-service的实例列表,点击编辑,即可修改权重:
在这里插入图片描述

在弹出的编辑窗口,修改权重:

在这里插入图片描述

注意:如果权重修改为0,则该实例永远不会被访问。这种方式可以用于升级项目,当我们要对项目进行升级使,我们不可以直接停掉服务实例,因为这样用户请求时就会出现错误,我们可以先将权重设为0,过了一段时间后再进行服务升级,升级完毕将服务实例的权重设置得小一些,放一些用户进来测试,如果测试通过则逐渐提高权重值,做到平滑升级。

5.环境隔离

Nacos提供了namespace来实现环境隔离功能。

  • nacos中可以有多个namespace
  • namespace下可以有group、service等
  • 不同namespace之间相互隔离,例如不同namespace的服务互相不可见

在这里插入图片描述

1).创建namespace

默认情况下,所有service、data、group都在同一个namespace,名为public:

在这里插入图片描述

我们可以点击页面新增按钮,添加一个namespace:

在这里插入图片描述

然后,填写表单:
在这里插入图片描述

就能在页面看到一个新的namespace:

在这里插入图片描述

2)给微服务配置namespace

给微服务配置namespace只能通过修改配置来实现。

例如,修改order-service的application.yml文件:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ
        namespace: 492a7d5d-237b-46a1-a99a-fa8e98e4b0f9 # 命名空间,填ID

重启order-service后,访问控制台,可以看到下面的结果:

在这里插入图片描述
在这里插入图片描述

此时访问order-service,因为namespace不同,会导致找不到userservice,控制台会报错:

在这里插入图片描述

6.Nacos与Eureka的区别

Nacos的服务实例分为两种l类型:

  • 临时实例:如果实例宕机超过一定时间,会从服务列表剔除,默认的类型。

  • 非临时实例:如果实例宕机,不会从服务列表剔除,也可以叫永久实例。

配置一个服务实例为永久实例:

spring:
  cloud:
    nacos:
      discovery:
        ephemeral: false # 设置为非临时实例

Nacos和Eureka整体结构类似,服务注册、服务拉取、心跳等待,但是也存在一些差异:

在这里插入图片描述

  • Nacos与eureka的共同点

    • 都支持服务注册和服务拉取
    • 都支持服务提供者心跳方式做健康检测
  • Nacos与Eureka的区别

    • Nacos支持服务端主动检测提供者状态:临时实例采用心跳模式,非临时实例采用主动检测模式
    • 临时实例心跳不正常会被剔除,非临时实例则不会被剔除
    • Nacos支持服务列表变更的消息推送模式,服务列表更新更及时
    • Nacos集群默认采用AP方式,当集群中存在非临时实例时,采用CP模式;Eureka采用AP方式(下面会介绍AP和CP)

一般都使用临时实例的方式,因为非临时实例会给服务器带来较大的压力,因为服务器需要进行主动检测,需要频繁询问非临时实例是否还健康。而临时实例不健康时直接剔除,不会消耗太大性能。

eureka进行服务列表拉取时,时间为30秒,但是在这段时间内服务列表中的实例突然挂掉了,那么请求就可能失败,可靠性差了点。而Nacos不仅会进行服务拉取还会进行服务推送,当某个实例挂掉时,Nacos会及时通知消费者将缓存中的服务列表进行更新。

对于Nacos和Eureka这两个服务注册与发现的组件,它们在分布式环境中采取了不同的一致性模型。
AP(Availability & Partition tolerance) 指的是可用性和分区容错性。在AP模式下,系统优先保证服务的可用性,即使在网络分区或部分节点故障的情况下仍然可以提供服务。这意味着有些时候,系统可能会出现数据的不一致或延迟,但整体上保持了高可用性。Nacos和Eureka默认采用AP模式。
CP(Consistency & Partition tolerance) 指的是一致性和分区容错性。在CP模式下,系统优先保证数据的一致性,即使在网络分区或部分节点故障的情况下,也会保证数据的一致性。这可能会导致系统在部分节点不可用时无法提供服务。在Nacos集群中,当存在非临时实例(持久化实例)时,默认会切换到CP模式,以保证数据的一致性。
总结起来,AP模式注重可用性,保证服务的快速响应;CP模式注重一致性,保证数据的准确性。选择AP还是CP取决于具体的业务需求,在高可用性为主要考虑因素的场景下,可以选择AP模式;而在要求数据一致性为主要考虑因素的场景下,可以选择CP模式。

四、Nacos配置管理

Nacos除了可以做注册中心,同样可以做配置管理来使用。

1.统一配置管理

当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。注意这里实现的是同一个服务或多个服务的多个实例的统一配置,我们就不需要在每个实例的配置文件中都配置相同的配置,修改时也更加方便,类似全局变量。

在这里插入图片描述

Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。

1)在nacos中添加配置文件

如何在nacos中管理配置呢?
在这里插入图片描述

然后在弹出的表单中,填写配置信息:

在这里插入图片描述

注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

2)从微服务拉取配置

微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。

但如果尚未读取application.yml,又如何得知nacos地址呢?

因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:
在这里插入图片描述

1)引入nacos-config依赖

首先,在user-service服务中,引入nacos-config的客户端依赖:

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

2)添加bootstrap.yaml

然后,在user-service中添加一个bootstrap.yaml文件,内容如下:

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境,这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。

本例中,就是去读取userservice-dev.yaml

在这里插入图片描述

3)读取nacos配置

在user-service中的UserController中添加业务逻辑,读取pattern.dateformat配置:
在这里插入图片描述

完整代码:

package cn.itcast.user.web;

import cn.itcast.user.pojo.User;
import cn.itcast.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @Value("${pattern.dateformat}")
    private String dateformat;
    
    @GetMapping("now")
    public String now(){
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
    }
    // ...略
}

在页面访问,可以看到效果:
在这里插入图片描述

2.配置热更新

我们最终的目的,是修改nacos中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新

要实现配置热更新,可以使用两种方式:

1)方式一

在@Value注入的变量所在类上添加注解@RefreshScope:

注意需要通过@Value获取配置文件中的配置信息
在这里插入图片描述

2)方式二

使用@ConfigurationProperties注解代替@Value注解。

在user-service服务中,添加一个类,读取patterrn.dateformat属性:

package cn.itcast.user.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
}

注意上面这种指定前缀为pattern表示我们要获取Nacos配置文件中的pattern信息,同时获取dateformat就在类中指定dateformat。

在UserController中使用这个类代替@Value:

在这里插入图片描述

完整代码:

package cn.itcast.user.web;

import cn.itcast.user.config.PatternProperties;
import cn.itcast.user.pojo.User;
import cn.itcast.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @Autowired
    private PatternProperties patternProperties;

    @GetMapping("now")
    public String now(){
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
    }

    // 略
}

3.配置共享

其实微服务启动时,会去nacos读取多个配置文件,例如:

  • [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml

  • [spring.application.name].yaml,例如:userservice.yaml

[spring.application.name].yaml不包含环境,因此可以被多个环境共享。

下面我们通过案例来测试配置共享

1)添加一个环境共享配置

我们在nacos中添加一个userservice.yaml文件:

在这里插入图片描述

2)在user-service中读取共享配置

在user-service服务中,修改PatternProperties类,读取新添加的属性:
在这里插入图片描述

在user-service服务中,修改UserController,添加一个方法:
在这里插入图片描述

3)运行两个UserApplication,使用不同的profile

修改UserApplication2这个启动项,改变其profile值:

在这里插入图片描述
在这里插入图片描述

这样,UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test。

启动UserApplication和UserApplication2

访问http://localhost:8081/user/prop,结果:
在这里插入图片描述

访问http://localhost:8082/user/prop,结果:

在这里插入图片描述

可以看出来,不管是dev,还是test环境,都读取到了envSharedValue这个属性的值。

4)配置共享的优先级

当nacos、服务本地同时出现相同属性时,优先级有高低之分:

在这里插入图片描述

4.搭建Nacos集群

Nacos生产环境下一定要部署为集群状态。

后续更新。。。。

文章来源:https://blog.csdn.net/m0_53951384/article/details/135402120
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。