springCloud（五）路由网关zuul

zuul的主要功能是路由转发和过滤器，默认整合了ribbon实现负载均衡，类似于nginx转发。

微服务架构的几个关键组件：服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等。

微服务架构：客户端请求经过负载均衡，再到达服务网关（zuul集群），然后再到具体的服务；服务统一注册到高可用的服务注册中心集群（eureka），服务的所有配置文件由配置服务管理，配置服务的配置文件放在git（或其他有版本控制）仓库中。

参考文章：

此节代码依赖前几节代码：注册中心eureka,两个service-member服务

springCloud（一）eureka 注册中心

springCloud（二）服务提供和服务发现

springCloud（三）ribbon实现负载均衡

代码下载：git——>https://github.com/aeolusway/aeolusway.git

一、本节代码：

（1）包结构

（2）ZuulApp

package com.aeolusway;

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


@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ZuulApp {

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

开启网关：@EnableZuulProxy

（3）MyFilter

package com.aeolusway.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
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() throws ZuulException {
        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) {
            return 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;

    }
}

（4）application.yml

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8888/eureka/
server:
  port: 8769
spring:
  application:
    name: service-zuul
zuul:
  routes:
    api-a:
      path: /api-member/**
      service-id: service-member
    api-b:
      path: /api-order/**
      service-id: service-order

发送请求：http://localhost:8769/api-member/getUsername

将会转发到：http://localhost:8762/getUsername（即service-member 服务）

（5）pom.xml

<?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>

    <groupId>com.aeolusway</groupId>
    <artifactId>SprinCloud-Zuul</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
    </parent>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR1</spring-cloud.version>
    </properties>
    <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-zuul</artifactId>
            <version>1.4.6.RELEASE</version>
        </dependency>

    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

二、代码解析

Filter中四个方法，FilterType，filterOrder，shouldFilter，run

FilterType代表过滤的类型，可返回四个不同生命周期的过滤器类型：

返回字符串	生命周期	应用
pre	Request routing到源web-service之前执行	Authentication、选择源服务地址
routing	Request routing到源web-service之时执行	日志记录
post	Request routing到源web-service之后执行	对Response结果进行修改，收集统计数据、把Response传输回客户端。
error	错误时调用	日志记录

 

 

filterOrder：过滤的顺序，返回数字，数字越大，优先级越低。

shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。 

run：过滤器的具体逻辑。

三、测试

因为zuul默认整合了ribbon实现了负载均衡，所以发送请求到 http://localhost:8769/api-member/getUsername后，会按照负载均衡策略（默认为：轮询）访问8762，8763两个服务。