如何通过zuul添加或修改请求参数

zuul添加或修改请求参数

一、为什么要用到这个

在基于 springcloud 构建的微服务系统中，通常使用网关zuul来进行一些用户验证等过滤的操作，比如 用户在 header 或者 url 参数中存放了 token ，网关层需要 用该 token 查出用户 的 userId ，并存放于 request 中，以便后续微服务可以直接使用而避免再去用 token 查询。

二、基础知识

在 zuul 中最大的用法的除了路由之外，就是过滤器了，自定义过滤器需实现接口 ZuulFilter ，在 run() 方法中，可以用

RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();

获取到 request，但是在 request 中只有 getParameter() 而没有 setParameter() 方法，所以直接修改 url 参数不可行，另外在 reqeust 中虽然可以使用 setAttribute() ,但是可能由于作用域的不同，在这里设置的 attribute 在后续的微服务中是获取不到的，因此必须考虑另外的方式。

三、具体做法

最后确定的可行的方法是，用

ctx.setRequest(new HttpServletRequestWrapper(request) {})

的方式，重新构造上下文中的 request ，代码如下：

// 例如在请求参数中添加 userId
try {
  InputStream in = ctx.getRequest().getInputStream();
  String body = StreamUtils.copyToString(in, Charset.forName("UTF-8"));
  if（StringUtils.isBlank(body)）{
    body = "{}";
  }
  JSONObject jsonObject = JSON.parseObject(body);
  jsonObject.put("userId", 666);
  String newBody = jsonObject.toString();
  final byte[] reqBodyBytes = newBody.getBytes();
  ctx.setRequest(new HttpServletRequestWrapper(request){    
    @Override
    public ServletInputStream getInputStream() throws IOException {
      return new ServletInputStreamWrapper(reqBodyBytes);
    }
    @Override
    public int getContentLength() {
      return reqBodyBytes.length;
    }
    @Override
    public long getContentLengthLong() {
      return reqBodyBytes.length;
    }
  });
} catch (IOException e) {
  e.printStackTrace();
}

思路就是，获取请求的输入流，并重写，即重写json参数。

在后续的微服务的 controller 中，通过下面的方式获取通过zuul添加或修改的请求参数。

InputStream in = request().getInputStream();
String body = StreamUtils.copyToString(in, Charset.forName("UTF-8"));
if（StringUtils.isNotBlank(body)）{
  JSONObject jsonObject = JSON.parseObject(body);
  Object userId = jsonObject.get("userId");
}

zuul修改请求url

除了修改请求参数、设置响应header，响应body外，还有一种需求就是url重新，或者是修改url，这里简述一下怎么在zuul修改url。

转发配置

demo:
  ribbon:
    NIWSServerListClassName: com.netflix.loadbalancer.ConfigurationBasedServerList
    listOfServers: 192.168.99.100,192.168.99.101
zuul:
  routes:
    demo:
      path: /demo/**
      stripPrefix: true
      serviceId: demo

filter配置

@Component
public class UrlPathFilter extends ZuulFilter{
    @Override
    public String filterType() {
        return FilterConstants.PRE_TYPE;
    }
    @Override
    public int filterOrder() {
        return FilterConstants.PRE_DECORATION_FILTER_ORDER + 1;
    }
    @Override
    public boolean shouldFilter() {
        final String serviceId = (String) RequestContext.getCurrentContext().get("proxy");
        return "demo".equals(serviceId);
    }
    @Override
    public Object run() {
        RequestContext context = RequestContext.getCurrentContext();
        Object originalRequestPath = context.get(FilterConstants.REQUEST_URI_KEY);
        //http://localhost:10000/demo/list/data
        //-->/api/prefix/list/data
        String modifiedRequestPath = "/api/prefix" + originalRequestPath;
        context.put(FilterConstants.REQUEST_URI_KEY, modifiedRequestPath);
        return null;
    }
}

这样就大功告成了！

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。