SpringCloud-Zuul过滤器

概述

Zuul的核心

    Filter是Zuul的核心，用来实现对外服务的控制。Filter的生命周期有4个，分别是“PRE”、“ROUTING”、“POST”、“ERROR”，整个生命周期可以用下图来表示。

Zuul过滤器的生命周期

Zuul大部分功能都是通过过滤器来实现的，这些过滤器类型对应于请求的典型生命周期。

    1）PRE： 这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
    2）ROUTING：这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并使用Apache HttpClient或Netfilx Ribbon请求微服务。
    3）POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
    4）ERROR：在其他阶段发生错误时执行该过滤器。

    除了默认的过滤器类型，Zuul还允许我们创建自定义的过滤器类型。例如，我们可以定制一种STATIC类型的过滤器，直接在Zuul中生成响应，而不将请求转发到后端的微服务。

Zuul中默认实现的Filter

类型	顺序	过滤器	功能
pre	-3	ServletDetectionFilter	标记处理Servlet的类型
pre	-2	Servlet30WrapperFilter	包装HttpServletRequest请求
pre	-1	FormBodyWrapperFilter	包装请求体
route	1	DebugFilter	标记调试标志
route	5	PreDecorationFilter	处理请求上下文供后续使用
route	10	RibbonRoutingFilter	serviceId请求转发
route	100	SimpleHostRoutingFilter	url请求转发
route	500	SendForwardFilter	forward请求转发
post	0	SendErrorFilter	处理有错误的请求响应
post	1000	SendResponseFilter	处理正常的请求响应

创建工程microservice-gateway-zuul-filter

pom.xml

microservice-gateway-zuul-filter/pom.xml

    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
     
    	<parent>
    		<groupId>com.itmuch.cloud</groupId>
    		<artifactId>microservice-spring-cloud</artifactId>
    		<version>0.0.1-SNAPSHOT</version>
    	</parent>
     
    	<artifactId>microservice-gateway-zuul-filter</artifactId>
    	<packaging>jar</packaging>
     
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    	</properties>
     
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-zuul</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-eureka</artifactId>
    		</dependency>
    	</dependencies>
     
    </project>

application.yml

spring:
  application:
    name: microservice-gateway-zuul
server:
  port: 8040
eureka:
  client:
    service-url:
      defaultZone: http://user:password123@localhost:8761/eureka
  instance:
    prefer-ip-address: true
    
    
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 60000
ribbon:
  ConnectTimeout: 3000
  ReadTimeout: 60000

PreZuulFilter

com.itmuch.cloud.PreZuulFilter

    package com.itmuch.cloud;
     
    import javax.servlet.http.HttpServletRequest;
     
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
     
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
     
    public class PreZuulFilter extends ZuulFilter {
      private static final Logger LOGGER = LoggerFactory.getLogger(PreZuulFilter.class);
     
      @Override
      public boolean shouldFilter() {
        //表示是否需要执行该filter，true表示执行，false表示不执行
        return true;
      }
     
      @Override
      public Object run() {
        //filter需要执行的具体操作
        
        HttpServletRequest request = RequestContext.getCurrentContext().getRequest();
        String host = request.getRemoteHost();
        PreZuulFilter.LOGGER.info("请求的host:{}", host);
        return null;
      }
     
      @Override
      public String filterType() {
        //定义filter的类型，有pre、route、post、error四种
        return "pre";
      }
     
      @Override
      public int filterOrder() {
        //定义filter的顺序，数字越小表示顺序越高，越先执行
        return 1;
      }
     
    }

说明：

    1）filterType：返回过滤器的类型。有pre、route、post、error等几种取值，分别对应上文的几种过滤器。详细可以参考com.netflix.zuul.ZuulFilter.filterType() 中的注释。
    2）filterOrder：返回一个int值来指定过滤器的执行顺序，不同的过滤器允许返回相同的数字。
    3）shouldFilter：返回一个boolean值来判断该过滤器是否要执行，true表示执行，false表示不执行。
    4）run：过滤器的具体逻辑。本例中，我们让它打印了请求的HTTP方法以及请求的地址。

ZuulApplication

com.itmuch.cloud.ZuulApplication

    package com.itmuch.cloud;
     
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    import org.springframework.context.annotation.Bean;
     
    @SpringBootApplication
    @EnableZuulProxy
    public class ZuulApplication {
      public static void main(String[] args) {
        SpringApplication.run(ZuulApplication.class, args);
      }
     
      @Bean
      public PreZuulFilter preZuulFilter() {
        return new PreZuulFilter();
      }
    }

测试

查看服务

通过zuul访问

http://192.168.1.102:8040/microservice-consumer-movie-ribbon/movie/1

控制输出

2018-07-15 08:05:36.549  INFO 48544 --- [io-8040-exec-10] com.itmuch.cloud.PreZuulFilter           : 请求的host:192.168.1.102

==============================

QQ群：143522604

群里有相关资源

欢迎和大家一起学习、交流、提升！

==============================