十一.SpringCloud极简入门-服务网关-spring cloud zuul

雨点打透心脏的1/2处 2023-07-18 09:34 20阅读 0赞

老鸟飞过，只做学习使用，欢迎交流

## 十一.服务网关-spring cloud zuul ##

### 1.理解zuul ###

#### 1.1.为什么要zuul ####

试想一下如果我们有很多的微服务，他们都需要登录之后才能访问，那么我需要在每个微服务都去做一套登录检查逻辑，这样是不是会存在大量重复的代码和工作量，我们希望的是把登录检查这种公共的逻辑进行统一的抽取，只需要做一套检查逻辑即可，而zuul就可以用来干这类事情，我们可以把zuul看做是微服务的大门，所有的请求都需要通过zuul将请求分发到其他微服务，根据这一特性我们就可以在zuul做统一的登录检查，下游的微服务不再处理登录检查逻辑。

#### 1.2.什么是zuul ####

Zuul 是netflix开源的一个API Gateway 服务器, 本质上是一个web servlet(filter)应用。Zuul 在云平台上提供动态路由(请求分发)，监控，弹性，安全等边缘服务的框架。Zuul 相当于是设备和 Netflix 流应用的 Web 网站后端所有请求的前门，也要注册入Eureka，用一张图来理解zuul在架构中的的角色：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0OTQxNDg_size_16_color_FFFFFF_t_70_pic_center]

需要注意的是，zuul本身是一个独立的服务，默认集成了Ribbon，zuul通过Ribbon将客户端的请求分发到下游的微服务，所以zuul需要通过Eureka做服务发行，同时zuul也集成了Hystrix。

根据上图理解 ，我们需要建立独立的工程去搭建Zuul服务，同时需要把Zuul注册到EurekaServer,因为当请求过来时，zuul需要通过EurekaServer获取下游的微服务通信地址，使用Ribbon发起调用。

### 2.zuul的搭建 ###

搭建zuul工程springcloud-zuul-server-1060 ,搭建好的工程模块如下：

springcloud-parent
    pom.xml
    	springcloud-zuul-server-1060	//网关服务
    	springcloud-hystrix-turbine-1050 //聚合监控服务
    	springcloud-eureka-server-1010
    	springcloud-order-server-1030
    	springcloud-pay-server-1040
    	springcloud-user-common
    	springcloud-user-server-1020

修改 springcloud-zuul-server-1060 ，集成EurekaClient和zuul

#### 2.1.导入依赖 ####

因为Zuul需要通过Eureak做服务发现，所以我们导入了eureka-client基础依赖，和Zuul自身的基础依赖：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">
        <parent>
            <artifactId>springcloud-parent</artifactId>
            <groupId>cn.itsource.springboot</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>springcloud-zuul-server-1060</artifactId>
    
        <name>springcloud-zuul-server-1060</name>
    
        <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>
        </dependencies>
    </project>

#### 2.2.配置开开启Zuul ####

配置类通过 @EnableZuulProxy 注解开启zuul服务功能。

/** * 用户的启动类 * @EnableEurekaClient： 标记该应用是 Eureka客户端 * @EnableZuulProxy ： 开启zuul 可以看做是 @EnableZuulServer 的增强版 ，一般用这个 * @EnableZuulServer : 这个标签也可以开启zuul，但是这个标签开启的Filter更少 */
    @SpringBootApplication
    @EnableEurekaClient
    @EnableZuulProxy
    public class ZuulServerApplication1060
    { 
    
        public static void main( String[] args )
        { 
            SpringApplication.run(ZuulServerApplication1060.class);
        }
    }

#### 2.3.配置文件配置zuul ####

这里配置两个东西，一个是EurekaClien的配置，让zuul注册到EurekaServer,二个就是zuul的配置了

#注册到EurekaServer
    eureka:
      client:
        serviceUrl:
          defaultZone: http://peer1:1010/eureka/,http://peer2:1011/eureka/,http://peer3:1012/eureka/
      #使用ip地址进行注册
      instance:
        prefer-ip-address: true
        #要指定服务的实例ID
        instance-id:  zuul-server:1060
    server:
      port: 1060
    spring:
      application:
        name: zuul-server  #服务名
    
    zuul:
      prefix: "/servers"  #统一访问前缀
      ignoredServices: "*"  #禁用掉使用浏览器通过服务名的方式访问服务
      routes:
        pay-server: "/pay/**"   #指定pay-server这个服务使用 /pay路径来访问 - 别名
        order-server: "/order/**"   #指定order-server这个服务使用 /order路径来访问

