Spring Cloud Zuul源码详解

目录

代码示例

实现原理

DispatcherServlet

ZuulHandlerMapping

RouteLocator

ZuulController

ZuulServlet

ZuulFilterConfiguration

查看路由规则

路由规则配置

忽略路由规则

自定义路由规则

查看Filter

自定义Filter

---

Java版本：1.8

Spring版本：5.1.8.RELEASE

Spring Boot版本：2.1.6.RELEASE

Spring Cloud版本：Greenwich.SR1

代码示例

添加spring-cloud-starter-netflix-zuul依赖

<?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.6.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.sean</groupId>
	<artifactId>test-zuul</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>test-zuul</name>
	<description>test-zuul</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-client</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-web</artifactId>
		</dependency>

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

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
		</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>

启动类设置开启Zuul 

package com.sean;

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

@SpringBootApplication
@EnableZuulProxy
public class TestZuulApplication {

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

server.port=7000
spring.application.name=test-zuul

eureka.client.service-url.defaultZone=http://localhost:8000/eureka

# 是否注册至eureka，默认值为true，如果为true，需要配置eureka.client.service-url.defaultZone
# 否则会访问默认eureka地址：http://localhost:8761/eureka/
# 本服务仅供测试，不对外提供服务，因此不需要注册到eureka中
eureka.client.register-with-eureka=true

# 服务续租任务执行时间间隔
eureka.instance.lease-renewal-interval-in-seconds=10
# 服务过期时间
eureka.instance.lease-expiration-duration-in-seconds=20

management.endpoints.web.exposure.include=routes,filters

启动Eureka-Server后，启动Test-Service和Test-Service2，然后调用http://localhost:7000/test-service/name（调用http://localhost:7000/zuul/test-service/name也是可以的，具体原因参见下面的ZuulServlet），会间次获得sean和sean two

实现原理

我们从pom文件开始

spring-cloud-starter-netflix-zuul依赖spring-cloud-netflix-zuul

spring-cloud-netflix-zuul的代码结构如下

 spring.factories配置中指定了AutoConfiguration类

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.netflix.zuul.ZuulServerAutoConfiguration,\
org.springframework.cloud.netflix.zuul.ZuulProxyAutoConfiguration

我们先看一下ZuulServerAutoConfiguration类

@Configuration
@EnableConfigurationProperties({ ZuulProperties.class })
@ConditionalOnClass({ ZuulServlet.class, ZuulServletFilter.class })
@ConditionalOnBean(ZuulServerMarkerConfiguration.Marker.class)
public class ZuulServerAutoConfiguration {
    ......
}

ZuulServerMarkerConfiguration.Marker类的实例是在EnableZuulServer注解中创建的

如果我们使用EnableZuulServer注解，将只加载ZuulServerAutoConfiguration类中的配置信息

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(ZuulServerMarkerConfiguration.class)
public @interface EnableZuulServer {}

​@Configuration
public class ZuulServerMarkerConfiguration {

	@Bean
	public Marker zuulServerMarkerBean() {
		return new Marker();
	}

	class Marker {}
}

 再看下ZuulProxyAutoConfiguration类，ZuulProxyAutoConfiguration类继承自ZuulServerAutoConfiguration

@Configuration
......
@ConditionalOnBean(ZuulProxyMarkerConfiguration.Marker.class)
public class ZuulProxyAutoConfiguration extends ZuulServerAutoConfiguration {
    ......
}

ZuulProxyMarkerConfiguration.Marker类的实例是在EnableZuulProxy注解中创建的

如果我们使用EnableZuulProxy注解，将会加载ZuulProxyAutoConfiguration类中的配置的信息，由于ZuulProxyAutoConfiguration继承ZuulServerAutoConfiguration类，ZuulServerAutoConfiguration类中的配置信息也会被加载（为什么@ConditionalOnBean(ZuulServerMarkerConfiguration.Marker.class)判定未生效？）

@EnableCircuitBreaker
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(ZuulProxyMarkerConfiguration.class)
public @interface EnableZuulProxy {}