1. 前言

image.png
image.png

SpringCloud是目前国内使用最广泛的微服务框架。官网地址:https://spring.io/projects/spring-cloud
SpringCloud集成了各种微服务功能组件,并基于SpringBoot实现了这些组件的自动装配,从而提供了良好的开箱即用体验。
其中常见的组件包括:

image.png

2. 服务拆分与远程调用

2.1 服务拆分原则

  • 不同微服务,不要重复开发相同业务
  • 微服务数据独立,不要访问其它微服务的数据库
  • 微服务可以将自己的业务暴露为接口,供其它微服务调用

image.png

2.2 服务拆分示例

image.png

cloud-demo:父工程,管理依赖

  • order-service:订单微服务,负责订单相关业务
  • user-service:用户微服务,负责用户相关业务

要求:

  • 订单微服务和用户微服务都必须有各自的数据库,相互独立
  • 订单服务和用户服务都对外暴露Restful的接口
  • 订单服务如果需要查询用户信息,只能调用用户服务的Restful接口,不能查询用户数据库

    2.3 远程调用示例

    order-service服务中,有一个根据id查询订单的接口: ```java @RestController @RequestMapping(“order”) public class OrderController {

    @Autowired private OrderService orderService;

    @GetMapping(“{orderId}”) public Order queryOrderByUserId(@PathVariable(“orderId”) Long orderId) {

    1. // 根据id查询订单并返回
    2. return orderService.queryOrderById(orderId);

    } }

发送get请求,url = localhost:8088/order/101 返回体: { “id”: 101, “price”: 699900, “name”: “Apple 苹果 iPhone 12 “, “num”: 1, “userId”: 1, “user”: null }

  1. `user-service`中有一个根据id查询用户的接口:
  2. ```java
  3. @RestController
  4. @RequestMapping("user")
  5. public class UserController {
  6. @Autowired
  7. private UserService userService;
  8. /**
  9. * 路径: /user/110
  10. *
  11. * @param id 用户id
  12. * @return 用户
  13. */
  14. @GetMapping("/{id}")
  15. public User queryById(@PathVariable("id") Long id) {
  16. return userService.queryById(id);
  17. }
  18. }
  19. 发送get请求,url = localhost:8081/user/1
  20. 返回体:
  21. {
  22. "id": 1,
  23. "username": "柳岩",
  24. "address": "湖南省衡阳市"
  25. }

2.3.1 案例需求

修改order-service中的根据id查询订单业务,要求在查询订单的同时,根据订单中包含的userId查询出用户信息,一起返回。
image.png

因此,我们需要在order-service中 向user-service发起一个http的请求,调用http://localhost:8081/user/{userId}这个接口。
大概的步骤是这样的:

  • 注册一个RestTemplate的实例到Spring容器
  • 修改order-service服务中的OrderService类中的queryOrderById方法,根据Order对象中的userId查询User
  • 将查询的User填充到Order对象,一起返回

2.3.2 注册RestTemplate

首先,我们在order-service服务中的OrderApplication启动类中,注册RestTemplate实例

  1. import org.mybatis.spring.annotation.MapperScan;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.web.client.RestTemplate;
  6. @MapperScan("cn.itcast.order.mapper")
  7. @SpringBootApplication
  8. public class OrderApplication {
  9. public static void main(String[] args) {
  10. SpringApplication.run(OrderApplication.class, args);
  11. }
  12. @Bean
  13. public RestTemplate restTemplate() {
  14. return new RestTemplate();
  15. }
  16. }

2.3.3实现远程调用

修改order-service服务中的OrderServiceImpl类中的queryOrderById方法

  1. @Service
  2. public class OrderServiceImpl implements OrderService {
  3. @Autowired
  4. private OrderMapper orderMapper;
  5. @Autowired
  6. private RestTemplate restTemplate;
  7. @Override
  8. public Order queryOrderById(Long orderId) {
  9. // 1.查询订单
  10. Order order = orderMapper.findById(orderId);
  11. // 2.利用RestTemplate发起http请求,查询用户
  12. // 2.1.url路径
  13. String url = "http://user-server/user/" + order.getUserId();
  14. // 2.2.发送http请求,实现远程调用
  15. User user = restTemplate.getForObject(url, User.class);
  16. // 3.封装user到Order
  17. order.setUser(user);
  18. // 4.返回
  19. return order;
  20. }
  21. }
  22. 发送get请求,url = localhost:8088/order/101
  23. 返回体:
  24. {
  25. "id": 101,
  26. "price": 699900,
  27. "name": "Apple 苹果 iPhone 12 ",
  28. "num": 1,
  29. "userId": 1,
  30. "user":
  31. { "id": 1,
  32. "username": "柳岩",
  33. "address": "湖南省衡阳市"
  34. }
  35. }