提示： 我们对zuul主要做了三个配置

*  zuul.prefix ： 作为统一的前缀，在浏览器访问的时候需要加上该前缀
 *  zuul.ignoredServices ： 忽略使用服务名方式访问服务，而是通过routes指定的路径进行访问
 *  zuul.routes : 配置服务的访问路径

注意：在么有使用zuul之前我们是通过 http://localhost:1040/pay/1 来直接访问支付服务，现在需要通过zuul来访问，格式如下：http:// zuul的ip : zuul的port /zuul前缀 / 服务路径 /服务的controller路径 ，即：

http://localhost:1060/servers/pay/pay/1

特别说明：其实这里我们直接浏览器也能访问到目标服务，即可以通过： http://localhost:1040/pay/1 绕过zuul，但是这种情况不用担心，因为在产品上线的时候我们都是内网部署，只有zuul我们部署成外网，也就是说直接访问目标微服务的方式是访问不到的，所以我们只需要通过zuul访问即可。

#### 2.4.测试zuul ####

浏览器访问：http://localhost:1060/servers/pay/pay/1 ,看到如下信息：  
![在这里插入图片描述][20200325164907506.png]  
说明我们已经成功的通过zuul访问到了pay服务

### 3.自定义zuul的Filter ###

#### 3.1.zuul的工作原理 ####

zuul的底层是通过各种Filter来实现的，zuul中的filter按照执行顺序分为了“pre”前置（”custom”自定义一般是前置），“routing”路由，“post”后置，以及“error”异常Filter组成，当各种Filter出现了异常，请求会跳转到“error filter”，然后再经过“post filter” 最后返回结果，下面是Filter的执行流程图：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0OTQxNDg_size_16_color_FFFFFF_t_70_pic_center 1]

提示：

*  正常流程：
    
     *  请求到达首先会经过pre类型过滤器，而后到达routing类型，进行路由，请求就到达真正的服务提供者，执行请求，返回结果后，会到达post过滤器。而后返回响应。
 *  异常流程：
    
     *  整个过程中，pre或者routing过滤器出现异常，都会直接进入error过滤器，再error处理完毕后，会将请求交给POST过滤器，最后返回给用户。
     *  如果是error过滤器自己出现异常，最终也会进入POST过滤器，而后返回。
     *  如果是POST过滤器出现异常，会跳转到error过滤器，但是与pre和routing不同的时，请求不会再到达POST过滤器了。

#### 3.2.ZuulFilter ####

Zuul提供了一个抽象的Filter:ZuulFilter我们可以通过该抽象类来自定义Filter，该Filter有四个核心方法，如下：

public abstract class ZuulFilter implements IZuulFilter{ 
          
        abstract public String filterType();
    
        abstract public int filterOrder();
       
    
        //下面两个方法是 IZuulFilter 提供的 
        
        boolean shouldFilter();
    
        Object run() throws ZuulException;
    
    }

提示：

*  filterType ：是用来指定filter的类型的（类型见常量类：FilterConstants）
 *  filterOrder ：是filter的执行顺序，越小越先执行
 *  shouldFilter ：是其父接口IZuulFilter的方法，用来决定run方法是否要被执行
 *  run ：是其父接口IZuulFilter的方法，该方法是Filter的核心业务方法

#### 3.3.自定义Filter ####

我们来演示一个案例，在Zuul层实现统一的登录检查：如果请求头中有“token”属性，我们就认为已经登录成功，可以继续往下游的服务执行，否则就视为请求未登录，直接返回错误信息，这一需求需要自定义Filter继承ZuulFilter类来实现，具体代码如下

