GateWay ----服务网关

@太阳@

已于 2023-11-20 16:36:05 修改

阅读量211

点赞数 5

文章标签： gateway java 开发语言

于 2023-11-17 21:29:27 首次发布

本文链接：https://blog.csdn.net/2301_79262948/article/details/134468975

版权

一，网关的介绍

大家都都知道在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。

这样的架构，会存在着诸多的问题：

l 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性

l 认证复杂，每个服务都需要独立认证。

l 存在跨域请求，在一定场景下处理相对复杂。

上面的这些问题可以借助API网关来解决。

所谓的API网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发等等。添加上API网关之后，系统的架构图变成了如下所示：

在业界比较流行的网关，有下面这些：

l Ngnix+lua

使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用

lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本

l Kong

基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。

问题：

只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。

l Zuul

Netflflix开源的网关，功能丰富，使用JAVA开发，易于二次开发

问题：缺乏管控，无法动态配置；依赖组件较多；处理Http请求依赖的是Web容器，性能不如Nginx

l Spring Cloud Gateway

Spring公司为了替换Zuul而开发的网关服务，将在下面具体介绍。

注意：SpringCloud alibaba技术栈中并没有提供自己的网关，我们可以采用Spring Cloud Gateway来做网关

二Gateway 简介

Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。

优点：

l 性能强劲：是第一代网关Zuul的1.6倍

l 功能强大：内置了很多实用的功能，例如转发、监控、限流等

l 设计优雅，容易扩展

缺点：

l 其实现依赖Netty与WebFlux，不是传统的Servlet编程模型，学习成本高

l 不能将其部署在Tomcat、Jetty等Servlet容器里，只能打成jar包执行

l 需要Spring Boot 2.0及以上的版本，才支持

三 Gateway快速入门

要求: 通过浏览器访问api网关,然后通过网关将请求转发到商品微服务

先创建一个项目 sys-gateway(名字自己i随意)

1.创建一个api-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>

2.编写application.properties文件

3.设置启动类

启动之后去访问localhost：8848，出现以下的页面信息

4.修改配置文件

yml文件的写法

去浏览器浏览

4.书写路由的规则

四 Gateway核心架构

1.基本概念

路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:

l id，路由标识符，区别于其他 Route。唯一不写默认的唯一的值

l uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。

l order，用于多个 Route 之间的排序，数值越小排序越靠前，匹配优先级越高。

l predicate，断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。

l fifilter，过滤器用于修改请求和响应信息。

2.执行的流程

执行流程大体如下：

1. Gateway Client向Gateway Server发送请求

2. 请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文

3. 然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给 RoutePredicateHandlerMapping

4. RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用

5. 如果过断言成功，由FilteringWebHandler创建过滤器链并调用

6. 请求会一次经过PreFilter--微服务--PostFilter的方法，最终返回响应

3.断言

Predicate(断言, 谓词) 用于进行条件判断，只有断言都返回真，才会真正的执行路由。

断言就是说: 在 什么条件下 才能进行路由转发

1.内置路由断言的工厂

l 基于Datetime类型的断言工厂

此类型的断言根据时间做判断，主要有三个：

AfterRoutePredicateFactory：接收一个日期参数，判断请求日期是否晚于指定日期

BeforeRoutePredicateFactory：接收一个日期参数，判断请求日期是否早于指定日期

BetweenRoutePredicateFactory：接收两个日期参数，判断请求日期是否在指定时间段内

l 基于远程地址的断言工厂 RemoteAddrRoutePredicateFactory：

接收一个IP地址段，判断请求主机地址是否在地址段中

-RemoteAddr=192.168.1.24

l 基于Cookie的断言工厂

CookieRoutePredicateFactory：接收两个参数，cookie 名字和一个正则表达式。判断请求

cookie是否具有给定名称且值与正则表达式匹配。

-Cookie=chocolate, ch.

l 基于Header的断言工厂

HeaderRoutePredicateFactory：接收两个参数，标题名称和正则表达式。判断请求Header是否

具有给定名称且值与正则表达式匹配。

-Header=X-Request-Id, \d+

l 基于Host的断言工厂

HostRoutePredicateFactory：接收一个参数，主机名模式。判断请求的Host是否满足匹配规则。

-Host=**.testhost.org

l 基于Method请求方法的断言工厂

MethodRoutePredicateFactory：接收一个参数，判断请求类型是否跟指定的类型匹配。

-Method=GET

l 基于Path请求路径的断言工厂

PathRoutePredicateFactory：接收一个参数，判断请求的URI部分是否满足路径规则。

-Path=/foo/{segment}基于Query请求参数的断言工厂

QueryRoutePredicateFactory ：接收两个参数，请求param和正则表达式，判断请求参数是否具

有给定名称且值与正则表达式匹配。

内置的断言工厂在框架中是存在的我们是可以直接使用的

自定义的断言需要我自己编写

类名：age首字母大写

config文件

package com.bbb.config;//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//



import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;
import javax.validation.constraints.NotNull;

