SpringCloud教程 | 七.服务过滤zuul

朱雀 2021-09-26 11:28 280阅读 0赞

【说明】本篇博客建立在上一篇的基础之上，上篇博客请参考

在完成了服务路由之后，我们对外开放服务还需要一些安全措施来保护客户端只能访问它应该访问到的资源。所以我们需要利用Zuul的过滤器来实现我们对外服务的安全控制。  
  
在服务网关中定义过滤器只需要继承ZuulFilter抽象类实现其定义的四个抽象函数就可对请求进行拦截与过滤。  
比如下面的例子，定义了一个Zuul过滤器，实现了在请求被路由之前检查请求中是否有accessToken参数，若有就进行路由，若没有就拒绝访问，返回401 Unauthorized错误。

import javax.servlet.http.HttpServletRequest;
    import org.apache.log4j.Logger;
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    
    /** 
    * @FileName AccessFilter.java
    * @Description:TODO
    * @author JackHisen(gu.weidong)
    * @version V1.0
    * @createtime 2018年1月26日 下午2:20:09 
    * 修改历史：
    * 时间           作者          版本        描述
    *====================================================  
    */
    public class AccessFilter extends ZuulFilter{
    	private static Logger log = Logger.getLogger(AccessFilter.class);
    
    
    	@Override
    	public Object run() {
    		RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
    
            log.info(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));
    
            Object accessToken = request.getParameter("accessToken");
            if(accessToken == null) {
                log.warn("access token is empty");
                ctx.setSendZuulResponse(false);
                ctx.setResponseStatusCode(401);
                return null;
            }
            log.info("access token ok");
            return null;
    	}
    
    	@Override
    	public boolean shouldFilter() {
    		// TODO Auto-generated method stub
    		return true;
    	}
    
    	@Override
    	public int filterOrder() {
    		// TODO Auto-generated method stub
    		return 0;
    	}
    
    	@Override
    	public String filterType() {
    		// TODO Auto-generated method stub
    		return "pre";
    	}
    }

filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：  
pre：路由之前  
routing：路由之时  
post： 路由之后  
error：发送错误调用

filterOrder：通过int值来定义过滤器的执行顺序  
shouldFilter：返回一个boolean类型来判断该过滤器是否要执行，所以通过此函数可实现过滤器的开关。在上例中，我们直接返回true，所以该过滤器总是生效。  
run：过滤器的具体逻辑。需要注意，这里我们通过ctx.setSendZuulResponse(false)令zuul过滤该请求，不对其进行路由，然后通过ctx.setResponseStatusCode(401)设置了其返回的错误码，当然我们也可以进一步优化我们的返回，比如，通过ctx.setResponseBody(body)对返回body内容进行编辑等。

在实现了自定义过滤器之后，还需要实例化该过滤器才能生效，我们只需要在应用启动类中增加如下内容：

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    import org.springframework.context.annotation.Bean;
    import com.aikucun.Filter.AccessFilter;
    
    @EnableZuulProxy
    @SpringBootApplication
    @EnableEurekaClient
    public class SpringCloudEurekaZuulApplication {
    	public static void main(String[] args) {
    		SpringApplication.run(SpringCloudEurekaZuulApplication.class, args);
    	}
    	@Bean
    	public AccessFilter accessFilter() {
    		return new AccessFilter();
    	}
    }

application.properties除了配置log外无任何变动

eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka
    spring.application.name=eureka-zuul
    zuul.routes.api-a.path=/api-a-url/**
    #zuul.routes.api-a-url.url=http://localhost:2002/dc
    zuul.routes.api-a.serviceId=eureka-client
    logging.file=/log/springcloud-zuul.log

测试结果如下

![SouthEast][]

[SouthEast]: /images/20210923/13fef7bd52f64331aace987133ff557a.png