spring cloud 之API服务网关（zuul）

　　在微服务场景下，每个微服务都对外暴露了一组细粒度的defuwu服务。客户端的请求可能会涉及到一串的服务调用，如果将这些服务都暴露客户端，那么客户端需要请求不同的微服务才能完成一次业务处理，增加客户端的代码复杂度，除此之外，对于微服务我们可能需要服务调用进行统一的认证和校验。

　　zuul是基于设计模式中的facade模式(外观模式), 将细粒度的服务组合起来提供一个粗粒度的服务，所有服务的入口都统一到一个入口，那么整个服务只需暴露一个API, 对外端屏蔽服务的细节，也减少了客户端与服务器的网络调用次数。就是API服务网关（api-Gateway）服务。
　　spring cloud netflix的zuul组件可以做反向代理功能，通过路由寻址将求转发到后端的粒度服务上，并做统一的逻辑处理

一、zuul介绍

zuul中定义的四中不同生命的过滤器类型：
　　1. pre：路由之前
　　2. routing:路由之时
　　3. post:路由之后
　　4. error：发送错误调用

二、zuul请求路由

zuul的请求路由有点类似于nginx的反向代理，通过指定代理的请求路径和配置过滤条件来组件一个请求的路由规则，将符合路由规则的请求转发到真正请求的服务上面去。

