详解SpringCloud Zuul过滤器返回值拦截

 更新时间:2018年06月12日 14:52:20   作者:cmlbeliever  
Zuul作为网关服务,是其他各服务对外中转站,通过Zuul进行请求转发。这篇文章主要介绍了详解SpringCloud Zuul过滤器返回值拦截,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

Zuul作为网关服务,是其他各服务对外中转站,通过Zuul进行请求转发。这就涉及到部分数据是不能原封返回的,比如服务之间通信的凭证,用户的加密信息等等。

举个例子,用户服务提供一个登录接口,用户名密码正确后返回一个Token,此Token作为用户服务的通行证,那么用户登录成功后返回的Token就需要进行加密或者防止篡改处理。在到达用户服务其他接口前,就需要对Token进行校验,非法的Token就不需要转发到用户服务中了,直接在网关层返回信息即可。

要修改服务返回的信息,需要使用的是Zuul的过滤器。使用时只需要继承ZuulFilter,实现必要的方法即可。

Zuul提供默认的四种过滤器类型,通过filterType方法进行标识

  1. pre:可以在请求被路由之前调用
  2. route:在路由请求时候被调用
  3. post:在route和error过滤器之后被调用
  4. error:处理请求时发生错误时被调用

过滤器执行的顺序是通过filterOrder方法进行排序,越小的值越优先处理。FilterConstants定义了一些列默认的过滤器的执行顺序和路由类型,大部分需要用到的常量都在这儿。

例子中说明的,只有登录接口需要拦截,所以只需要拦截登录请求(/user/login)即可。可以通过过滤器的shouldFilter方法进行判断是否需要拦截。

由于是在准发用户服务成功后进行的数据修改,所以拦截器的类型时post类型的。整个类的实现如下:

public class AuthResponseFilter extends AbstractZuulFilter {

 private static final String RESPONSE_KEY_TOKEN = "token";
 @Value("${system.config.authFilter.authUrl}")
 private String authUrl;
 @Value("${system.config.authFilter.tokenKey}")
 private String tokenKey = RESPONSE_KEY_TOKEN;

 @Autowired
 private AuthApi authApi;

 @Override
 public boolean shouldFilter() {
  RequestContext context = getCurrentContext();
  return StringUtils.equals(context.getRequest().getRequestURI().toString(), authUrl);
 }

 @Override
 public Object run() {

  try {
   RequestContext context = getCurrentContext();

   InputStream stream = context.getResponseDataStream();
   String body = StreamUtils.copyToString(stream, Charset.forName("UTF-8"));

   if (StringUtils.isNotBlank(body)) {
    Gson gson = new Gson();
    @SuppressWarnings("unchecked")
    Map<String, String> result = gson.fromJson(body, Map.class);
    if (StringUtils.isNotBlank(result.get(tokenKey))) {
     AuthModel authResult = authApi.encodeToken(result.get(tokenKey));
     if (authResult.getStatus() != HttpServletResponse.SC_OK) {
      throw new IllegalArgumentException(authResult.getErrMsg());
     }
     String accessToken = authResult.getToken();
     result.put(tokenKey, accessToken);
    }
    body = gson.toJson(result);
   }
   context.setResponseBody(body);
  } catch (IOException e) {
   rethrowRuntimeException(e);
  }
  return null;
 }

 @Override
 public String filterType() {
  return FilterConstants.POST_TYPE;
 }

 @Override
 public int filterOrder() {
  return FilterConstants.SEND_RESPONSE_FILTER_ORDER - 2;
 }

}

配置文件,中添加授权url和返回token的key:

system.config.authFilter.authUrl=/user/login
system.config.authFilter.tokenKey=token

context.setResponseBody(body);这段代码是核心,通过此方法修改返回数据。

当用户登录成功后,根据返回的token,通过授权服务进行token加密,这里加密方式使用的是JWT。防止用户篡改信息,非法的请求直接可以拦截在网关层。

关于Zuul过滤器的执行过程,这里不需要多说明,源码一看便知,ZuulServletFilter:

