Spring Cloud Gateway编码实现任意地址跳转的示例

更新时间:2023-04-04 02:41:27 阅读：评论：0

本篇概览

作为《spring cloud gateway实战》系列的第十四篇，本文会继续发掘spring cloud gateway的潜力，通过编码体验操控网关的乐趣，开发出一个实用的功能：让spring cloud gateway应用在收到请求后，可以按照业务的需要跳转到任意的地址去

一般路由规则

先来看一个普通的路由规则，如下所示，意思是将所有/hello/**的请求转发到http://127.0.0.1:8082这个地址去：

spring:  application:    name: hello-gateway  cloud:    gateway:      routes:        - id: path_route          uri: http://127.0.0.1:8082          predicates:          - path=/hello/**

上述规则的功能如下图所示，假设这就是生产环境的样子，192.168.50.99:8082是提供服务的后台应用：

特殊规则

以上是常规情况，但也有些特殊情况，要求springcloud gateway把浏览器的请求转发到不同的服务上去

如下图所示，在之前的环境中增加了另一个服务（即蓝色块），假设蓝色服务代表测试环境

浏览器发起的/hello/str请求中，如果header中带有tag-test-ur，并且值等于true，此时要求springcloud gateway把这个请求转发到测试环境

如果浏览器的请求header中没有tag-test-ur，springcloud gateway需要像以前那样继续转发到192.168.50.99:8082

很明显，上述需求难以通过配置来实现，因为转发的地址和转发逻辑都是围绕业务逻辑来定制的，这也就是本篇的目标：对同一个请求path，可以通过编码转发到不同的地方去

实现上述功能的具体做法是：自定义过滤器

设计

编码之前先设计，把关键点想清楚再动手今天咱们要开发一个springcloud gateway应用，里面新增一个自定义过滤器实现这个功能需要三个知识点作为基础，也就是说，您会通过本篇实战掌握以下知识点：自定义过滤器自定义过滤器的配置参数和bean的映射编码构造route实例

用思维导图将具体工作内容展开，如下图所示，咱们就按部就班的实现吧：

源码下载

本篇实战中的完整源码可在github下载到，地址和链接信息bpmf教学ppt如下表所示(https://github.com/zq2599/blog_demos)：

名称链接备注项目主页https://github.com/zq2599/blog_demos该项目在github上的主页git仓库地址(https)https://github.com/zq2599/blog_demos.git该项目源码的仓库地址，https协议git仓库地址(ssh)git@github.com:zq2599/blog_demos.git该项目源码的仓库地址，ssh协议

这个git项目中有多个文件夹，本篇的源码在spring-cloud-tutorials文件夹下，如下图红框所示：

spring-cloud-tutorials内部有多个子项目，本篇的源码在gateway-dynamic-route文件夹下，如下图红框所示：

编码

新建名为gateway-dynamic-route的maven工程，其pom.xml内容如下：

<?xml version="1.0" encoding="utf-8"?><project xmlns="http://maven.apache.org/pom/4.0.0"         xmlns:xsi="/d/file/titlepic/xmlschema-instance"         xsi:schemalocation="http://maven.apache.org/pom/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <parent>        <artifactid>spring-cloud-tutorials</artifactid>        <groupid>com.bolingcavalry</groupid>        <version>1.0-snapshot</version>    </parent>    <modelversion>4.0.0</modelversion>    <artifactid>gateway-dynamic-route</artifactid>    <dependencies>        <dependency>            <groupid>com.bolingcavalry</groupid>            <artifactid>common</artifactid>            <version>${project.version}</version>        </dependency>        <dependency>            <groupid>org.springframework.cloud</groupid>            <artifactid>spring-cloud-starter-gateway</artifactid>        </dependency>    </dependencies>    <build>        <plugins>            <!-- 如果父工程不是springboot，就要用以下方式使用插件，才能生成正常的jar -->            <plugin>                <groupid>org.springframework.boot</groupid&微弱反义词gt;                <artifactid>spring-boot-maven-plugin</artifactid>                <configuration>                    <mainclass>com.bolingcavalry.gateway.gatewaydynamicrouteapplication</mainclass>                </configuration>                <executions>                    <execution>                        <goals>                            <goal7位>repackage</goal>                        </goals>                    </execution>                </executions>            </plugin>        </plugins>    </build></project>

启动类是普通的springboot启动类：

package com.bolingcavalry.gateway;import org.springframework.boot.springapplication;import org.springframework.boot.autoconfigure.springbootapplication;@springbootapplicationpublic class gatewaydynamicrouteapplication {    public static void main(string[] args) {        springapplication.run(gatewaydynamicrouteapplication.class,args);    }}

接下来是本篇的核心，自定义过滤器类，代码中已经添加了详细的注释，有几处要注意的地方稍后会提到：

上述代码中要注意的地方如下：

bizlogicrouteconfig是过滤器的配置类，可以在使用过滤器时在配置文件中配置prodenvuri和testenvuri的值，在代码中可以通过这两个字段取得配置值

过滤器的工厂类名为bizlogicroutegatewayfilterfactory，按照规则，过滤器的名字是bizlogicroute

package com.bolingcavalry.gateway.filter;import lombok.data;import lombok.tostring;import lombok.extern.slf4j.slf4j;import org.springframework.cloud.gateway.filter.gatewayfilter;import org.springframework.cloud.gateway.filter.factory.abstractgatewayfilterfactory;import org.springframework.cloud.gateway.route.route;import org.springframework.http.httpheaders;import org.springframework.http.httpmethod;import org.springframework.http.rver.reactive.rverhttprequest;import org.springframework.stereotype.component;import org.springframework.util.multivaluemap;import org.springframework.web.util.uricomponentsbuilder;import java.net.uri;import static org.springframework.cloud.gateway.support.rverwebexchangeutils.gateway_route_attr;@component@slf4jpublic class bizlogicroutegatewayfilterfactory extends abstractgatewayfilterfactory<bizlogicroutegatewayfilterfactory.bizlogicrouteconfig> {    private static final string tag_test_ur = "tag-test-ur";    public bizlogicroutegatewayfilterfactory() {        super(bizlogicrouteconfig.class);    }    @override    public gatewayfilter apply(bizlogicrouteconfig config) {        return (exchange, chain) -> {            // 本次的请求对象         小小粉刷匠   rverhttprequest request =新党章学习笔记  exchange.getrequest();            // 调用方请求时的path            string rawpath = request.geturi().getrawpath();            log.info("rawpath [{}]", rawpath);            // 请求头            httpheaders headers = request.getheaders();            // 请求方法            httpmethod httpmethod = request.getmethod();            // 请求参数            multivaluemap<string, string> queryparams = request.getqueryparams();            // 这就是定制的业务逻辑，istestur等于ture代表当前请求来自测试用户，需要被转发到测试环境            boolean istestur = fal;            // 如果header中有tag-test-ur这个key，并且值等于true(不区分大小写)，            // 就认为当前请求是测试用户发来的            if (headers.containskey(tag_test_ur)) {                string tagetestur = headers.get(tag_test_ur).get(0);                if ("true".equalsignoreca(tagetestur)) {                    istestur = true;                }            }            uri uri;            if (istestur) {                log.info("这是测试用户的请求");                // 从配置文件中得到测试环境的uri                uri = uricomponentsbuilder.fromhttpurl(config.gettestenvuri() + rawpath).queryparams(queryparams).build().touri();            } el {                log.info("这是普通用户的请求");                // 从配置文件中得到正式环境的uri                uri = uricomponentsbuilder.fromhttpurl(config.getprodenvuri() + rawpath).queryparams(queryparams).build().touri();            }            // 生成新的request对象，该对象放弃了常规路由配置中的spring.cloud.gateway.routes.uri字段            rverhttprequest rverhttprequest = request.mutate().uri(uri).method(httpmethod).headers(httpheaders -> httpheaders = httpheaders).build();            // 取出当前的route对象            route route = exchange.getattribute(gateway_route_attr);            //从新设置route地址            route newroute =                    route.async().asyncpredicate(route.getpredicate()).filters(route.getfilters()).id(route.getid())                            .order(route.getorder()).uri(uri).build();            // 放回exchange中            exchange.getattributes().put(gateway_route_attr,newroute);            // 链式处理，交给下一个过滤器            return chain.filter(exchange.mutate().request(rverhttprequest).build());        };    }    /**     * 这是过滤器的配置类，配置信息会保存在此处     */    @data    @tostring    public static class bizlogicrouteconfig {        // 生产环境的服务地址        private string prodenvuri;        // 测试环境的服务地址        private string testenvuri;    }}

在apply方法中，重新创建rverhttprequest和route对象，它们的参数可以按照业务需求随意设置，然后再将这两个对象设置给springcloud gateway的处理链中，接下来，处理链上的其他过滤拿到的就是新的rverhttprequest和route对象了

配置

假设生产环境地址是http://127.0.0.1:8082，测试环境地址是http://127.0.0.1:8087，整个springcloud gateway应用的配置文件如下，可见使用了刚刚创建的过滤器，并且为此过滤器配置了两个参数：

rver:  #服务端口  port: 8086spring:  application:    name: gateway-dynamic-route  cloud:    gateway:      routes:        - id: path_route          uri: http://0.0.0.0:8082          predicates:          - path=/hello/**          filters:            - name: bizlogicroute              args:                prodenvuri: http://127.0.0.1:8082                testenvuri: http://127.0.0.1:8087

至此，编码完成了，启动这个服务

开发和启动后台服务，模拟生产和测试环境

接下来开始验证功能是否生效，咱们要准备两个后台服务：

模拟生产环境的后台服务是provider-hello，监听端口是8082，其/hello/str接口的返回值是hello world, 2021-12-12 10:53:09

模拟测试环境的后台服务是provider-for-test-ur，监听端口是8087，其/hello/str接口的返回值是hello world, 2021-12-12 10:57:11 (from test enviroment)（和生产环境相比，返回内容多了个(from test enviroment)），对应controller参考如下：

package com.bolingcavalry.provider.controller;import com.bolingcavalry.common.constants;import org.springframework.web.bind.annotation.*;import java.text.simpledateformat;import java.util.date;import java.util.map;@restcontroller@requestmapping("/hello")public class hello {    private string datestr(){        return new simpledateformat("yyyy-mm-dd hh:mm:ss").format(new date());    }    /**     * 返回字符串类型     * @return     */    @getmapping("/str")    public string hellostr() {        return constants.hello_prefix + ", " + datestr() + " (from test enviroment)";    }}

以上两个服务，对应的代码都在我的github仓库中，如下图红框所示：

启动gateway-dynamic-route、provider-hello、provider-for-test-ur服务

此时，springcloud gateway应用和两个后台服务都启动完成，情况如下图，接下来验证刚才开发的过滤器能不能像预期那样转发：