zuul.routes.record-serve.path=/api/record-server/**
zuul.routes.record-serve.url=http://192.168.1.126:10007/

三、zuul服务名称路由

zuul通过服务名称到enurek注册中心查找到服务对应的IP在路由到指定的服务上面(如何有多个相同名称的服务，ribbon会进行负载均衡到其中的一个ip上返回)。在路由到对应的服务上面去完成请求操作

zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: service-ribbon
    api-b:
      path: /api-b/**
      serviceId: service-feign

四、＠EnableZuulServer注解

1.pre类型过滤器

(1)ServletDetectionFilter: 主要是检测是否是否通过DispatcherServlet控制器进行进行请求，设置isDispatcherServletRequest参数

#部分源码展示
public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        if (!(request instanceof HttpServletRequestWrapper) && this.isDispatcherServletRequest(request)) {
            ctx.set("isDispatcherServletRequest", true);
        } else {
            ctx.set("isDispatcherServletRequest", false);
        }

        return null;
    }

    private boolean isDispatcherServletRequest(HttpServletRequest request) {
        return request.getAttribute(DispatcherServlet.WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null;
    }

(2)FormBodyWrapperFilter:　解析表单数据，并为请求重写编码
　(3)DebugFilter: 调试用的过滤器

2.route类型过滤器

SendForwardFilter：该过滤器使用ServletRequestDispatcher转发请求，转发位置存储在RequestContext.getCurrentContext().get("forward.to")中。可以将路由设置成:

zuul.routes.record-serve.path=/api/record-server/**
zuul.routes.record-serve.url=http://192.168.1.126:10007/

SendForwardFilter部分源码

 public boolean shouldFilter() {
        RequestContext ctx = RequestContext.getCurrentContext();
        return ctx.containsKey("forward.to") && !ctx.getBoolean("sendForwardFilter.ran", false);
    }

    public Object run() {
        try {
            RequestContext ctx = RequestContext.getCurrentContext();
            String path = (String)ctx.get("forward.to");
            RequestDispatcher dispatcher = ctx.getRequest().getRequestDispatcher(path);
            if (dispatcher != null) {
                ctx.set("sendForwardFilter.ran", true);
                if (!ctx.getResponse().isCommitted()) {
                    dispatcher.forward(ctx.getRequest(), ctx.getResponse());
                    ctx.getResponse().flushBuffer();
                }
            }
        } catch (Exception var4) {
            ReflectionUtils.rethrowRuntimeException(var4);
        }

        return null;
    }

3.post类型过滤器

SendResponseFilter：将Zuul所代理的微服务的响应写入当前响应

4.error类型过滤器

SendErrorFilter: 如果RequestContext.getThrowable()不为null，那么默认就会转发到/error，也可以设置error.path属性修改默认的转发路径。

五、＠EnableZuulProxy注解

一、pre类型过滤器

PreDecorationFilter：该过滤器根据提供的RouteLocator确定路由到的地址，以及怎样去路由。该路由器也可为后端请求设置各种代理相关的header。

二、route类型过滤器

(1) RibbonRoutingFilter：该过滤器使用Ribbon，Hystrix和可插拔的HTTP客户端发送请求。serviceId在RequestContext.getCurrentContext().get("serviceId")中。该过滤器可使用不同的HTTP客户端，例如：
　　1.Apache HttpClient：默认的HTTP客户端
　　2.SquareupOkHttpClient v3：如需使用该客户端，需保证com.squareup.okhttp3的依赖在classpath中，并设置如下：

 ribbon.okhttp.enabled = true

3.Netflix Ribbon HTTP client：设置如下即可启用该HTTP客户端。需要注意的是，该客户端有一定限制，例如不支持PATCH方法，另外，它有内置的重试机制。

 ribbon.restclient.enabled = true

(2) SimpleHostRoutingFilter：该过滤器通过Apache HttpClient向指定的URL发送请求。URL在RequestContext.getRouteHost()中。

六、使用zuul所遇到的问题

(1)注意zuul路由的请求路径问题(按请求路由)

查看下面请求路由配置

# 在微服务中有个个record的子服务，需要将他的所有符合匹配规则的请求通过zuul转发
# record 微服务部署ip 为192.168.1.126 端口为10007 
#  zuul 微服务部署ip 192.168.1.126 端口10009
zuul.routes.record-serve.path=/api/record-server/**
zuul.routes.record-serve.url=http://192.168.1.126:10007/

你在未使用zuul网关访问的路径是http://192.168.1.126:10007/api/record-server/hello，此时访问　http://192.168.1.126:10009/api/record-server/hello,结果是404,由于你strpPrefix设置的是true，匹配访问时是会忽略/api/record-server/段的，你正真匹配发送到record服务的请求是http://192.168.1.126:10007/hello，所以会导致404.
　那是由于zuul 默认设置的stripPrefix是ture，转发时默认去掉请求前缀之后再进行转发

zuul.routes.record-serve.path=/api/record-server/**
zuul.routes.record-serve.stripPrefix=false
zuul.routes.record-serve.url=http://192.168.1.126:10007/

通过查看zuul配置文件的部分源码可以看到各项的默认值，

@ConfigurationProperties("zuul")
public class ZuulProperties {
    public static final List<String> SECURITY_HEADERS = Arrays.asList("Pragma", "Cache-Control", "X-Frame-Options", "X-Content-Type-Options", "X-XSS-Protection", "Expires");
    private String prefix = "";
    private boolean stripPrefix = true;
    private Boolean retryable = false;
    private boolean addProxyHeaders = true;
    private boolean addHostHeader = false;
    private boolean ignoreSecurityHeaders = true;
    private boolean forceOriginalQueryStringEncoding = false;
    private String servletPath = "/zuul";
    private boolean ignoreLocalService = true;
    private ZuulProperties.Host host = new ZuulProperties.Host();
    private boolean traceRequestBody = true;
    private boolean removeSemicolonContent = true;
    private Set<String> sensitiveHeaders = new LinkedHashSet(Arrays.asList("Cookie", "Set-Cookie", "Authorization"));
    private boolean sslHostnameValidationEnabled = true;
    private ExecutionIsolationStrategy ribbonIsolationStrategy;
    private ZuulProperties.HystrixSemaphore semaphore;

(2)zuul不能通过服务名称路由的问题

第一，注意是否整合了eureka注册中心和是否在设置项目启动配置时使用的是@EnableZuulProxy和@EnableEurekaClient的组合，只有将zuul注册到eureka中和使用EnableZuulServer的升级版EnableZuulProxy才能够通过服务名称找到对应的服务服务地址。
第二，确认使用的是netfilix ribbon HttpClient client。如果没有使用下面代码配置开启，如果没有设置，zuul默认使用apache httpclient.

ribbon.restclient.enabled = true