SpringCloud教程(Finchley版本)-07：网关（Zuul）-白红宇的个人博客

SpringCloud教程(Finchley版本)-07：网关（Zuul）

发布日期：2021-06-30 11:07:42 浏览次数：2 分类：技术文章

本文共 3658 字，大约阅读时间需要 12 分钟。

在微服务架构中，后端服务往往不会直接开放给调用端，而是通过一个网关根据请求的url，路由到相应的服务。当添加网关后，在第三方调用端和服务提供方之间就创建了一面墙，这面墙直接与调用方通信进行权限控制，后将请求均衡分发给后台服务端。在Spring Cloud体系中， Spring Cloud Zuul就起到了网关的作用，它可以提供动态路由，监控，弹性，安全等的边缘服务。本文示例一下zuul的简单使用，主要分为以下几个步骤：

1.创建项目

2.引入依赖

3.修改配置文件

4.添加启动注解

5.自定义Filter

6.启动项目，测试

1.创建项目

新建一个Springboot项目zuul_server1。

2.引入依赖


   		
   			
    
     org.springframework.cloud
    			
    
     spring-cloud-starter-netflix-eureka-client
    		
   		
   		
   			
    
     org.springframework.cloud
    			
    
     spring-cloud-starter-netflix-zuul


   		
    			
     				
      
       org.springframework.cloud
      				
      
       spring-cloud-dependencies
      				
      
       ${spring-cloud.version}
      				
      
       pom
      				
      
       import


   
    Finchley.SR2

3.修改配置文件

zuul需要注册到eureka上，然后我们配置路由，配置指定类型的请求路由到指定的服务上：当请求path是以/api-a/开头的，就转发到feign-server1服务上，当请求path是以/api-b/开头的，就转发到service-ribbon服务上，如果有其他路由，在routes下继续添加即可：

server:  port: 8018spring:  application:    name: zuul-servereureka:  client:    service-url:      default: http://localhost:8761/eurekazuul:  routes:    apia:      path: /api-a/**      serviceId: feign-server1    apib:      path: /api-b/**      serviceId: service-ribbon

4.添加启动注解

//开启zuul的功能@EnableZuulProxy@EnableEurekaClient@EnableDiscoveryClient@SpringBootApplicationpublic class ZuulServer1Application {	public static void main(String[] args) {		SpringApplication.run(ZuulServer1Application.class, args);	}}

5.自定义Filter

zuul提供的功能，不仅仅是路由，我们还可以把所有的请求，在网关这一层，做个安全的校验，过滤，或者，也可以做一些其的处理。这里做个简单的token是否为空的校验，我们需要用到Filter.

Filter是Zuul的核心，用来实现对外服务的控制。Filter的生命周期有4个，分别是“PRE”、“ROUTING”、“POST”、“ERROR”,Zuul大部分功能都是通过过滤器来实现的，这些过滤器类型对应于请求的典型生命周期。

PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

ROUTING：这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并使用Apache HttpClient或Netfilx Ribbon请求微服务。

POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

ERROR：在其他阶段发生错误时执行该过滤器。除了默认的过滤器类型，Zuul还允许我们创建自定义的过滤器类型。例如，我们可以定制一种STATIC类型的过滤器，直接在Zuul中生成响应，而不将请求转发到后端的微服务。

此部分更具体的内容，可以参考：

我们来自定义一个Filter，用来校验token是否为空，自定义Filter，需要继承ZuulFilter，并实现其中的一些方法。我们在run中，多请求做个校验，当token为空时，就直接返回，不再向后端服务转发。

@Componentpublic class RequestFilter extends ZuulFilter{  private static Logger logger = LoggerFactory.getLogger(RequestFilter.class);  /**   * pre 路由之前   * routing 路由之时   * post 路由之后   * error 发送错误调用   * @return   */  @Override  public String filterType() {    return "pre";  }  /**过滤的顺序，数字越小越先执行*/  @Override  public int filterOrder() {    return 0;  }  /**这里可以写逻辑判断，是否要过滤，true表示过滤，false表示不过滤*/  @Override  public boolean shouldFilter() {    return true;  }  /**filter需要执行的具体操作*/  @Override  public Object run() throws ZuulException {    RequestContext currentContext = RequestContext.getCurrentContext();    HttpServletRequest request = currentContext.getRequest();    String token = request.getParameter("token");    if(StringUtils.isEmpty(token)){      logger.warn("=======>token is empty");      currentContext.setSendZuulResponse(false);//不对其进行路由      currentContext.setResponseStatusCode(401);      try {        currentContext.getResponse().getWriter().write("token is empty");      }catch (Exception ex){        ex.printStackTrace();      }    }else {      currentContext.setSendZuulResponse(true);//进行路由      currentContext.setResponseStatusCode(200);    }    return null;  }}