SpringCloud系列-集成Zuul

SpringCloud集成Zuul遇到不少坑，特此记录一下，也希望能给大家借鉴一下

1. 在zuul网关module内添加依赖

   <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
   </dependency>
   

2. 启动类添加@EnableZuulProxy注解

   @EnableEurekaClient
   @EnableZuulProxy
   @SpringBootApplication
   public class ZuulApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(ZuulApplication.class, args);
       }
   
   }

3. application.properties配置

   # 服务端口
   server.port=8080
   # 服务名
   spring.application.name=zuul-server
   
   #服务路径名 order-server为路径名称可以随便起，这里与服务提供者服务名相同
   zuul.routes.order-server.path=/zuulorder/**
   #服务提供者服务名，path的访问会转到该服务，第一个order-server为路径名称，同上。第二个order-server为服务提供者服务名，需要与其保持一致
   zuul.routes.order-server.service-id=order-server
   
   #注册中心地址
   eureka.client.service-url.defaultZone=http://peer1:8661/eureka/
   
   #ribbon 超时时间设置，不设置此项有可能会出现超时错误，但实际已经可以访问
   #ribbon.ReadTimeout=1000
   #ribbon.SocketTimeout=1000

4. 测试结果

   

    

5. 新建ZuulFilter实现类，来实现过滤器（经过测试，需要注意filterType返回值必须要小写）

   package com.example.zuul.filter;

   import com.netflix.zuul.ZuulFilter;
   import com.netflix.zuul.context.RequestContext;
   import com.netflix.zuul.exception.ZuulException;
   import org.springframework.util.StringUtils;

   import javax.servlet.http.HttpServletRequest;

   public class TokenFilter extends ZuulFilter {

       /**
        * 过滤器类型
        * PRE：这种过滤器在请求被路由调用之前调用。我们可利用这种过滤器实现身份验证、再集群中选择请求的微服务、记录调试信息等。
        * ROUTING：这种过滤器将请求路由到微服务。用于构建发送给微服务的请求，并使用Apache HttpClient或Netflix Ribbon构建和发送原始HTTP请求的位置。
        * POST：请求在路由到微服务之后执行。示例包括向响应添加标准HTTP标头、收集统计信息和指标、以及将响应从源传输到客户端。
        * ERROR：过滤器在其中一个阶段发生错误时执行
        *
        * @return
        */
       @Override
       public String filterType() {
           return FilterConstants.PRE_TYPE;
       } 

       /**
        * 过滤器执行顺序
        * 当一个请求在同一个阶段存在多个过滤器的时候 过滤器的执行顺序
        */
       @Override
       public int filterOrder() {
           return 0;
       }

       /**
        * 是否开启过滤
        */
       @Override
       public boolean shouldFilter() {
           return true;
       }

       /**
        * 编写过滤器拦截业务逻辑代码
        */
       @Override
       public Object run() throws ZuulException {
           RequestContext requestContext =  RequestContext.getCurrentContext();
           HttpServletRequest request = requestContext.getRequest();
           String token = request.getParameter("token");
           if (StringUtils.isEmpty(token)) {
               requestContext.setSendZuulResponse(false);
               requestContext.setResponseBody("token is null");
               requestContext.setResponseStatusCode(401);
           }

           return null;
       }
   }
    

6. 启动类实例化ZuulFilter

   @EnableEurekaClient
   @EnableZuulProxy
   @SpringBootApplication
   public class ZuulApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(ZuulApplication.class, args);
       }
   
       @Bean
       TokenFilter tokenFilter() {
           return new TokenFilter();
       }
   }

7. 拦截成功

   

还是挺简单的吧，有不对的地方还请指正。