Spring Cloud(6) Zuul - 自定义Filter

目标

• 学习Zuul过滤器使用
• filter配置说明

自定义filter实现

api模块增加MyFilter，用于accessToken请求参数校验

@Component
public class MyFilter extends ZuulFilter {
    
    @Override
    public String filterType() {
        return "pre";
    }

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

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();

        System.out.println(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));

        Object accessToken = request.getParameter("accessToken");
        if(accessToken == null) {
            System.out.println("access token is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            return null;
        }
        System.out.println("access token ok");
        return null;
    }
}

重启api模块

访问 http://localhost:6001/account/userInfo

image.png

日志输出
GET request to http://localhost:6001/account/userInfo
access token is empty

访问 http://localhost:6001/account/userInfo?accessToken=testToken

image.png

日志输出
GET request to http://localhost:6001/account/userInfo
access token ok

filter配置说明

filterType

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

如论如何，post类型的过滤器总是会被调用

filterOrder

通过int值来定义过滤器的执行顺序

shouldFilter

返回一个boolean类型来判断该过滤器是否要执行，所以通过此函数可实现过滤器的开关。在上例中，我们直接返回true，所以该过滤器总是生效

run

过滤器的具体逻辑
需要注意，这里我们通过ctx.setSendZuulResponse(false)令zuul过滤该请求，不对其进行路由，然后通过ctx.setResponseStatusCode(401)设置了其返回的错误码