用好Spring Cloud Gateway，让请求和响应内容想怎么改就怎么改！

2024-02-07 07:41:18

前言

各位小伙伴们好，今天咱们就来聊聊如何用Spring Cloud Gateway修改原始请求和响应内容，以及修改过程中遇到的问题。首先是修改请求body，如下图所示，浏览器是请求发起方，真实参数只有user-id，经过网关时，由gateway将真实参数user-id替换为user-name：

[图片]

然后是修改响应body，网关将真实响应中包含敏感信息的字段敏感字段的值替换为脱敏后值：

[图片]

修改请求body

在Spring Cloud Gateway中，我们可以通过过滤器工厂来实现请求body的修改。首先，我们需要定义一个过滤器工厂，然后在过滤器工厂中实现修改请求body的逻辑。这里，我们使用了一个名为RequestBodyFilter的过滤器工厂：

@Component
public class RequestBodyFilter implements FilterFactory<RequestBodyGatewayFilterFactory.Config> {

    @Override
    public GatewayFilter apply(RequestBodyGatewayFilterFactory.Config config) {
        return (exchange, chain) -> {
            // 获取请求body
            String body = exchange.getRequest().getBodyAsString();

            // 修改请求body
            String modifiedBody = modifyRequestBody(body);

            // 设置修改后的请求body
            exchange.getRequest().mutate().body(modifiedBody);

            // 继续执行下一个过滤器
            return chain.filter(exchange);
        };
    }

    private String modifyRequestBody(String body) {
        // 在这里实现修改请求body的逻辑

        // 这里只是简单地将user-id替换为user-name
        return body.replace("user-id", "user-name");
    }

}

然后，我们需要在Spring Cloud Gateway的配置文件中配置RequestBodyFilter过滤器工厂：

spring:
  cloud:
    gateway:
      routes:
        - id: my-route
          uri: http://localhost:8080
          filters:
            - RequestBodyFilter

配置完成后，我们就可以通过网关修改请求body了。

修改响应body

在Spring Cloud Gateway中，我们可以通过过滤器工厂来实现响应body的修改。首先，我们需要定义一个过滤器工厂，然后在过滤器工厂中实现修改响应body的逻辑。这里，我们使用了一个名为ResponseBodyFilter的过滤器工厂：

@Component
public class ResponseBodyFilter implements FilterFactory<ResponseBodyGatewayFilterFactory.Config> {

    @Override
    public GatewayFilter apply(ResponseBodyGatewayFilterFactory.Config config) {
        return (exchange, chain) -> {
            // 获取响应body
            String body = exchange.getResponse().getBodyAsString();

            // 修改响应body
            String modifiedBody = modifyResponseBody(body);

            // 设置修改后的响应body
            exchange.getResponse().mutate().body(modifiedBody);

            // 继续执行下一个过滤器
            return chain.filter(exchange);
        };
    }

    private String modifyResponseBody(String body) {
        // 在这里实现修改响应body的逻辑

        // 这里只是简单地将敏感字段的值替换为脱敏后值
        return body.replace("sensitive-field", "desensitized-value");
    }

}

然后，我们需要在Spring Cloud Gateway的配置文件中配置ResponseBodyFilter过滤器工厂：

spring:
  cloud:
    gateway:
      routes:
        - id: my-route
          uri: http://localhost:8080
          filters:
            - ResponseBodyFilter

配置完成后，我们就可以通过网关修改响应body了。

修改过程中遇到的问题

在修改请求body和响应body的过程中，我们可能会遇到一些问题。这里列举一些常见问题及其解决方案：

修改请求body时，请求体为空

如果修改请求body时，请求体为空，则需要检查是否正确配置了RequestBodyFilter过滤器工厂。同时，还需要检查请求体是否正确设置了Content-Type头。
修改响应body时，响应体为空

如果修改响应body时，响应体为空，则需要检查是否正确配置了ResponseBodyFilter过滤器工厂。同时，还需要检查响应体是否正确设置了Content-Type头。
修改请求body或响应body后，服务端接收到的请求或响应与预期不符

如果修改请求body或响应body后，服务端接收到的请求或响应与预期不符，则需要检查过滤器工厂中修改请求body或响应body的逻辑是否正确。同时，还需要检查过滤器工厂是否正确配置。