SpringCloud 学习笔记------路由网关(Zuul)

       声明，老师讲过眼里过千遍不如手里过一遍。这个真的只是我的学习笔记，只是写个我自己看的，要是有人觉得我抄袭了他的内容，海涵。想看大牛的博客，请移步这里http://blog.csdn.net/forezp/article/details/69788938

一、Zuul简介

    Zuul有两个作用，路由器和过滤器。

二、准备工作

    本篇内容基于之前笔记所涉及的实例。

1. 一个服务注册中心——eurekaserver:8081
   
2. 三个服务者——peoduceserver:8082/peoduceserver:8083/peoduceserver:8084
   
3. 两个消费者——service-ribbon:8090/service-feign:8100

三、新建一个工程service-zuul

    1.pom.xml文件（我不知道为什么每次我自己新建的工程pom文件都会报错，复制别人的过来就没事。）

<?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.byk</groupId>
	<artifactId>service-zuul</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>service-zuul</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.4.0.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</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.RC2</spring-cloud.version>
	</properties>

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

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>Dalston.RC1</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

	<repositories>
		<repository>
			<id>spring-milestones</id>
			<name>Spring Milestones</name>
			<url>https://repo.spring.io/milestone</url>
			<snapshots>
				<enabled>false</enabled>
			</snapshots>
		</repository>
	</repositories>


</project>

2.application.yml文件

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8081/eureka/
server:
  port: 8110
spring:
  application:
    name: service-zuul
zuul:
  routes:
    api-a:
      path: /ribbon/**
      serviceId: service-ribbon     #以api-a开头的请求都转发到ribbon服务商上
    api-b:
      path: /feign/**
      serviceId: service-feign    #以api-b开头的请求都转发到feign服务商上
hystrix:                          #断路器配置
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 60000

3.启动文件上加@EnableZuulProxy  和@EnableEurekaClient 两个标签。

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;

@EnableZuulProxy     //开启Zuul转发功能
@EnableEurekaClient    //向服务中心注册
@SpringBootApplication
public class ServiceZuulApplication {

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

4.启动所有工程。浏览器输入http://localhost:8110/feign/hello，如下：

浏览器输入http://localhost:8110/ribbon/hello，如下：

    这说明我们的Zuul转发起作用了。

    注意，如果.yml配置文件中不加断路器配置，关闭三个服务之后，断路器不起作用，直接访问会报500错误。

四、Zuul的过滤器功能

    1 .新建MyFilter，继承ZuulFilter。

    

@Component
public class MyFilter extends ZuulFilter {

    /**
     * 日志
     */
    private static Logger log = LoggerFactory.getLogger(MyFilter.class);

    /**
     * 过滤器类型，此处是请求前进行拦截
     *
     * pre：路由之前
     * routing：路由之时
     * post： 路由之后
     * error：发送错误调用
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 过滤的顺序
     */
    @Override
    public int filterOrder() {
        return 0;
    }


    /**
     * shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }


    /**
     * run：过滤器的具体逻辑。可用很复杂，包括查sql，nosql去判断该请求到底有没有权限访问。
     */
    @Override
    public Object run() {
        //获取请求的路径信息
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        //日志信息========>可有可无吧，暂时还看不懂
        log.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
        //获取路径信息的关键词”token"
        String token = request.getParameter("token");
        //如果token的数值小于100，就拦截，并返回“token is too small"
        if(Integer.parseInt(token) < 100) {
            //日志打印
            log.warn("token is too small");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                //响应
                ctx.getResponse().getWriter().write("token is too small~");
            }catch (Exception e){}

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

    2.一些参数。

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

    3.这时再访问http://localhost:8110/ribbon/hello?token=10086，如下:

    访问http://localhost:8110/ribbon/hello?token=10，如下：

五、源码

    获取源码https://github.com/bian1234/SpringCloudNote/tree/master