package cn.itsource.springboot.filter;
    
    import com.alibaba.fastjson.JSON;
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    import com.netflix.zuul.exception.ZuulException;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
    import org.springframework.stereotype.Component;
    import org.springframework.util.StringUtils;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    import java.util.HashMap;
    import java.util.Map;
    
    @Component
    public class LoginCheckFilter extends ZuulFilter { 
    
        private static final Logger log = LoggerFactory.getLogger(LoginCheckFilter.class);
    
        //执行顺序
        private static final int ORDER = 1;
    
        //filter类型 : "pre"前置
        @Override
        public String filterType() { 
            return FilterConstants.PRE_TYPE;	//pre
        }
    
        //执行顺序
        @Override
        public int filterOrder() { 
            return ORDER;
        }
    
        //返回结果决定 是否要执行run方法
        @Override
        public boolean shouldFilter() { 
            // /static/** ，/login , /register 不需要做登录检查，返回false
            //1.获取request对象 ， 获取请求中的url
            HttpServletRequest request = RequestContext.getCurrentContext().getRequest();
            String url = request.getRequestURI();
            log.info("请求地址："+url);
            //2.判断是否包含在： static/** ，/login , /register
            if(url.endsWith("/login ") || url.endsWith("/register ") || url.contains("/static/") ){ 
                return false;
            }
            //要做登录检查的返回true
            return true;
        }
    
        //核心业务方法 ： 登录检查 ， 如果请求头中有token，就是登录成功
        @Override
        public Object run() { 
            //1.获取请求对象
            HttpServletRequest request = RequestContext.getCurrentContext().getRequest();
    
            //响应对象
            HttpServletResponse response = RequestContext.getCurrentContext().getResponse();
    
    
            //2.获取请求头中的 token
            String token = request.getHeader("token");
    
            //3.如果没有token，登录检查失败 ，
            if(!StringUtils.hasLength(token)){ 
                //3.1.返回登录检查失败的错误信息 :{ success:false, message:"登录检查失败，请重新登录"}
                Map<String,Object> resultMap = new HashMap<>();
                resultMap.put("success" , false);
                resultMap.put("message" , "登录检查失败，请重新登录");
                //中文编码
                response.setContentType("application/json;charset=utf-8");
                //把map转成json字符串，写到浏览器
                String resultJsonString = JSON.toJSONString(resultMap);
    
                response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
    
                try { 
                    response.getWriter().print(resultJsonString);
                } catch (IOException e) { 
                    e.printStackTrace();
                }
    
                //3.2.阻止filter继续往后执行
                RequestContext.getCurrentContext().setSendZuulResponse(false);
    
            }
    
            //这里的返回结果没有任何意义，不用管
            return null;
        }
    }

提示:

*  在 filterType方法中我们返回“pre”前置filter的常量，让他成为前置filter(登录检查需要在请求的最前面来做)
 *  在filterOrder方法中返回的顺序值是 1 ，执行顺序越小越先执行
 *  在shouldFilter方法中通过判断请求的url来决定是否需要做登录检查，返回true就是要做然后才会执行run方法
 *  在run方法中我们通过获取请求头中的token判断是否登录，如果没登录就返回错误信息，阻止继续执行。
 *  RequestContext.getCurrentContext() 是一个Zuul提供的请求上下文对象

注意：在返回JSON格式的错误信息时我用到了fastjson，需要在zuul工程中导入依赖

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.50</version>
    </dependency>

#### 3.4.测试 ####

启动zuul，浏览器访问：http://localhost:1060/servers/pay/1 ，当没登录的情况下浏览器应该会返回如下信息代表登录检查起作用了：  
![在这里插入图片描述][20200325170501462.png]  
使用postmain，发送post请求，在header中添加token值，如下：![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0OTQxNDg_size_16_color_FFFFFF_t_70]

#### 4.zuul的熔断器配置 ####

zuul作为服务网关面向的是客户端(浏览器)，当服务调用链路出现异常,我们不希望直接把异常信息抛给客户端,而是希望触发降级，返回友好的提示信息，所以我们需要去配置zuul的熔断机制。

在zuul中要实现熔断功能需要实现ZuulFallbackProvider接口，该接口提供了两个方法：getRoute用来指定熔断功能应用于哪些路由的服务，fallbackResponse方法为熔断功能时执行的方法(用来返回托底数据) ,接口代码如下：

public interface FallbackProvider { 
    
    	/** * The route this fallback will be used for. * @return The route the fallback will be used for. */
    	public String getRoute();
    
    	/** * Provides a fallback response based on the cause of the failed execution. * * @param route The route the fallback is for * @param cause cause of the main method failure, may be <code>null</code> * @return the fallback response */
    	ClientHttpResponse fallbackResponse(String route, Throwable cause);
    }

#### 4.1.编码实战 ####

我们来对对pay-server做一个熔断器配置，当zuul先pay-server发起调用，服务调用失败，触发熔断，返回一句话“抱歉，服务不可用”