2.4 提供者和消费者

在服务调用关系中,会有两个不同的角色:
服务提供者:一次业务中,被其它微服务调用的服务。(提供接口给其它微服务)
服务消费者:一次业务中,调用其它微服务的服务。(调用其它微服务提供的接口)
但是,服务提供者与服务消费者的角色并不是绝对的,而是相对于业务而言。
image.png
如果服务A调用了服务B,而服务B又调用了服务C,服务B的角色是什么?

  • 对于A调用B的业务而言:A是服务消费者,B是服务提供者
  • 对于B调用C的业务而言:B是服务消费者,C是服务提供者

因此,服务B既可以是服务提供者,也可以是服务消费者。

3. 注册中心—-Eureka/Nacos

注册中心的作用一句话概括就是存放和调度服务,实现服务和注册中心,服务和服务之间的相互通信。注册中心可以说是微服务架构中的”通讯录“,它记录了服务和服务地址的映射关系。在分布式架构中,服务会注册到这里,当服务需要调用其它服务时,就到这里找到服务的地址,进行调用。

3.1 Eureka

3.1.1 Eureka的作用

image.png

问题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拉取服务时,就能将故障实例排除了

3.1.2 Eureka的使用

image.png

3.1.2.1 搭建Eureka-server

  1. 新建一个模块 eureka-server
  2. 引入eureka-server依赖

    1. <dependency>
    2. <groupId>org.springframework.cloud</groupId>
    3. <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    4. </dependency>
  3. 编写启动类 ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@SpringBootApplication //开启Eureka的注册中心功能 @EnableEurekaServer public class EurekaApplication { public static void main(String[] args) { SpringApplication.run(EurekaApplication.class, args); } }

  1. 4. 编写配置文件
  2. ```yaml
  3. server:
  4. port: 10086 #Eureka服务端口
  5. spring:
  6. application:
  7. name: eureka-server #服务名称
  8. eureka:
  9. client:
  10. service-url:
  11. defaultZone: http://127.0.0.1:10086/eureka #Eureka地址

3.1.2.2服务注册

每一个服务的注册步骤都是

  1. 添加 eureka-client 依赖
  2. 设置服务名称与Eureka地址

eureka-server 也需要服务注册,因为它也算是一个微服务,所以它也需要设置服务名称与Eureka地址

  1. user-serviceorder-service引入依赖

    1. <dependency>
    2. <groupId>org.springframework.cloud</groupId>
    3. <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    4. </dependency>
  2. 编写配置文件

    1. spring:
    2. application:
    3. name: user-server #服务名称
    4. eureka:
    5. client:
    6. service-url:
    7. defaultZone: http://127.0.0.1:10086/eureka #Eureka地址

    3.1.2.3 服务发现

    在Eureka服务中心注册过后,可以不需要填写具体url路径,可以通过输入服务名称,然后通过eureka做到服务拉取与负载均衡。

order-serviceOrderApplication中,给RestTemplate这个Bean添加一个@LoadBalanced注解,开启负载均衡

  1. @SpringBootApplication
  2. @MapperScan("com.afloiris.order.mapper")
  3. public class OrderApplication {
  4. public static void main(String[] args) {
  5. SpringApplication.run(OrderApplication.class);
  6. }
  7. @Bean
  8. //开启负载均衡
  9. @LoadBalanced
  10. public RestTemplate restTemplate(){
  11. return new RestTemplate();
  12. }
  13. }

修改order-service服务中的OrderServiceImpl类中的queryOrderById方法。修改访问的url路径,用服务名代替ip、端口:

  1. @Service
  2. public class OrderServiceImpl implements OrderService {
  3. @Autowired
  4. private OrderMapper orderMapper;
  5. @Autowired
  6. private RestTemplate restTemplate;
  7. @Override
  8. public Order queryOrderById(Long orderId) {
  9. // 1.查询订单
  10. Order order = orderMapper.findById(orderId);
  11. // 2.利用RestTemplate发起http请求,查询用户
  12. // 2.1.url路径
  13. //String url = "http:localhost:8081/user/"+order.getUserId();
  14. String url = "http://user-server/user/" + order.getUserId();
  15. // 2.2.发送http请求,实现远程调用
  16. User user = restTemplate.getForObject(url, User.class);
  17. // 3.封装user到Order
  18. order.setUser(user);
  19. // 4.返回
  20. return order;
  21. }
  22. }

3.2 Nacos

国内公司一般都推崇阿里巴巴的技术,比如注册中心,SpringCloudAlibaba也推出了一个名为Nacos的注册中心。
Nacos的安装,参考官网:https://nacos.io/zh-cn/index.html

3.2.1 Nacos的作用

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

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

    3.2.2 Nacos的使用

    3.2.2.1引入依赖

    cloud-demo父工程的pom文件中的<dependencyManagement>中引入SpringCloudAlibaba的依赖:
    1. <dependency>
    2. <groupId>com.alibaba.cloud</groupId>
    3. <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    4. <version>2.2.6.RELEASE</version>
    5. <type>pom</type>
    6. <scope>import</scope>
    7. </dependency>
    然后在user-serviceorder-service中的pom文件中引入nacos-discovery依赖:
    1. <dependency>
    2. <groupId>com.alibaba.cloud</groupId>
    3. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    4. </dependency>

    3.2.2.2配置nacos地址

    user-serviceorder-service的application.yml中添加nacos地址:
    1. spring:
    2. cloud:
    3. nacos:
    4. server-addr: localhost:8848

    3.2.2.3登录nacos管理页面

    重启微服务后,登录nacos管理页面,可以看到微服务信息:

    localhost:8848/nacos 账号密码:nacos/nacos

image.png

3.2.3 服务分级存储模型

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

3.2.3.1 添加集群

  1. spring:
  2. cloud:
  3. nacos:
  4. server-addr: localhost:8848
  5. discovery:
  6. cluster-name: HZ # 集群名称

3.2.3.2 同集群优先的负载均衡

默认的ZoneAvoidanceRule并不能实现根据同集群优先来实现负载均衡。
因此Nacos中提供了一个NacosRule的实现,可以优先从同集群中挑选实例。

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

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

  1. spring:
  2. cloud:
  3. nacos:
  4. server-addr: localhost:8848
  5. discovery:
  6. cluster-name: HZ # 集群名称
  1. 修改负载均衡规则

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

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

3.2.4 权重配置

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

服务器设备性能有差异,部分实例所在机器性能较好,另一些较差,我们希望性能好的机器承担更多的用户请求。 但默认情况下NacosRule是同集群内随机挑选,不会考虑机器的性能问题。

因此,Nacos提供了权重配置来控制访问频率,权重越大则访问频率越高。
在nacos控制台,找到user-service的实例列表,点击编辑,即可修改权重:
image.png
在弹出的编辑窗口,修改权重:
image.png

注意:如果权重修改为0,则该实例永远不会被访问

3.2.5 环境隔离

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

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

image.png

3.2.5.1 创建namespace

image.png
image.png
image.png

3.2.5.2 给微服务配置namespace

  1. spring:
  2. cloud:
  3. nacos:
  4. server-addr: localhost:8848
  5. discovery:
  6. cluster-name: HZ
  7. namespace: 492a7d5d-237b-46a1-a99a-fa8e98e4b0f9 # 命名空间,填ID

3.3 Nacos与Eureka的区别

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

  • 临时实例:如果实例宕机超过一定时间,会从服务列表剔除,默认的类型。
  • 非临时实例:如果实例宕机,不会从服务列表剔除,也可以叫永久实例。

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

  1. spring:
  2. cloud:
  3. nacos:
  4. discovery:
  5. ephemeral: false # 设置为非临时实例

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

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

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

      3.4 Ribbon负载均衡

      @LoadBalanced注解,即可实现负载均衡功能

      3.4.1 负载均衡原理

      SpringCloud底层其实是利用了一个名为Ribbon的组件,来实现负载均衡功能的。
      image.png

      3.4.2 源码跟踪

      为什么我们只输入了service名称就可以访问了呢?之前还要获取ip和端口。
      显然有人帮我们根据service名称,获取到了服务实例的ip和端口。它就是 LoadBalancerInterceptor,这个类会在对RestTemplate的请求进行拦截,然后从Eureka根据服务id获取服务列表,随后利用负载均衡算法得到真实的服务地址信息,替换服务id。
      我们进行源码跟踪:

      LoadBalancerIntercepor

      image.png
      可以看到这里的intercept方法,拦截了用户的HttpRequest请求,然后做了几件事
  • request.getURI():获取请求uri,本例中就是 http://user-service/user/8

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

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

LoadBalancerClient

继续跟入execute方法:
image.png
代码是这样的:

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

放行后,再次访问并跟踪,发现获取的是8081
image.png
果然实现了负载均衡。

总结

image.png
基本流程如下:

  • 拦截我们的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,发起真实请求

    3.4.3 负载均衡策略

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

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

3.4.4 自定义负载均衡策略

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

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

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

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

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

3.4.5 饥饿加载

Ribbon默认是采用懒加载,即第一次访问时才会去创建LoadBalanceClient,请求时间会很长。
而饥饿加载则会在项目启动时创建,降低第一次访问的耗时,通过下面配置开启饥饿加载:

  1. ribbon:
  2. eager-load:
  3. enabled: true
  4. clients: userservice

4. 配置中心—-Nacos

4.1 统一配置管理

当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。
image.png
Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新

4.2 Nacos配置中心的应用

4.2.1 在Nacos中添加配置文件

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

image.png
image.png

4.2.2 从微服务中拉取配置

微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。
但如果尚未读取application.yml,又如何得知nacos地址呢?
因此spring引入了一种新的配置文件:bootstrap.yml文件,会在application.yml之前被读取,流程如下:
image.png

引入nacos-config依赖

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

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

添加bootstrap.yml文件

  1. spring:
  2. application:
  3. name: userservice # 服务名称
  4. profiles:
  5. active: dev #开发环境,这里是dev
  6. cloud:
  7. nacos:
  8. server-addr: localhost:8848 # Nacos地址
  9. config:
  10. 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

4.2.3 配置热更新

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

@RefreshScope

在使用到热更新配置中的数据的类上加上注解

  1. @Slf4j
  2. @RestController
  3. @RequestMapping("/user")
  4. @RefreshScope //开启热更新
  5. public class UserController {
  6. @Autowired
  7. private UserService userService;
  8. @Value("${pattern.dateformat}")
  9. private String dateformat;
  10. @GetMapping("now")
  11. public String now(){
  12. return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
  13. }
  14. // ...略
  15. }

@ConfigurationProperties

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

  1. package cn.itcast.user.config;
  2. import lombok.Data;
  3. import org.springframework.boot.context.properties.ConfigurationProperties;
  4. import org.springframework.stereotype.Component;
  5. @Component
  6. @Data
  7. @ConfigurationProperties(prefix = "pattern")
  8. public class PatternProperties {
  9. private String dateformat;
  10. }

4.2.4 配置共享与优先级

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

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

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

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

5. 远程调用—Feign

利用RestTemplate发起远程调用的代码存在下面的问题:

  • 代码可读性差,编程体验不统一
  • 参数复杂URL难以维护

Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。

5.1 Feign替代RestTemplate

添加依赖

  1. <dependency>
  2. <groupId>org.springframework.cloud</groupId>
  3. <artifactId>spring-cloud-starter-openfeign</artifactId>
  4. </dependency>

添加注解@EnableFeignClients

编写Feign客户端

  1. package com.afloiris.order.client;
  2. import com.afloiris.order.pojo.User;
  3. import org.springframework.cloud.openfeign.FeignClient;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.PathVariable;
  6. @FeignClient("userservice")
  7. public interface UserClient {
  8. @GetMapping("/user/{id}")
  9. User findById(@PathVariable("id") Long id);
  10. }

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:

  • 服务名称:userservice
  • 请求方式:GET
  • 请求路径:/user/{id}
  • 请求参数:Long id
  • 返回值类型:User

这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。

调用

  1. @Autowired
  2. private UserClient userClient; //注入容器
  3. ...
  4. User user = userClient.findById(order.getUserId()); //调用方法
  5. ...

5.2 自定义配置

Feign可以支持很多的自定义配置,如下表所示:

类型 作用 说明
feign.Logger.Level 修改日志级别 包含四种不同的级别:NONE、BASIC、HEADERS、FULL
feign.codec.Decoder 响应结果的解析器 http远程调用的结果做解析,例如解析json字符串为java对象
feign.codec.Encoder 请求参数编码 将请求参数编码,便于通过http请求发送
feign. Contract 支持的注解格式 默认是SpringMVC的注解
feign. Retryer 失败重试机制 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试

一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。

配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务:

  1. feign:
  2. client:
  3. config:
  4. userservice: # 针对某个微服务的配置
  5. loggerLevel: FULL # 日志级别

也可以针对所有服务:

  1. feign:
  2. client:
  3. config:
  4. default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
  5. loggerLevel: FULL # 日志级别

java代码方式

也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:

  1. public class DefaultFeignConfiguration {
  2. @Bean
  3. public Logger.Level feignLogLevel(){
  4. return Logger.Level.BASIC; // 日志级别为BASIC
  5. }
  6. }

如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:

  1. @EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是局部生效,则把它放到对应的@FeignClient这个注解中:

  1. @FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)

5.3 Feign优化

Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
•URLConnection:默认实现,不支持连接池
•Apache HttpClient :支持连接池
•OKHttp:支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。
这里我们用Apache的HttpClient来演示。

引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖:

  1. <!--httpClient的依赖 -->
  2. <dependency>
  3. <groupId>io.github.openfeign</groupId>
  4. <artifactId>feign-httpclient</artifactId>
  5. </dependency>

配置连接池

在order-service的application.yml中添加配置:

  1. feign:
  2. client:
  3. config:
  4. default: # default全局的配置
  5. loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  6. httpclient:
  7. enabled: true # 开启feign对HttpClient的支持
  8. max-connections: 200 # 最大的连接数
  9. max-connections-per-route: 50 # 每个路径的最大连接数

6. 服务网关—-Gateway

Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性

  • 请求路由
  • 权限控制
  • 限流

架构图:
image.png

权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。

在SpringCloud中网关的实现包括两种:

  • gateway
  • zuul

Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。

6.1 Gateway的使用

创建gateway服务,引入依赖

创建gateway模块。
引入依赖:

  1. <!--网关-->
  2. <dependency>
  3. <groupId>org.springframework.cloud</groupId>
  4. <artifactId>spring-cloud-starter-gateway</artifactId>
  5. </dependency>
  6. <!--nacos服务发现依赖-->
  7. <dependency>
  8. <groupId>com.alibaba.cloud</groupId>
  9. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  10. </dependency>

编写启动类

  1. package com.afloiris.gateway;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. @SpringBootApplication
  5. public class GatewayApplication {
  6. public static void main(String[] args) {
  7. SpringApplication.run(GatewayApplication.class, args);
  8. }
  9. }

编写基础配置和路由规则

创建application.yml文件,内容如下:

  1. server:
  2. port: 10010 # 网关端口
  3. spring:
  4. application:
  5. name: gateway # 服务名称
  6. cloud:
  7. nacos:
  8. server-addr: localhost:8848 # nacos地址
  9. gateway:
  10. routes: # 网关路由配置
  11. - id: user-service # 路由id,自定义,只要唯一即可
  12. # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
  13. uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
  14. predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
  15. - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求

我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。
本例中,我们将 /user/**开头的请求,代理到lb://userservice,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。

流程

image.png

6.2 断言工厂

我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来
处理的,像这样的断言工厂在SpringCloudGateway还有十几个:

名称 说明 示例
After 是某个时间点后的请求 - After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before 是某个时间点之前的请求 - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between 是某两个时间点之前的请求 - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie 请求必须包含某些cookie - Cookie=chocolate, ch.p
Header 请求必须包含某些header - Header=X-Request-Id, \d+
Host 请求必须是访问某个host(域名) - Host=.somehost.org,.anotherhost.org
Method 请求方式必须是指定方式 - Method=GET,POST
Path 请求路径必须符合指定规则 - Path=/red/{segment},/blue/**
Query 请求参数必须包含指定参数 - Query=name, Jack或者- Query=name
RemoteAddr 请求者的ip必须是指定范围 - RemoteAddr=192.168.1.1/24
Weight 权重处理

我们只需要掌握Path这种路由工厂就可以了。

6.3 过滤器工厂

GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
image.png

6.3.1 路由过滤器的种类

Spring提供了31种不同的路由过滤器工厂。例如:

名称 说明
AddRequestHeader 给当前请求添加一个请求头
RemoveRequestHeader 移除请求中的一个请求头
AddResponseHeader 给响应结果中添加一个响应头
RemoveResponseHeader 从响应结果中移除有一个响应头
RequestRateLimiter 限制请求的流量

6.3.2 请求头过滤器

以AddRequestHeader 为例来讲解。

需求:给所有进入userservice的请求添加一个请求头:Truth=AFloiris

只需要修改gateway服务的application.yml文件,添加路由过滤即可:

  1. spring:
  2. cloud:
  3. gateway:
  4. routes:
  5. - id: user-service
  6. uri: lb://userservice
  7. predicates:
  8. - Path=/user/**
  9. filters: # 过滤器
  10. - AddRequestHeader=AFloiris # 添加请求头

当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效。

6.3.3 默认过滤器

如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:

  1. spring:
  2. cloud:
  3. gateway:
  4. routes:
  5. - id: user-service
  6. uri: lb://userservice
  7. predicates:
  8. - Path=/user/**
  9. default-filters: # 默认过滤项
  10. - AddRequestHeader=AFloiris

6.4 局过滤器

过滤器网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。

6.4.1 全局过滤器作用

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

  1. public interface GlobalFilter {
  2. /**
  3. * 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
  4. *
  5. * @param exchange 请求上下文,里面可以获取Request、Response等信息
  6. * @param chain 用来把请求委托给下一个过滤器
  7. * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
  8. */
  9. Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
  10. }

在filter中编写自定义逻辑,可以实现下列功能:

  • 登录状态判断
  • 权限校验
  • 请求限流等

    6.4.2 自定义全局过滤器

    需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:

  • 参数中是否有authorization,

  • authorization参数值是否为admin

如果同时满足则放行,否则拦截

实现:
在gateway中定义一个过滤器:

  1. package com.afloiris.gateway.filters;
  2. import org.springframework.cloud.gateway.filter.GatewayFilterChain;
  3. import org.springframework.cloud.gateway.filter.GlobalFilter;
  4. import org.springframework.core.annotation.Order;
  5. import org.springframework.http.HttpStatus;
  6. import org.springframework.stereotype.Component;
  7. import org.springframework.web.server.ServerWebExchange;
  8. import reactor.core.publisher.Mono;
  9. @Order(-1)
  10. @Component
  11. public class AuthorizeFilter implements GlobalFilter {
  12. @Override
  13. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  14. // 1.获取请求参数
  15. MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
  16. // 2.获取authorization参数
  17. String auth = params.getFirst("authorization");
  18. // 3.校验
  19. if ("admin".equals(auth)) {
  20. // 放行
  21. return chain.filter(exchange);
  22. }
  23. // 4.拦截
  24. // 4.1.禁止访问,设置状态码
  25. exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
  26. // 4.2.结束处理
  27. return exchange.getResponse().setComplete();
  28. }
  29. }

6.4.3 过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilterGlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilterGlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
image.png
排序的规则是什么呢?

  • 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前
  • GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
  • 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
  • 当过滤器的order值一样时,会按照 **defaultFilter**> 路由过滤器 >**GlobalFilter**顺序执行。

详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链

6.5 跨域问题

gateway服务的application.yml文件中,添加下面的配置:

  1. spring:
  2. cloud:
  3. gateway:
  4. globalcors: # 全局的跨域处理
  5. add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
  6. corsConfigurations:
  7. '[/**]':
  8. allowedOrigins: # 允许哪些网站的跨域请求
  9. - "http://localhost:8090"
  10. allowedMethods: # 允许的跨域ajax的请求方式
  11. - "GET"
  12. - "POST"
  13. - "DELETE"
  14. - "PUT"
  15. - "OPTIONS"
  16. allowedHeaders: "*" # 允许在请求中携带的头信息
  17. allowCredentials: true # 是否允许携带cookie
  18. maxAge: 360000 # 这次跨域检测的有效期