Spring Cloud微服务网关Zuul的注解@EnableZuulProxy或@EnableZuulServer做了什么事情

墨蓝 2024-03-23 12:13 36阅读 0赞

## 一、Zuul的工作原理 ##

Zuul 1.x的版本是由Servlet以及一系列的Filter组成的，各个组件之间协同合作完成功能，且易于扩展。参看官方的架构图我画了张图：

![format_png][]

**Zuul声明周期：**

> HTTP Request -> DispatcherServlet -> ZuulHandlerMapping -> ZuulController -> ZuulServlet -> ZuulRunner -> FilterProcessor -> ZuulFilter -> HTTP Response

1、`ZuulServlet`通过`RequestContext`上下文管理着Zuul众多的Filter组成的核心组件。

2、当有请求进入Zuul时，由`DispatcherServlet`进行分发交给`ZuulHandlerMapping`处理初始化得到路由定位器`RouteLocator`，为后续的请求分发做准备，同时也有基于事件从服务中心拉去服务列表(`ZuulRefreshListener`)。

3、`ZuulController`继承了`ServletWrappingController`重写了handleRequest方法将`ZuulServlet`引入声明周期，之后所有的请求都会经过`ZuulServlet`。

4、在第一次调用的时候会初始化`ZuulRunner`，后面就会按照过滤链的顺序执行。`ZuulRunner`会将请求和相应初始化为`RequestContext`，封装成`FilterProcessor`转化为调用`preRoute()`、`route()`、`postRoute()`、`error()`。所以在Zuul中获取请求都是通过`RequestContext.getCurrentContext()`先获取当前上下文，再通过上下文获取当前的请求。

## 二、@EnableZuulPoxy和@EnableZuulServer注解 ##

@EnableCircuitBreaker
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Import(ZuulProxyMarkerConfiguration.class)
    public @interface EnableZuulProxy {
    }
    
    
    
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Import(ZuulServerMarkerConfiguration.class)
    public @interface EnableZuulServer {
    }
    复制代码

在网关的启动类上，添加注解`@EnableZuulPoxy`后就可以启动Zuul网关的功能。从上面的源码可以看到除了`@EnableCircuitBreaker`启动了熔断器外还引入了一个自动配置的类`ZuulProxyMarkerConfiguration`。

/**
     * Responsible for adding in a marker bean to trigger activation of 
     * {@link ZuulProxyAutoConfiguration}
     *
     * @author Biju Kunjummen
     */
    @Configuration
    public class ZuulProxyMarkerConfiguration {
    	@Bean
    	public Marker zuulProxyMarkerBean() {
    		return new Marker();
    	}
    	class Marker {
    	}
    }
    复制代码

`ZuulProxyMarkerConfiguration`的源码十分简单啊！看不出什么来，不过注释里面说了添加`Marker` bean是为了触发`ZuulProxyAutoConfiguration`。

@Configuration
    @Import({ RibbonCommandFactoryConfiguration.RestClientRibbonConfiguration.class,
    		RibbonCommandFactoryConfiguration.OkHttpRibbonConfiguration.class,
    		RibbonCommandFactoryConfiguration.HttpClientRibbon

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/2958b1dc99d04a659052aa8b2a048a61.png