import java.io.ByteArrayInputStream;
    import java.io.IOException;
    import java.io.InputStream;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.cloud.netflix.zuul.filters.route.FallbackProvider;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.HttpStatus;
    import org.springframework.http.MediaType;
    import org.springframework.http.client.ClientHttpResponse;
    import org.springframework.stereotype.Component;
    
    
    @Component
    public class PayServerFallback implements FallbackProvider { 
        private final Logger logger = LoggerFactory.getLogger(FallbackProvider.class);
    
        // 指定要处理的服务。
        @Override
        public String getRoute() { 
            return "pay-server";  //"*"代表所有服务都有作用
        }
    
        /** * @param route :服务的路由 * @param cause ： 异常 * @return ClientHttpResponse：熔断后的换回值 */
        @Override
        public ClientHttpResponse fallbackResponse(String route, Throwable cause) { 
            return new ClientHttpResponse() { 
                @Override
                public HttpStatus getStatusCode() throws IOException { 
                    return HttpStatus.OK;
                }
    
                @Override
                public int getRawStatusCode() throws IOException { 
                    return 200;
                }
    
                @Override
                public String getStatusText() throws IOException { 
                    return "OK";
                }
    
                @Override
                public void close() { 
    
                }
    
                @Override
                public InputStream getBody() throws IOException { 
                    return new ByteArrayInputStream("抱歉，服务不可用".getBytes());
                }
    
                @Override
                public HttpHeaders getHeaders() { 
                    HttpHeaders headers = new HttpHeaders();
                    headers.setContentType(MediaType.APPLICATION_JSON);
                    return headers;
                }
            };
        }
    }

提示：如果要让此熔断功能作用于所有的服务，将 getRoute 方法中的返回值修改为“\*”即可。

#### 4.2.测试 ####

浏览器访问：http://localhost:1060/servers/pay/1 ,关闭支付服务，浏览器应该会看到 “抱歉，服务不可用” 提示信息。  
![在这里插入图片描述][20200325174803476.png]

### 5.zuul的参数配置 ###

#### 5.1.超时配置 ####

Zuul集成了hystrix，如果服务的调用  
链过长，或者ribbon调用事件过长，可能会触发Hystrix的熔断机制，导致请求拿不到正常的结果，我们通常会对Ribbon和Hystrix的超时时间配置。如下配置对所有消费者微服务都有用：

zuul配置文件加上如下配置：

zuul:
      retryable: true #是否开启重试功能
    ribbon:
      MaxAutoRetries: 1 #对当前服务的重试次数
      MaxAutoRetriesNextServer: 1 #切换相同Server的次数
      OkToRetryOnAllOperations: false # 对所有的操作请求都进行重试，如post就不能重试，如果没做幂等处理，重试多次post会造成数据的多次添加或修改
      ConnectTimeout: 3000 #请求连接的超时时间
      ReadTimeout: 5000 #请求处理的超时时间
    hystrix:
      command:
        default:
          execution:
            isolation:
              thread:
                timeoutInMilliseconds: 10000
                #如果配置ribbon的重试，hystrix的超时时间要大于ribbon的超时时间

#### 5.2.zuul的饥饿加载 ####

在学习Ribbon的章节我们为了让服务加快第一次调用，我们可以通过设置Ribbon的饥饿加载，zuul底层通过Ribbon实现负载均衡器，所以也需要指定饥饿加载，配置如下：

zuul:
      ribbon:
        eager-load.enabled: true # 饥饿加载

需要注意的是，zuul是通过读取路由配置来实现饥饿加载的，所以如果要让eager-load.enabled: true起作用，我们一般不会使用默认的路由方式，而是单独配置路由规则，如上配置。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0OTQxNDg_size_16_color_FFFFFF_t_70_pic_center]: /images/20230528/17beada45fd64612a006c89a15c9afd1.png
[20200325164907506.png]: /images/20230528/05675103151d4eb683a0ca28e78e07bb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0OTQxNDg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20230528/8070ac0b68714ad08cc76a8527ac0955.png
[20200325170501462.png]: /images/20230528/b0edf421f8124e9595645bcd945a72f5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0OTQxNDg_size_16_color_FFFFFF_t_70]: /images/20230528/94bf6a0961754663a95548f6fb7b313b.png
[20200325174803476.png]: /images/20230528/e482d5315a694111bd1963b79379b519.png