gateway

星晨鱼

已于 2023-05-22 09:06:34 修改

阅读量112

点赞数

文章标签： java spring cloud 微服务

于 2023-05-15 10:59:28 首次发布

本文链接：https://blog.csdn.net/xcyxqt/article/details/130680073

版权

一、gateway网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关。

它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

二、为什么需要网关

网关类似于一个门卫的作用，它是所有微服务的统一入口，具备下面的功能
- 请求路由：
  
  网关是微服务的入口，可以校验用户是否拥有访问的资格，并对没有资格的访问进行拦截。
- 权限控制：
  
  网关并不处理业务，但是所有的微服务都会经过网关，所以网关可以通过一定的规则将
  
  请求转发到微服务中，这个过程叫做路由。
- 负载均衡：
  
  当路由的目标服务有多个时，可以使用负载均衡。
- 限流：
  
  当请求流量过高时，在网关中按照下游微服务可以接受的最大速度来放行请求，
  
  避免服务的压力过大。
在SpringCloud中，网关包括gateway与zuul。
其中zuul是基于Servlet实现的，属于阻塞式编程。
gateway是基于spring5提供的webFlux实现的，属于响应式编程，具备更好的性能。

三、gateway快速入门

1，创建gateway网关微服务

在这里插入图片描述

2，引入依赖

<!-- gateway网关需要的依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!-- nacos服务发现依赖 -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

3，创建启动类

package com.itheima.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;

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

4，配置文件

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

上面的配置表示：

只要是以【/user】开头的路径，都会路由到服务名为userservice的微服务，

当名为userservice存在多个时，会负载均衡。

5，测试

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

四、断言工厂

通过配置文件书写断言规则，这些规则会被断言工厂【Predicate Factory】读取并处理，

转变为路由的判断条件。

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory

例如：

 - Path=/user/**
 # 一般而言，Path就够了

名称	说明	示例
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	权重处理

五、过滤器工厂

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

在这里插入图片描述

常见的路由过滤器

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

1，为某个微服务配置路由过滤器

# 表示所有对userservice的请求都会加上一个请求头
# key=【Truth】，value=【Itcast is freaking awesome!】
spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

2，为所有微服务配置过滤器

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

3，总结

过滤器是对请求与响应做加工处理，比如添加请求头【AddRequestHeader】
在当前路由下配置的过滤器只在当前路由下生效
使用【default-filters:】配置的过滤器会在所有路由下生效

六、全局过滤器

虽然上面的过滤器工厂提供的过滤器已经很好用了，但在使用上不免有些呆滞。

如果我们希望在过滤时能处理一些逻辑上的业务，可以使用全局过滤器。

gateway提供了GlobalFilter

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

1，自定义全局过滤器

// 参数中是否有key值为authorization，
// authorization参数值是否为admin

package cn.itcast.gateway.filters;

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.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.获取key值为authorization参数
        String auth = params.getFirst("authorization");
        // 3.校验
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.拦截
        // 4.1.禁止访问，设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.结束处理
        return exchange.getResponse().setComplete();
    }
}

2，路由器的执行顺序

使用@Order注解来指定order值；值越小，优先级越高。
当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

七、跨域问题

当协议，ip，端口有一个不同时，存在跨越问题

解决：在gateway网关的配置文件配置：

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求
            # 建议同时配置localhost与127.0.0.1
            # http://localhos/80，80可以省略，其他不能
              - "http://localhost"
              - "http://127.0.0.1"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

星晨鱼

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
gateway

过滤器是对请求与响应做加工处理，比如添加请求头【AddRequestHeader】在当前路由下配置的过滤器只在当前路由下生效使用【default-filters:】配置的过滤器会在所有路由下生效// 参数中是否有key值为authorization， // authorization参数值是否为admin package cn . itcast . gateway . filters;
复制链接

扫一扫