第五章 Spring Cloud 路由网关（zuul）

在基础架构当中，需要几个服务治理组件，包括服务的注册与发现、负载均衡、路由网关、服务消费、断路器和配置管理等几个组件，共同组成了简单的微服务系统。
架构图如下：
在这里插入图片描述

1、Zuul 简介

zuul的主要功能是做路由转发和过滤，比如说/api/user转发到user，/api/shop转发到shop。

2、准备工作

本篇文章是基于上一篇文章的基础之上实现的，因此在之前4个工程的基础之上再加一个工程一共是5个工程。
这5个工程分别是：
spring-cloud-eureka 8080
spring-cloud-provide 8081
spring-cloud-consumer-feign 8084
spring-cloud-consumer-ribbon 8082
spring-cloud-zuul 8085

3、创建Spring Cloud Zuul工程（spring-cloud-zuul）

第一步：创建一个普通的Spring Boot工程

创建一个普通的Spring Boot工程，并命名为spring-cloud-zuul

第二步：引入相关依赖

这里主要是引入“spring-cloud-starter-netflix-zuul”路由网关组件，依赖如下：

<?xml version="1.0" encoding="UTF-8"?>
<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.brimen</groupId>
        <artifactId>spring-cloud-brimen-zuul</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath/>
    </parent>
    <groupId>com.brimen</groupId>
    <artifactId>spring-cloud-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-cloud-zuul</name>
    <description>Spring Cloud Zuul 网关路由</description>

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

第三步：配置文件application.yml进行以下配置

以“api-a”开头的请求都转发给“spring-cloud-consumer-feign”进行处理；以“api-b”开头的请求都转发给“spring-cloud-consumer-ribbon”进行处理。

spring:
  application:
    name: server-zuul

server:
  port: 8085

zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: spring-cloud-consumer-feign
    api-b:
      path: /api-b/**
      serviceId: spring-cloud-consumer-ribbon

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8080/eureka/

第四步：在入口类添加@EnableZuulProxy注解

在入口类添加@EnableZuulProxy注解，开启zuul功能，代码如下：

package com.brimen.springcloudzuul;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

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

第五步:启动项目并访问

依次启动五个工程并且访问 http://localhost:8085/api-a/hello/gethello 和 http://localhost:8085/api-b/hello/gethello
在这里插入图片描述
这说明路由起到了转发的作用

第六步：服务过滤

zuul不仅只是路由，还能进行过滤，做一些安全的校验，因此让我们来创建一个filter，代码如下：

package com.brimen.springcloudzuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;

@Component
public class MyFilter extends ZuulFilter {

    private static Logger log = LoggerFactory.getLogger(MyFilter.class);

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

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

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

    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        log.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
        Object accessToken = request.getParameter("token");
        if(accessToken == null) {
            log.warn("token is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                ctx.getResponse().getWriter().write("token is empty");
            }catch (Exception e){}
            return null;
        }
        log.info("ok");
        return null;
    }
}

filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
- pre：路由之前
- routing：路由之时
- post：路由之后
- error：发送错误调用
filterOrder：过滤的顺序
shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。
run：过滤器的具体逻辑。可用很复杂，包括查sql，nosql去判断该请求到底有没有权限访问

第七步：重启查看效果

完成以后，重新启动查看token是否起到了作用
在这里插入图片描述