SpringCloud--Feign&Gateway

SpringCloud–Feign&Gateway

http客户端-Feign

RestTemplate方式调用存在的问题：

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

而http客户端Feign可以帮助我们优雅的实现http请求的发送，解决上述问题

Feign是一个声明式的http客户端，地址：https://github.com/OpenFeign/feign

1.基于Feign远程调用

1. 引入依赖

   <dependency>
       <groupId>org.springframework.cloudgroupId>
       <artifactId>spring-cloud-starter-openfeignartifactId>
   dependency>
   

2. 在启动类添加注解开启Feign的功能

   @EnableFeignClients //可开启Feign的功能
   @MapperScan("cn.itcast.order.mapper")
   @SpringBootApplication
   public class OrderApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(OrderApplication.class, args);
           ...
       }
   

3. 编写Feign客户端

   package cn.itcast.order.clients;
   
   import cn.itcast.order.pojo.User;
   import org.springframework.cloud.openfeign.FeignClient;
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.PathVariable;
   
   /**
    * description: feign客户端
    *
    * @since 2023-11-01
    */
   @FeignClient("userservice")
   public interface UserClient {
       @GetMapping("/user/{id}")
       User findById(@PathVariable("id") Long id);
   }
   
   

4. 用Feign客户端代替RestTemplate

   @Autowired
   private UserClient userClient;
   
   public Order queryOrderById(Long orderId) {
         // 1.查询订单
         Order order = orderMapper.findById(orderId);
         // 2.利用Feign发起http请求，查询用户
         User user = userClient.findById(order.getUserId());
         //3.封装user信息
         order.setUser(user);
         // 4.返回
         return order;
   }
   

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即可

日志配置：

日志级别有四种：

• NONE：不记录任何日志信息，这是默认值
• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据

实现：

1. 配置文件方式：

   feign:
     client:
       config:
         userservice: # 针对某个微服务的配置  default则是全局配置
           loggerLevel: FULL # 日志级别
   

2. java代码方式：

   package cn.itcast.order.config;
   
   import org.springframework.context.annotation.Bean;
   
   import feign.Logger;
   
   /**
    * description:
    *
    * @since 2023-11-01
    */
   public class DefaultFeignConfiguration {
   
       @Bean
       public Logger.Level feignLogLevel(){
           return Logger.Level.BASIC; //日志级别
       }
   }
   

   @EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class) //可开启Feign的功能
   @MapperScan("cn.itcast.order.mapper")
   @SpringBootApplication
   public class OrderApplication {...}
   

3.性能优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

•URLConnection：默认实现，不支持连接池

•Apache HttpClient ：支持连接池

•OKHttp：支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection，并且日志级别尽量用basic

feign:
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 #最大的连接数
    max-connections-per-route: 50 #每个路径的最大连接数

4.最佳实践

Feign的客户端与服务提供者的controller代码非常相似

解决：

1. 继承方式

   一样的代码可以通过继承来共享：

   1）定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。

   2）Feign客户端和Controller都集成改接口

   优点：

   • 简单
   • 实现了代码共享

   缺点：

   • 服务提供方、服务消费方紧耦合

   • 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

   

2. 抽取方式

   将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用

   

Gateway服务网关

网关的功能：

• 身份认证和权限校验
• 服务路由、负载均衡
• 请求限流

权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。

---

1.实现

在SpringCloud中网关的实现有两种：

• zuul：基于Servlet的实现，属于阻塞式编程
• gateway：SpirngCloudGateway是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能

gateway实现：

1. 引入依赖：

   
   <dependency>
       <groupId>org.springframework.cloudgroupId>
       <artifactId>spring-cloud-starter-gatewayartifactId>
   dependency>
   
   <dependency>
       <groupId>com.alibaba.cloudgroupId>
       <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
   dependency>
   

2. 启动类：

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

3. yml：

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

   重启网关，访问http://localhost:10010/user/1时，符合/user/**规则，请求转发到uri：http://userservice/user/1，得到了结果：

---

整个访问的流程：

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这种路由工程就可以了。

3.过滤器工厂

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

过滤器种类：

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

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

---

请求头过滤器：

以AddRequestHeader 为例，给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

---

默认过滤器：

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=Truth, Itcast is freaking awesome! 

4.全局过滤器GlobalFilter

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与Gateway作用一样。

区别在于GatewayFilter通过配置定义，处理逻辑是固定的，而GlobalFilter的逻辑需要自己写代码实现

定义方式是实现GlobalFilter接口：

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

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

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

---

自定义全局过滤器：

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

• 参数中是否有authorization

• authorization参数值是否为admin

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

实现：

package com.lanest;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * description:
 *
 * @since 2023-11-16
 */
@Order(-1) //过滤器顺序
@Component
public class AuthorizerFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> params = request.getQueryParams();
        //获取authorization参数
        String auth = params.getFirst("authorization");
        if ("admin".equals(auth)){
            //放行
            return chain.filter(exchange);
        }
        //拦截
        //设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        //拦截请求
        return exchange.getResponse().setComplete();
    }
}

5.过滤器执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter、

请求路由后，会将当前路由过滤器和DefaulFilter、GlobalFilter，合并道一个过滤器链（集合）中，排序后依次执行每个过滤器：

排序的规则：

• 每一个过滤器都必须指定一个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.跨域

在gateway服务的application.yml文件中，添加下面的配置：

```yaml
spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期
```