Spring Cloud 入门教程（09）：路由网关zuul

发表于 | 分类于

微服务系统

在微服务架构中，需要几个基础的服务治理组件，包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等，由这几个基础组件相互协作，共同组建了一个简单的微服务系统。
enter description here
在Spring Cloud微服务系统中，一种常见的负载均衡方式是，客户端的请求首先经过负载均衡（zuul、Ngnix），再到达服务网关（zuul集群），然后再到具体的服务，服务统一注册到高可用的服务注册中心集群，服务的所有的配置文件由配置服务管理，配置服务的配置文件放在Git仓库，方便开发人员随时改配置。

Zuul

1. 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

在接下来的步骤中，我们来创建一个zuul服务， 将/api-feign/映射到我们之前创建feign-service, 将/api-ribbon/映射到之前的ribbon-service服务。

2. 创建Zuul的Maven工程

添加zuul的依赖

1
2
3
4
<dependency>
	<groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>

完整pom.xml如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?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>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.5.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>org.cwalzy</groupId>
	<artifactId>springcloud.helloworld.zuul.service</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>springcloud.helloworld.zuul.service</name>
	<description>Demo Spring zuul service</description>

	<properties>
		<java.version>1.8</java.version>
		<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-server</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>

		<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>${spring-cloud.version}</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>

</project>

3. 创建启动类: 使用@EnableZuulProxy注解

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package org.cwalzy.springcloudeureka;

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;

@EnableEurekaClient
@SpringBootApplication
@EnableZuulProxy
public class SpringcloudHelloworldZuulServiceApplication {

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

4. 编写zuul服务配置：

简单配置两个路由， 一个路由到ribbon，一个路由到feign； 由于都注册到eureka服务中心，所以都用通过serviceId来发现服务具体地址， path是路由的地址映射关系

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
eureka:
    client:
        serviceUrl:
            defaultZone: http://localhost:8761/eureka/
server:
    port: 8904
spring:
    application:
        name: service-zuul
zuul:
  routes:
    ribbo:
      path: /api-ribbon/**
      serviceId: service-ribbon
    feign:
      path: /api-feign/**
      serviceId: service-feign

这时启动zuul服务， 然后访问

http://localhost:8904/api-ribbon 可直接路由到 http://localhost:8901/

http://localhost:8904/api-feign/hello 可路由到 http://localhost:8902/hello

5. Zuul过滤器

zuul还提供了过滤功能， 只要实现接口ZuulFilter即可对请求先进行筛选和过滤之后再路由到具体服务。下面简单示例 做安全验证demo。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package org.cwalzy.springcloudeureka;

import javax.servlet.http.HttpServletRequest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.exception.ZuulException;
import com.netflix.zuul.context.RequestContext;

//zuul还提供了过滤功能， 只要实现接口ZuulFilter即可对请求先进行筛选和过滤之后再路由到具体服务
@Component
public class DemoFilter extends ZuulFilter {
	
	private static Logger log = LoggerFactory.getLogger(DemoFilter.class);

	/*shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤*/
	@Override
	public boolean shouldFilter() {
		return true;
	}
	/*run：过滤器的具体逻辑*/
	@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：发送错误调用*/
	@Override
	public String filterType() {
		return "pre";
	}
	/* filterOrder：过滤的顺序 */
	@Override
	public int filterOrder() {
		return 0;
	}

}

  • filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
    • pre：路由之前
    • routing：路由之时
    • post： 路由之后
    • error：发送错误调用
  • filterOrder：过滤的顺序
  • shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。
  • run：过滤器的具体逻辑

本文转载自 https://www.cnblogs.com/chry/p/7299844.html
原文基于 spring boot 1.5.3.RELEASE 版本
而本文中有一些改动 是基于 spring boot 2.1.5.RELEASE 版本