ZULL-zull过滤器和动态路由

1:zull过滤器

1：zull过滤器介绍

Zuul 中的过滤器跟我们之前使用的 javax.servlet.Filter 不一样，javax.servlet.Filter 只有一种类型，可以通过配置 urlPatterns 来拦截对应的请求。

而 Zuul 中的过滤器总共有 4 种类型，且每种类型都有对应的使用场景。

1. pre：可以在请求被路由之前调用。适用于身份认证的场景，认证通过后再继续执行下面的流程
2. route：在路由请求时被调用。适用于灰度发布场景，在将要路由的时候可以做一些自定义的逻辑
3. post：在 route 和 error 过滤器之后被调用。这种过滤器将请求路由到达具体的服务之后执行。适用于需要添加响应头，记录响应日志等应用场景。
4. error：处理请求时发生错误时被调用。在执行过程中发送错误时会进入 error 过滤器，可以用来统一记录错误信息。
   
   如上所示，这是zullFilter的执行过程；请求发过来首先到 pre 过滤器，再到 routing 过滤器，最后到 post 过滤器，任何一个过滤器有异常都会进入 error 过滤器。
   

2：zull过滤器源码

ZuulServlet 源码如下,从源码可以看出zull过滤器的生命周期；

@Override
public void service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
        throws ServletException, IOException {
    try {
        init((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse);
        RequestContext context = RequestContext.getCurrentContext();
        context.setZuulEngineRan();
        try {
            preRoute();
        } catch (ZuulException e) {
            error(e);
            postRoute();
            return;
        }
        try {
            route();
        } catch (ZuulException e) {
            error(e);
            postRoute();
            return;
        }
        try {
            postRoute();
        } catch (ZuulException e) {
            error(e);
            return;
        }
    } catch (Throwable e) {
        error(new ZuulException(e, 500, "UNHANDLED_EXCEPTION_" + e.getClass().getName()));
    } finally {
        RequestContext.getCurrentContext().unset();
    }
}

3:自定义过滤器步骤

写filter步骤。
1.继承zuulfilter
2.public boolean shouldFilter(0:true:执行此过滤器，false:不执行)
3.run：过滤器的业务逻辑
4.filterType pre,route,post,error
5.filter order:数字越小，越先执行

2：过滤器使用

1:使用过滤器来实现ip黑名单

public class IpFilter extends ZuulFilter {

    // IP黑名单列表
    private List<String> blackIpList = Arrays.asList("127.0.0.1");

    public IpFilter() {
        super();
    }

    @Override
    public boolean shouldFilter() {
        return true
    }

    @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) && blackIpList.contains(ip)) {

			//拦截不让往下走，还走剩下的过滤器，但是不向后面的服务转发。
            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;
    }
}

2:默认zull请求中的token不向后变服务传传

通过查看源码得知，默认这些东西zull都不会向后传，因为zull就是为了做鉴权的

如果想要向后传，只需要将sensitive-headers置为空

zuul:
  sensitive-headers:

3：动态路由装换

加入一个老项目改造，需要引入新的框架zull，但是我们曾经对外暴露过一个/test21接口，现在新的服务中我们定义为了/test2接口，那么可以使用zull来实现动态路由装换；也就是用户请求/test21接口，我们可以映射到/test2接口

package com.mashibing.cloudzuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

/**
 * Description:
 * Date:       2022/5/18 - 下午 6:50
 * author:     wangkanglu
 * version:    V1.0
 */
@Component
public class UrlMappingFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.ROUTE_TYPE;
    }

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

    /**
     * @return false 关闭该过滤器
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        String requestURI = request.getRequestURI();
        //用于截取服务名与访问地址
        requestURI = requestURI.substring(1);
        String[] urlPart = requestURI.split("/", 2);
        //这个是服务名，可以去其他地方（配置、db）获取
        String serviceId = urlPart[0];
        String sourceUrl = urlPart[1];

        Map<String, String> urlMapping = getUrlMapping();

        if (urlMapping != null && urlMapping.containsKey(sourceUrl)) {
            String targetUrl = urlMapping.get(sourceUrl);
            //上面的serviceId（微服务名）是从URL中截取的，如果需要访问其他serviceId就需要重新定义serviceId，替换成你需要访问的服务名，否则会爆404
            currentContext.set(FilterConstants.SERVICE_ID_KEY, serviceId);
            currentContext.set(FilterConstants.REQUEST_URI_KEY, targetUrl);
        }
        return null;
    }

    private Map<String, String> getUrlMapping() {
        // TODO: 2022/3/28  这里返回一个map映射关系,映射关系可以存库等,下面是我造的数据测试用
        HashMap hashMap = new HashMap();
        hashMap.put("test/sms-test31", "/test/sms-test3");
        hashMap.put("test/sms-test41", "/test/sms-test4");
        hashMap.put("test/sms-test51", "/test/sms-test5");
        return hashMap;
    }
}