SpringCloud之Zuul

什么是网关

API Gateway，是系统的唯一对外的入口，介于客户端和服务器端之间的中间层，处理非业务功能 提供路由请求、鉴权、监控、缓存、限流等功能

什么是Zuul

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

Zuul与Nginx怎么配合使用

Nginx的作用是反向代理、负载均衡，Zuul的作用是保障微服 务的安全访问，拦截微服务请求，校验合法性及负载均衡。

实际运用

客户端请求网关/api/learning，通过路由转发到/learning
客户端请求网关/api/course，通过路由转发到/course

pom依赖

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

Zuul配置

zuul:
  routes:
    manage-course:
      path: /course/**
      serviceId: xc-service-manage-course #微服务名称，网关会从eureka中获取该服务名称下的服务实例的地址
      # 例子：将请求转发到http://localhost:31200/course
      #url: http://www.baidu.com #也可指定url，此url也可以是外网地址\
      strip-prefix: false #true：代理转发时去掉前缀，false:代理转发时不去掉前缀
      sensitiveHeaders:  #默认zuul会屏蔽cookie，cookie不会传到下游服务，这里设置为空则取消默认的黑名单，如果设置了具体的头信息则不会传到下游服务
      #   ignoredHeaders: 默认为空表示不过虑任何头
    xc-service-learning:  #路由名称，名称任意，保持所有路由名称唯一
      path: /learning/**
      serviceId: xc-service-learning #指定服务id，从Eureka中找到服务的ip和端口
      strip-prefix: false
      sensitiveHeaders:

• manage-course:为路由名称，名称任意，保持所有路由名称唯一
• path:代理的请求
• serviceId：微服务名称，网关会从eureka中获取该服务名称下的服务实例的地址，转发到该地址
• strip-prefix：是否去掉前缀，true：代理转发时去掉前缀，false:代理转发时不去掉前缀，例如，为true请 求/course/coursebase/get/…，代理转发到/coursebase/get/，如果为false则代理转发到/course/coursebase/get
• sensitiveHeaders：敏感头设置，默认会过虑掉cookie，这里设置为空表示不过虑
• ignoredHeaders：可以设置过虑的头信息，默认为空表示不过虑任何头

启动类

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

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

@EnableZuulProxy：表明此工程是一个zuul网关

过虑器

我们要定义一个过滤器继承ZuulFilter，重写其方法来实现身份校验，请求过滤

filterType ：返回的字符代表过滤器类型，

• pre:请求在被路由之前调用，我们可以利用这种过滤器实现身份验证,在集群中选择请求的为服务、记录调试信息等。
• routing:将请求路由到为服务。构建发送给微服务的请求
• post:这种过滤器在routing和error过滤器后调用,可以为响应添加标准的http header、收集信息的指标
• error:处理请求时发生错误调用

filterOrder：此方法返回整形数值，通过此数值来定义过滤器的执行顺序,数字越小优先级越高
shouldFilter：返回一个Boolean值，判断该过滤器是否需要执行
run:过滤器的业务逻辑

@Component
public class LoginFilter extends ZuulFilter {

    @Autowired
    private AuthService authService;

    private static final Logger LOG = LoggerFactory.getLogger(LoginFilter.class);

    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 3;
    }

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

    /**
     * 身份校验
     *
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
//        获取请求容器
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        HttpServletResponse response = currentContext.getResponse();

//        获取token
        String token = authService.getTokenFromCookie(request);
        if (StringUtils.isEmpty(token)){
            access_denied();
        }
//        查询jwt
        String jwt = authService.getJwtFromHeader(request);
        if (StringUtils.isEmpty(jwt)){
            access_denied();
        }
//        从redis中校验身份令牌是否过期
        long expire = authService.getExpire(token);
        if (expire<0){
            access_denied();
        }
        return null;
    }

    private void access_denied() {
        RequestContext currentContext = RequestContext.getCurrentContext();
        //           拒绝请求
        currentContext.setSendZuulResponse(false);
//            设置响应状态码
        currentContext.setResponseStatusCode(200);
        ResponseResult result = new ResponseResult(CommonCode.FAIL);
        String jsonString = JSON.toJSONString(result);
        currentContext.setResponseBody(jsonString);
        currentContext.getResponse().setContentType("application/json;charset=UTF-8");
    }
}