SpringCloud那些事-Zuul

API 网关是对外服务的一个入口，其隐藏了内部架构的实现，是微服务中必不可少的一个组件。Zuul 就是这个角色，它的核心是过滤器，可以实现动态路由、请求控制、认证鉴权、压力测试、灰度发布等。

Zuul 使用

创建个新的 Moduel Zuul，依赖：

    com.dane.springcloud
    springcloud
    0.0.1-SNAPSHOT
     



    
        org.springframework.cloud
        spring-cloud-starter-netflix-zuul
    

启动类加上注解 @EnableZuulProxy

@EnableZuulProxy
@SpringBootApplication
public class ZuulApplication {

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

然后代理 user-service，看配置：

server.port=10086
spring.application.name=api
#这里是映射路径
zuul.routes.user-service.path=/user-service/**
#映射路径对应的实际url地址
zuul.routes.user-service.url=http://localhost:8081

启动服务，访问http://localhost:10086/user-service/user/hello，可以看到访问到user-service。

整合 Eureka

在刚才的路由规则中，我们把路径对应的服务地址写死了，我们应该根据服务的名称，去Eureka注册中心查找 服务对应的所有实例列表，然后进行动态路由才对。

加入 Eureka 依赖

    org.springframework.cloud
    spring-cloud-starter-netflix-eureka-client

配置信息：

server.port=10086
spring.application.name=api

eureka.client.service-url.dafaultZone = http://localhost:8761/eureka
#采用ip注册
eureka.instance.prefer-ip-address=true
# 定义实例ID格式
eureka.instance.instance-id=${spring.application.name}:${spring.cloud.client.ip-address}:${server.port}

#若报  Hystrix Readed time out 开启
#ribbon.ReadTimeout = 120000
#ribbon.ConnectTimeout = 30000

然后就可以了，访问格式是 API网关地址 + 访问服务名称 + 接口 URI。

Zuul 过滤器

Zuul作为网关的其中一个重要功能，就是实现请求的鉴权。而这个动作我们往往是通过Zuul提供的过滤器来实现的。

ZuulFilter是过滤器的顶级父类

public abstract ZuulFilter implements IZuulFilter{
    //过滤器类型，有pre、route、post、error
    abstract public String filterType();
    //过滤器的执行顺序，数值越小，优先级越高
    abstract public int filterOrder();
    //是否执行该过滤器
    boolean shouldFilter();// 来自IZuulFilter
    //过滤器的业务逻辑
    Object run() throws ZuulException;// IZuulFilter
}

生命周期

• 正常流程：
  请求到达首先会经过pre类型过滤器，而后到达routing类型，进行路由，请求就到达真正的服务提供者，执行请求，返回结果后，会到达post过滤器。而后返回响应。

• 异常流程：
  整个过程中，pre或者routing过滤器出现异常，都会直接进入error过滤器，再error处理完毕后，会将请求交给POST过滤器，最后返回给用户。

  
  
  

  image.png

使用场景

• 请求鉴权：一般放在pre类型，如果发现没有访问权限，直接就拦截了
• 异常处理：一般会在error类型和post类型过滤器中结合来处理。
• 服务调用时长统计：pre和post结合使用。

自定义过滤器

@Component
public class LoginFilter extends ZuulFilter {


    @Override
    public String filterType() {
        // 登录校验，肯定是在前置拦截
        return FilterConstants.PRE_TYPE;
    }

    @Override
    public int filterOrder() {
        // 顺序设置为1
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        // 返回true，代表过滤器生效。
        return true;
    }

    @Override
    public Object run() {

        // 登录校验逻辑。
        // 1）获取Zuul提供的请求上下文对象
        RequestContext ctx = RequestContext.getCurrentContext();
        // 2) 从上下文中获取request对象
        HttpServletRequest req = ctx.getRequest();
        // 3) 从请求中获取token
        String token = req.getParameter("access-token");
        // 4) 判断
        if(token == null || "".equals(token.trim())){
            // 没有token，登录校验失败，拦截
            ctx.setSendZuulResponse(false);
            // 返回401状态码。也可以考虑重定向到登录页。
            ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        // 校验通过，可以考虑把用户信息放入上下文，继续向后执行
        return null;
    }
}