首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Spring cloud Zuul Filter 使用小经验

Spring cloud Zuul Filter 使用小经验

作者头像
猿天地
发布2018-04-03 12:52:15
1.1K0
发布2018-04-03 12:52:15
举报
文章被收录于专栏:猿天地猿天地

前言

Filter 我们用的比较多,大部分是Servlet中的Filter,通常我们用来做一些拦截,权限验证之类的工作。

今天介绍的Filter是Zuul中提供的,跟我们之前使用的Servlet Filter不太一样。

Zuul中提供Filter的作用有哪些,我觉得分为如下几点:

  • 网关是暴露在外面的,必须要进行权限控制
  • 可以针对服务做控制,在路由的时候处理,比如服务降级
  • 防止爬虫,利用Filter对请求进行过滤
  • 流量控制,只允许最高的并发量,保护后端的服务
  • 灰度发布,可以针对不用的用户进行路由来实现灰度

Filter种类

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

关于zuul的Filter的生命周期,见下图 [图片上传失败...(image-b7034c-1512716248121)]

使用

下面我们以一个IP黑名单过滤器来进行讲解

/**
 * IP黑名单限制过滤器
 *
 * @author yinjihuan
 * @create 2017-11-15 18:14
 **/
public class IpFilter extends ZuulFilter {

    @Autowired
    private BasicConf basicConf;

    public IpFilter() {
        super();
    }

    @Override
    public boolean shouldFilter() {
        RequestContext ctx = RequestContext.getCurrentContext();
        Object success = ctx.get("isSuccess");
        return success == null ? true : 
           Boolean.parseBoolean(success.toString());
    }

    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 1;
    }

    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        String ip = IpUtils.getIpAddr(ctx.getRequest());
        // 在黑名单中禁用
        if (StringUtils.isNotBlank(ip) && basicConf != null && basicConf.getIpStr().contains(ip)) {
            ctx.set("isSuccess", false);
            ctx.setSendZuulResponse(false);
            ResponseData data = ResponseData.fail("非法请求", ResponseCode.NO_AUTH_CODE.getCode());
            ctx.setResponseBody(JsonUtils.toJson(data));
            ctx.getResponse().setContentType("application/json; charset=utf-8");
            return null;
        }
        return null;
    }
}

最开始注入了一个BasicConf,这个是IP黑名单的配置信息,可以通过配置中心进行修改,动态生效的,详情请参考: https://github.com/yinjihuan/smconf

shouldFilter是决定这个过滤器需不需要执行,返回false则不执行,这个也可以利用配置中心来做,达到动态的开启关闭效果, 这边是通过上下文对象,获取一个isSuccess的值来决定要不要执行的,就是说由上个过滤器告诉你要不要执行,因为上面的流程没通过,所以下面也没必要继续执行了。

filterType就是过滤器的类型了,取值分别为pre,route,post,error

filterOrder是表示过滤器执行的顺序,数字越小,优先级越高

run里面就是我们自己要执行的业务逻辑了,可以直接返回null,这个值没啥用

上面如果说当前请求的IP在黑名单中,就进行拦截操作,首先告诉下个Filter不需要执行了,通过ctx.set("isSuccess", false);

告诉zuul不需要将当前请求转发到后端的服务了,通过设置ctx.setSendZuulResponse(false);

然后组装统一的返回格式告诉调用方,这个是非法请求

上面我们就是利用pre过滤器在执行转发前进行非法IP的判断,其余的过滤器使用方法和上面一样,这是不同的类型执行的时期不一样

最后别忘了配置过滤器,不然是不会生效的

@Configuration
public class FilterConfig {

    @Bean
    public IpFilter ipFilter() {
        return new IpFilter();
    }

}

具体代码可以参考我的github:

https://github.com/yinjihuan/spring-cloud

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2017-12-10,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 猿天地 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • Filter种类
  • 使用
相关产品与服务
微服务引擎 TSE
微服务引擎(Tencent Cloud Service Engine)提供开箱即用的云上全场景微服务解决方案。支持开源增强的云原生注册配置中心(Zookeeper、Nacos 和 Apollo),北极星网格(腾讯自研并开源的 PolarisMesh)、云原生 API 网关(Kong)以及微服务应用托管的弹性微服务平台。微服务引擎完全兼容开源版本的使用方式,在功能、可用性和可运维性等多个方面进行增强。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档