SpringCloud入门实战之五：路由网关(zuul)

在微服务架构中，需要几个基础的服务治理组件，包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等，由这几个基础组件相互协作，共同组建了一个简单的微服务系统。

Zuul的主要功能是路由转发和过滤器。路由功能是微服务的一部分，比如／api/user转发到到user服务，/api/shop转发到到shop服务。zuul默认和Ribbon结合实现了负载均衡的功能。

zuul有以下功能：

    Authentication
    Insights
    Stress Testing
    Canary Testing
    Dynamic Routing
    Service Migration
    Load Shedding
    Security
    Static Response handling
    Active/Active traffic management

继续使用上一节的工程。在原有的工程上，创建一个新的工程。

创建service-zuul工程,这是第5个独立的工程

自动生成pom.xml文件的内容如下：

	4.0.0

	com.contoso
	service-zuul
	0.0.1-SNAPSHOT
	jar

	service-zuul
	Demo project for Spring Boot

	
		org.springframework.boot
		spring-boot-starter-parent
		2.0.3.RELEASE
		 
	

	
		UTF-8
		UTF-8
		1.8
		Finchley.RELEASE
	

	
		
			org.springframework.boot
			spring-boot-starter-web
		
		
			org.springframework.cloud
			spring-cloud-starter-netflix-eureka-client
		
		
			org.springframework.cloud
			spring-cloud-starter-netflix-zuul
		

		
			org.springframework.boot
			spring-boot-starter-test
			test
		
	

	
		
			
				org.springframework.cloud
				spring-cloud-dependencies
				${spring-cloud.version}
				pom
				import
			
		
	

	
		
			
				org.springframework.boot
				spring-boot-maven-plugin
			
		
	

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

package com.contoso;

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

@SpringBootApplication
@EnableZuulProxy
@EnableEurekaClient
@EnableDiscoveryClient
public class ServiceZuulApplication {

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

配置文件application.yml定义如下：

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
server:
  port: 8769
spring:
  application:
    name: service-zuul
zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: service-ribbon
    api-b:
      path: /api-b/**
      serviceId: service-feign

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

依次启动这5个工程，其中service-ribbon和serice-feign启动顺序可以互换,启动顺序如下：

eureka-server （注册中心服务）

service-hi（服务提供者）  编译（Maven Install）过程会访问注册中心服务，所以注册中心服务必须要先启动起来才能编译此服务

service-ribbon （服务消费者） 编译（Maven Install）过程会访问服务提供者服务，所以服务提供者服务必须要先启动起来才能编译此服务

serice-feign （服务消费者）编译（Maven Install）过程会访问服务提供者服务，所以服务提供者服务必须要先启动起来才能编译此服务

service-zuul（服务网关）

 

打开浏览器访问：http://localhost:8769/api-a/hi?name=Jason浏览器显示：

Hello Jason ,this message is from port:8762

Hello Jason ,this message is from port:8763

Hello Jason ,this message is from port:8762

Hello Jason ,this message is from port:8763

这说明zuul起到了路由的作用

 

打开浏览器访问：http://localhost:8769/api-b/hi?name=Jason浏览器显示：

Hello Jason ,this message is from port:8762

Hello Jason ,this message is from port:8763

Hello Jason ,this message is from port:8762

Hello Jason ,this message is from port:8763

这说明zuul起到了路由的作用

 

打开浏览器访问：http://localhost:8764/hi?name=Jason

打开浏览器访问：http://localhost:8765/hi?name=Jason 

这是前一篇blog访问实现了断路功能的具备负载均衡能力消费者，访问消费者服务器的访问链接地址，

它们同样还能轮流输出与上面一样的消息内容，这证明了目前可以绕过网关服务。

 

服务过滤

zuul不仅只是路由，并且还能过滤，做一些安全验证，只关闭service-zuul服务继续改造工程。

package com.contoso;

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去判断该请求到底有没有权限访问。

访问：http://localhost:8769/api-a/hi?name=cathy 网页显示：

    token is empty

访问 http://localhost:8769/api-a/hi?name=cathy&token=6431f1dd-8b99-11e8-a4e2-000c293a2182 网页显示：

Hello cathy ,this message is from port:8762

Hello cathy ,this message is from port:8763

Hello cathy ,this message is from port:8762

Hello cathy ,this message is from port:8763

本篇blog源码 spring-cloud-example5.zip