@Override
 public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
  try {
   init((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse);
   try {
    preRouting();
   } catch (ZuulException e) {
    error(e);
    postRouting();
    return;
   }

   // Only forward onto to the chain if a zuul response is not being sent
   if (!RequestContext.getCurrentContext().sendZuulResponse()) {
    filterChain.doFilter(servletRequest, servletResponse);
    return;
   }

   try {
    routing();
   } catch (ZuulException e) {
    error(e);
    postRouting();
    return;
   }
   try {
    postRouting();
   } catch (ZuulException e) {
    error(e);
    return;
   }
  } catch (Throwable e) {
   error(new ZuulException(e, 500, "UNCAUGHT_EXCEPTION_FROM_FILTER_" + e.getClass().getName()));
  } finally {
   RequestContext.getCurrentContext().unset();
  }
 }

方法说明:

  1. preRoute:执行pre类型的过滤器
  2. postRoute:执行post类型的过滤器
  3. route:执行route类型的过滤器
  4. error:执行error类型的过滤器

通过context.setSendZuulResponse(false)可以终止请求的转发,但是只在pre类型的过滤器中设置才可以。

关于如何终止过滤器:

只有pre类型的过滤器支持终止转发,其他过滤器都是按照顺序执行的,而且pre类型的过滤器也只有在所有pre过滤器执行完后才可以终止转发,做不到终止过滤器继续执行。看ZuulServletFilter源码代码:

  // Only forward onto to the chain if a zuul response is not being sent
   if (!RequestContext.getCurrentContext().sendZuulResponse()) {
    filterChain.doFilter(servletRequest, servletResponse);
    return;
   }

本文中的代码已提交至: https://gitee.com/cmlbeliever/springcloud 欢迎Star

实现类在:api-getway工程下的com.cml.springcloud.api.filter.AuthResponseFilter

本地地址:http://xz.jb51.net:81/201806/yuanma/cmlbeliever-springcloud_jb51.rar

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 解决mybatis 数据库date 与 java中Date类型映射问题

    解决mybatis 数据库date 与 java中Date类型映射问题

    这篇文章主要介绍了解决mybatis 数据库date 与 java中Date类型映射问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来吧
    2020-11-11
  • 使用Netty解决TCP粘包和拆包问题过程详解

    使用Netty解决TCP粘包和拆包问题过程详解

    这篇文章主要介绍了使用Netty解决TCP粘包和拆包问题过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-07-07
  • Java使用excel工具类导出对象功能示例

    Java使用excel工具类导出对象功能示例

    这篇文章主要介绍了Java使用excel工具类导出对象功能,结合实例形式分析了java创建及导出Excel数据的具体步骤与相关操作技巧,需要的朋友可以参考下
    2017-10-10
  • Java CompletableFuture 异步超时实现深入研究

    Java CompletableFuture 异步超时实现深入研究

    这篇文章主要为大家介绍了Java CompletableFuture 异步超时实现深入研究,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • java实现砸金蛋抽奖功能

    java实现砸金蛋抽奖功能

    这篇文章主要为大家详细介绍了java实现砸金蛋抽奖功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-11-11
  • 聊聊spring继承的问题

    聊聊spring继承的问题

    这篇文章主要介绍了spring继承的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Java设计模式之创建者模式简介

    Java设计模式之创建者模式简介

    这篇文章主要介绍了Java设计模式之创建者模式,需要的朋友可以参考下
    2014-07-07
  • servlet3新特性_动力节点Java学院整理

    servlet3新特性_动力节点Java学院整理

    这篇文章主要为大家详细介绍了servlet3新特性的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • Spring Boot 单元测试JUnit的实践

    Spring Boot 单元测试JUnit的实践

    JUnit是一款优秀的开源Java单元测试框架,也是目前使用率最高最流行的测试框架,这篇文章主要介绍了Spring Boot 单元测试JUnit的实践,感兴趣的小伙伴们可以参考一下
    2018-11-11
  • Java的ThreadContext类加载器的实现

    Java的ThreadContext类加载器的实现

    这篇文章主要介绍了Java的ThreadContext类加载器的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06

最新评论