spring cloud 笔记 |第四章: Zuul 路由网关

简介

Zuul网关是具体核心业务服务的看门神,相比具体实现业务的系统服务来说它是一个边缘服务,主要提供动态路由、监控、弹性、安全性等功能。在分布式的微服务中，系统被拆为多套系统，通过zuul网关来对用户的请求进行路由没转发到具体的后台服务系统中。

路由网关的作用

Zuul网关的主要功能是路由转发和过滤器，核心是一系列的过滤器，这些过滤器可以对请求或者响应结果做一系列过滤，Zuul提供了一个框架可以支持动态加载，编译，运行这些过滤器，这些过滤器是使用责任链方式顺序对请求或者响应结果进行处理的，不会直接进行通信，但是通过责任链传递的RequestContext参数可以共享一些东西。

在zuul中过滤分为四种：
PRE Filters:前置过滤,当请求会路由转发到具体后端服务器前执行的过滤器.

ROUTING Filters:路由过滤器,该过滤器作用是把请求具体转发到后端服务器上.

POST Filters:后置过滤器,当把请求路由到具体后端服务器后执行的过滤器.

CUSTOM Filters:自定义拦截器.

ERROR Filters（错误过滤器）：当上面任何一个类型过滤器执行出错时候执行该过滤器.

Zuul 工作原理

当Zuul接收到请求后,首先会由前置过滤器进行处理,然后在由路由过滤器具体把请求转发到后端应用,然后在执行后置过滤器把执行结果写会到请求方,当上面任何一个类型过滤器执行出错时候执行该过滤器.

工作原理图

工作原理图

代码实现

实现原理图

image

准备工作

继续上一章笔记的工程,启动eureka-server 工程；启动service-hello工程;启动service-ribbon工程;

修改service-ribbon配置文件,再启动一个servuce-ribbon工程(同时启动两个servuce-ribbon工程,启动两个实例的方法第二章已经提到过了.):

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8081/eureka/
server:
  port: 8085
spring:
  application:
    name: service-ribbon2

创建Zuul 路由网关

创建service-zuul工程:Cloud Discovery -> Eureka Discovery Client

创建service-zuul工程

创建完成后,在service-zuul项目的pom文件继承父pom文件,并查看是否引入了spring-cloud-starter-netflix-eureka-client的依赖.
并引入依赖:

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

在启动类applicaton类加上注解@EnableZuulProxy，开启zuul的功能：

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

加上配置文件application.yml加上以下的配置代码：

server:
  port: 8086

#向注册服务中心地址
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8081/eureka/

#向注册中心注册的服务名
spring:
  application:
    name: service-zuul

#配置路由网关管理的路由
zuul:
  routes:
    api-a:
      #分配的路由
      path: /api-a/**
      #调用的服务
      serviceId: service-ribbon
    api-b:
      path: /api-b/**
      serviceId: service-ribbon2

首先指定服务注册中心的地址为http://localhost:8081/eureka/，服务的端口为8086，服务名为service-zuul；以/api-a/ 开头的请求都转发给service-ribbon服务；以/api-b/开头的请求都转发给service-ribbon2服务；

访问：http://localhost:8086/api-a/hello,显示:

hello ! 我是 8083号服务器.

访问：http://localhost:8086/api-b/hello,显示:

hello ! 我是 8083号服务器.

演示了Zuul路由的作用,接下来演示过滤的方法;

服务过滤

在service-zuul工程中,创建过滤类并继承ZuulFilter,并做一个简单的安全验证demo:

@Component
public class Filter extends ZuulFilter {

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

    //配置过滤器类型
    //pre：路由之前
    //routing：路由之时
    //post： 路由之后
    //error：发送错误调用
    @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 null" );
            ctx.setSendZuulResponse( false );
            ctx.setResponseStatusCode( 401 );
            try {
                ctx.getResponse().getWriter().write( "token is null" );
            } catch (Exception e) {
            }

            return null;
        }
        log.info( "succeed" );
        return null;
    }
}

这时访问：http://localhost:8086/api-a/hello,显示：

token is null

这时访问：http://localhost:8086/api-a/hello?token=123456,显示：

hello ! 我是 8083号服务器.