[Java知识库]SpringCloud--组件--Gateway（网关）

Gateway网关

Gateway-概述

• 网关旨在为微服务架构提供一种简单而有效的统一的API路由管理方式。
• 在微服务架构中，不同的微服务可以有不同的网络地址，各个微服务之间通过互相调用完成用户请求，客户端可能通过调用N个微服务的接口完成一个用户请求。
• 存在的问题：

	1.客户端多次请求不同的微服务，增加客户端的复杂性
	2.认证复杂，每个服务都要进行认证
	3.http请求不同服务次数增加，性能不高

• 网关就是系统的入口，封装了应用程序的内部结构，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、缓存、负载均衡、流量管控、路由转发等
• 在目前的网关解决方案里，有Nginx+ Lua、Netflix Zuul 、Spring Cloud Gateway等等
  

网关的核心功能是：路由和过滤（鉴权）

快速入门

1. 搭建网关模块

   创建api-gateway模块

2. 引入依赖：starter-gateway

   <dependencies>
       <!--引入gateway 网关-->
       <dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-starter-gateway</artifactId>
       </dependency>
   </dependencies>
   

3. 编写启动类

   package cn.itcast.gateway;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   public class ApiGatewayApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(ApiGatewayApplication.class,args);
       }
   
   }
   
   

4. 编写配置文件

   application.yml

   server:
     port: 10010
   spring:
     application:
       name: api-gateway
     cloud:
       # 网关配置
       gateway:
         # 路由配置：转发规则
         routes: #集合。
         # id: 唯一标识。默认是一个UUID
         # uri: 转发路径
         # predicates: 条件,用于请求网关路径的匹配规则
         - id: userservice
           uri: http://localhost:8081/
           predicates:
           - Path=/user/**
   
   

5. 启动测试 , 访问 http://localhost:10010/user/2

Gateway-静态路由

application.yml 中的uri是写死的，就是静态路由

Gateway-动态路由

添加注册中心Eureka

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

application.yml 中添加注册中心地址及修改uri属性：uri: lb://服务名称

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    # 网关配置
    gateway:
      # 路由配置：转发规则
      routes: #集合。
      # id: 唯一标识。默认是一个UUID
      # uri: 转发路径
      # predicates: 条件,用于请求网关路径的匹配规则
      - id: user-service
        uri: lb://userservice
        predicates:
        - Path=/user/**
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka

Gateway-过滤器

过滤器-概述

• Gateway 支持过滤器功能，对请求或响应进行拦截，完成一些通用操作。

• Gateway 提供两种过滤器方式：“pre”和“post”

  ? pre 过滤器，在转发之前执行，可以做参数校验、权限校验、流量监控、日志输出、协议转换等。
  ? post 过滤器，在后端微服务响应之后并且给前端响应之前执行，可以做响应内容、响应头的修改，日志的输出，流量监控等。

• Gateway 还提供了两种类型过滤器
  GatewayFilter：局部过滤器，针对单个路由
  GlobalFilter ：全局过滤器，针对所有路由
  

局部过滤器(GatewayFilter )（了解）

• GatewayFilter 局部过滤器，是针对单个路由的过滤器。
• 在Spring Cloud Gateway 组件中提供了大量内置的局部过滤器，对请求和响应做过滤操作。
• 遵循约定大于配置的思想，只需要在配置文件配置局部过滤器名称，并为其指定对应的值，就可以让其生效。

? 例举部分内置的局部过滤

修改配置 application.yml

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    # 网关配置
    gateway:
      # 路由配置：转发规则
      routes: #集合。
        # id: 唯一标识。默认是一个UUID
        # uri: 转发路径
        # predicates: 条件,用于请求网关路径的匹配规则
        - id: user-service
          uri: lb://userservice
          predicates:
            - Path=/user/**
          filters:
            - AddRequestParameter=name,admin
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka

在user-service模块的UserController中添加方法

@GetMapping("/getUser")
public String getUser(String name) {
    String result = "name ="+name+"----"+new Date();
    return result;
}

重启user-service微服务和网关后

全局过滤器

• GlobalFilter 全局过滤器，不需要在配置文件中配置，系统初始化时加载，并作用在每个路由上。
• Spring Cloud Gateway 核心的功能也是通过内置的全局过滤器来完成。
• 自定义全局过滤器步骤：
  1. 定义类实现 GlobalFilter 和 Ordered接口
  2. 复写方法
  3. 完成逻辑处理

实现的业务：

请求参数中带有token 内容，就放行，否则提示未授权返回403状态码

MyGlobaFilter

package cn.itcast.gateway.filter;

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

import java.util.List;

/**
 * 自定义全局过滤器
 */
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {

    /**
     * 需求 ：请求参数中带有token 内容，就放行，否则提示未授权
     * @param exchange
     * @param chain
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        System.out.println("自定义全局过滤器-执行-----");
//        获取请求对象
        ServerHttpRequest request = exchange.getRequest();
//        获取参数
        MultiValueMap<String, String> valueMap = request.getQueryParams();
        List<String> valList = valueMap.get("token");
        if(CollectionUtils.isEmpty(valList)){
//            异常情况，没有token参数
            // 获取响应对象
            ServerHttpResponse response = exchange.getResponse();
            // 返回响应码
            response.setStatusCode(HttpStatus.FORBIDDEN);
            // 完成响应
            return response.setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

创作打卡挑战赛

赢取流量/现金/CSDN周边激励大奖