import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.cloud.gateway.handler.predicate.GatewayPredicate;
import org.springframework.http.HttpRequest;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.server.ServerWebExchange;
@Component
public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory<AgeRoutePredicateFactory.Config> {
    public static final String MIN_AGE = "minAge";
    public static final String MAX_AGE = "maxAge";

    public AgeRoutePredicateFactory() {
        super(Config.class);
    }

    public List<String> shortcutFieldOrder() {
        return Arrays.asList("minAge", "maxAge");
    }

    public Predicate<ServerWebExchange> apply(final Config config) {
       // Assert.isTrue(config.getDatetime1().isBefore(config.getDatetime2()), config.getDatetime1() + " must be before " + config.getDatetime2());
        return new GatewayPredicate() {
            public boolean test(ServerWebExchange serverWebExchange) {
                // 年龄是不是在最小值和最大值之间
                // age 作为一个参数传过来
                ServerHttpRequest request = serverWebExchange.getRequest();
                List<String> age = request.getQueryParams().get("age");
                System.out.println("________________________"+age);
                String s = age.get(0);
                int i = Integer.parseInt(s);
                // 》=minAge&&<=maxAge



                return i>=config.getMinAge()&&i<= config.getMaxAge(); // true   false
            }

//            public String toString() {
//                return String.format("Between: %s and %s", config.getDatetime1(), config.getDatetime2());
//            }
        };
    }

    @Validated
    public static class Config {
        private @NotNull Integer minAge;
        private @NotNull Integer maxAge;

        public Config() {
        }

        public Integer getMinAge() {
            return minAge;
        }

        public void setMinAge(Integer minAge) {
            this.minAge = minAge;
        }

        public Integer getMaxAge() {
            return maxAge;
        }

        public void setMaxAge(Integer maxAge) {
            this.maxAge = maxAge;
        }
    }
}

运行结果：在范围内可以得出，不在的话那就会出现错误

不在范围内的情况

五，过滤器

三个知识点:

1 作用: 过滤器就是在请求的传递过程中,对请求和响应做一些操作

2 生命周期: Pre Post

3 分类: 局部过滤器(作用在某一个路由上) 全局过滤器(作用全部路由上)

在Gateway中, Filter的生命周期只有两个：“pre” 和 “post”。

l PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

l POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

Gateway 的Filter从作用范围可分为两种: GatewayFilter与GlobalFilter。

l GatewayFilter：应用到单个路由或者一个分组的路由上。

l GlobalFilter：应用到所有的路由上。

1.内置局部过滤器

局部过滤器是只针对单个路由的过滤器

要同时运行sys-gateway和sys-order

2.全局过滤器

全局过滤器作用于所有路由, 无需配置。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。

1.自定义全局过滤器

内置的过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们自己编写过滤器来实现的，那么我们一起通过代码的形式自定义一个过滤器，去完成统一的认证校验。

下面的我们自定义一个GlobalFilter，去校验所有请求的请求参数中是否包含“token”，如何不包含请求参数“token”则不转发路由，否则执行正常的逻辑

自定义全局过滤器要求：必须实现GlobalFilter,Ordered接口

package com.bbb.filter;

import cn.hutool.json.JSONUtil;
import com.alibaba.cloud.commons.lang.StringUtils;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.io.UnsupportedEncodingException;
import java.util.HashMap;
import java.util.Map;
//自定义全局过滤器
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        /**
         * token
         * 有 放行
         * 没有 json数据  code 500  msg ”“ ，data:null
         */
        String token = exchange.getRequest().getHeaders().getFirst("token");
        // token不为空
        if(StringUtils.isNotBlank(token)){
            // 放行
          return  chain.filter(exchange);// 走下面的过滤器
        }else{
            // 返回json数据
            Map map =new HashMap<>();
            map.put("code",500);
            map.put("msg","错误！！！");
            map.put("data","sdfjdvhgs");
            // 转化为json数据   JSONUtil需要hutool依赖才可以使用
            String s = JSONUtil.toJsonStr(map);
            // 返回json数据
            ServerHttpResponse response = exchange.getResponse();
            //
//            Mono<Void> voidMono = response.setComplete();
            DataBuffer dataBuffer;
            try {
                byte[] bytes = s.getBytes("GBK");
                dataBuffer = response.bufferFactory().wrap(bytes);
            } catch (UnsupportedEncodingException e) {
                throw new RuntimeException(e);
            }
            return response.writeWith(Mono.just(dataBuffer));
        }
        //return null;
    }

    /**
     *
     * @return
     */

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

3.全局的异常处理

package com.bbb.globalexception;
import com.bbb.util.Result;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

//@ControllerAdvice
//@ResponseBody
//以上两个的注解用处与下面的注解都是一样的意思
@RestControllerAdvice

public class MyGlobalException {

    //
    @ExceptionHandler(Exception.class)
    public Result aaa(){
        return new Result(500,"除数为0","除数为0");
    }


}

访问结果展示

六.网关添加swagger

1.添加相关的jar包再父类项目中添加就行

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>

<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>

2.再service下每个子项目中创建一个config，然后放入其中swagger文件

package com.bbb.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {


    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)  // 文档的类型  swagger2
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bbb.controller")) // controller 所在的包是哪里
                .paths(PathSelectors.any()) // 所有的路径全部都写到接口文档里面
                .build();
    }


    /**
     * 文档的信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("服务:发布为daocke镜像,权限管理，用户管理，页面管理，日志 后台 APIs")
                .description("服务:发布为daocke镜像,权限管理，用户管理，页面管理，日志 后台")
                .termsOfServiceUrl("http://www.baidu.com") //代码的路径
                .contact("谢纪龙")
                .version("1.0")
                .build();
    }


}

3.运行三个子文件加上网关文件之后浏览器查询

4.再网关项目中添加一个config，以及一个swagger，之后需要添加jar包

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
<scope>compile</scope>
</dependency>

@太阳@

关注

5
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
GateWay ----服务网关

Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。
复制链接

扫一扫