SpringCloud Zuul 网关 过滤器的使用

1 SpringCloud Zuul网关介绍

Spring Cloud Zuul是整合Netflix公司的Zuul开源项目实现的微服务网关，它实现了请求路由、负载均衡、校验过

虑等功能。

什么是网关？

服务网关是在微服务前边设置一道屏障，请求先到服务网关，网关会对请求进行过虑、校验、路由等处理。有了服

务网关可以提高微服务的安全性，网关校验请求的合法性，请求不合法将被拦截，拒绝访问。

Zuul与Nginx怎么配合使用？

Zuul与Nginx在实际项目中需要配合使用，如下图，Nginx的作用是反向代理、负载均衡，Zuul的作用是保障微服

务的安全访问，拦截微服务请求，校验合法性及负载均衡。

2 Zuul工程搭建

实现流程图

创建好启动类 @EnableZuulProxy是Zuul网关

@SpringBootApplication
@EnableZuulProxy//此工程是一个zuul网关
public class GatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class, args);
    }
}
           

配置application.xml

zuul:
  routes:
    manage-course: #路由名称，名称任意，保持所有路由名称唯一
      path: /course/**
      serviceId: xc-service-manage-course #指定服务id，从Eureka中找到服务的ip和端口
      strip-prefix: false #true：代理转发时去掉前缀，false:代理转发时不去掉前缀
      sensitiveHeaders: #默认zuul会屏蔽cookie，cookie不会传到下游服务，这里设置为空则取消默认的黑名单，
      #如果设置了具体的头信息则不会传到下游服务
      #ignoredHeaders: Authorization 可以设置过虑的头信息，默认为空表示不过虑任何头
           

导入依赖

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

3定义过滤器

Zuul的核心就是过虑器，通过过虑器实现请求过虑，身份校验等。

自定义过虑器需要继承 ZuulFilter，ZuulFilter是一个抽象类，需要覆盖它的四个方法，如下：

1、 shouldFilter：返回一个Boolean值，判断该过滤器是否需要执行。返回true表示要执行此过虑器，否则不执行。

2、 run：过滤器的业务逻辑。

3、 filterType：返回字符串代表过滤器的类型，如下

pre：请求在被路由之前执行

routing：在路由请求时调用

post：在routing和errror过滤器之后调用

error：处理请求时发生错误调用

4、 filterOrder：此方法返回整型数值，通过此数值来定义过滤器的执行顺序，数字越小优先级越高。

定义一个zuul过滤器，判断身份令牌的有效性

@Component
public class LoginFilter extends ZuulFilter {
    //过滤器类型
    @Override
    public String filterType() {
        /**
         *  pre：请求在被路由之前执行
         *  routing：在路由请求时调用
         *  post：在routing和error过滤器之后调用
         *  error：处理请求时发生错误调用
         */
        return "pre";
    }
    //过滤器序号,越小越被优先执行
    @Override
    public int filterOrder() {
        return 0;
    }

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

    //过虑所有请求，判断头部信息是否有Authorization，如果没有则拒绝访问，否则转发到微服务
    @Autowired
    AuthService authService;
    @Override
    public Object run() throws ZuulException {
        RequestContext requestContext=RequestContext.getCurrentContext();
        HttpServletRequest request = requestContext.getRequest();
        HttpServletResponse response = requestContext.getResponse();
        //取cookie中的身份令牌
        String tokenFromCookie = authService.getTokenFromCookie(request);
        if (StringUtils.isEmpty(tokenFromCookie)){
            //拒绝访问
            access_denied();
            return null;
        }
        //从header中取jwt
        String jwtFromHeader=authService.getJwtFromHeader(request);
        if (StringUtils.isEmpty(jwtFromHeader)){
            //拒绝访问
            access_denied();
            return null;
        }
        //从redis取出jwt的过期时间
        long expire = authService.getExpire(tokenFromCookie);
        if (expire<0){
            //拒绝访问
            access_denied();
            return null;
        }
        return null;
    }

   //    拒绝访问
    private void access_denied(){
        RequestContext requestContext=RequestContext.getCurrentContext();
        HttpServletResponse response = requestContext.getResponse();
        //拒绝访问
        requestContext.setSendZuulResponse(false);
        //响应代码
        requestContext.setResponseStatusCode(200);
        ResponseResult responseResult=new ResponseResult(CommonCode.UNAUTHENTICATED);
        //转成Json
        String jsonString = JSON.toJSONString(responseResult);
        requestContext.setResponseBody(jsonString);
        response.setContentType("application/json;charset=utf-8");
    }
}