SpringCloud Zuul 路由映射规则配置

阅读目录

• 前言
• 快速入门
• 路由详解
• Cookie与头信息
• 本地跳转
• Hystrix和Ribbon支持
• 过滤器解释
• 动态加载
• 后记

回到目录

前言

本文起笔于2018-06-26周二，接了一个这周要完成的开发任务，需要先等其他人的接口，可能更新的会慢一些，还望大家见谅。这篇博客我们主要讲Spring Cloud Zuul。项目地址：我的github

Spring Cloud Zuul大家可以理解为一个集网关（路由）、负载均衡、校验过滤、结合服务治理框架、请求转发时熔断机制、服务聚合等 一系列功能。我们可以将Zuul当成一个门面，所有外部请求都经过Zuul的转发到具体的服务实例，减少了每个服务之间互相鉴权代码冗余问题，统一交给Zuul进行鉴权，在此基础上集成上边说的高级功能。路由功能相当于反向代理。

回到目录

快速入门

1. 构建网关

项目结构：

创建一个新的Model，取名为ZuulGateway，pom文件如下：

<?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>
<span class="hljs-tag">&lt;<span class="hljs-name">groupId</span>&gt;</span>com.cnblogs.hellxz<span class="hljs-tag">&lt;/<span class="hljs-name">groupId</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">artifactId</span>&gt;</span>ZuulGateway<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">version</span>&gt;</span>1.0-SNAPSHOT<span class="hljs-tag">&lt;/<span class="hljs-name">version</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">parent</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">groupId</span>&gt;</span>org.springframework.cloud<span class="hljs-tag">&lt;/<span class="hljs-name">groupId</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">artifactId</span>&gt;</span>spring-cloud-starter-parent<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">version</span>&gt;</span>Dalston.SR5<span class="hljs-tag">&lt;/<span class="hljs-name">version</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">relativePath</span>/&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">parent</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">dependencies</span>&gt;</span>
    <span class="hljs-comment">&lt;!-- Spring Cloud Zuul的依赖 --&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">dependency</span>&gt;</span>
        <span class="hljs-tag">&lt;<span class="hljs-name">groupId</span>&gt;</span>org.springframework.cloud<span class="hljs-tag">&lt;/<span class="hljs-name">groupId</span>&gt;</span>
        <span class="hljs-tag">&lt;<span class="hljs-name">artifactId</span>&gt;</span>spring-cloud-starter-zuul<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId</span>&gt;</span>
    <span class="hljs-tag">&lt;/<span class="hljs-name">dependency</span>&gt;</span>

<span class="hljs-tag">&lt;/<span class="hljs-name">dependencies</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">build</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">plugins</span>&gt;</span>
        <span class="hljs-tag">&lt;<span class="hljs-name">plugin</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">groupId</span>&gt;</span>org.springframework.boot<span class="hljs-tag">&lt;/<span class="hljs-name">groupId</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">artifactId</span>&gt;</span>spring-boot-maven-plugin<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId</span>&gt;</span>
        <span class="hljs-tag">&lt;/<span class="hljs-name">plugin</span>&gt;</span>
        <span class="hljs-tag">&lt;<span class="hljs-name">plugin</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">groupId</span>&gt;</span>org.apache.maven.plugins<span class="hljs-tag">&lt;/<span class="hljs-name">groupId</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">artifactId</span>&gt;</span>maven-compiler-plugin<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">configuration</span>&gt;</span>
                <span class="hljs-tag">&lt;<span class="hljs-name">source</span>&gt;</span>1.8<span class="hljs-tag">&lt;/<span class="hljs-name">source</span>&gt;</span>
                <span class="hljs-tag">&lt;<span class="hljs-name">target</span>&gt;</span>1.8<span class="hljs-tag">&lt;/<span class="hljs-name">target</span>&gt;</span>
            <span class="hljs-tag">&lt;/<span class="hljs-name">configuration</span>&gt;</span>
        <span class="hljs-tag">&lt;/<span class="hljs-name">plugin</span>&gt;</span>
    <span class="hljs-tag">&lt;/<span class="hljs-name">plugins</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">build</span>&gt;</span>

</project>

注意：spring-cloud-starter-parent的版本用的Dalston.SR5，原因是我发现如果用1.5.9.RELEASE并不会给给zuul的依赖引用进来，还需要额外指定版本号，Dalston.RELEASE也是不能引入依赖的，如果想使用1.5.9.RELEASE，使用spring-boot-starter-parent指定1.5.9.RELEASE版本，并在下边的依赖中指定spring-cloud.version为RELEASE即可

  <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>

创建主类ZuulApp

package com.cnblogs.hellxz;
import org.springframework.boot.SpringApplication;

import org.springframework.cloud.client.SpringCloudApplication;

import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
@EnableZuulProxy //开启zuul网关服务功能

@SpringCloudApplication

public class ZuulApp {
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> </span>{
    SpringApplication.run(ZuulApp.class, args);
}

}

2. 请求路由

a. 传统路由实现方式

在resources包下创建application.yml

spring:
  application:
    name: zuul-gateway
server:
  port: 5555
zuul:

  routes:

    traditional-url:                             #传统的路由配置,此名称可以自定义

      path: /tr-url/**                           #映射的url

      url: http://localhost:9001/                #被映射的url

这里使用了传统路由的方式先做一个展示，之后 会整合Eureka注册中心实现

测试一下，分别启动注册中心、服务提供者、FeignCustomer、刚建好的zuul项目，我们直接访问zuul项目，使用映射的url进行测试

如上图，请求被转发到了http://localhost:9001/feign/hello接口

b. 面向服务的路由

使用传统路由对运维人员很不友好，需要大量的时间去维护路由的映射关系，需要转发的url少倒还好，多起来就会更容易配置出错。

为了解决这个问题，Spring Cloud Zuul实现了与Spring Cloud Eureka的无缝结合，让path不是映射到具体url上，而是映射到某个具体的服务上，具体的url交给Eureka的服务发现机制去自动维护，这类路由称为面向服务的路由。

将Zuul注册到中心的服务的同时，Zuul同时能够获取当前注册中心中的服务清单，从清单中挑出实例进行请求转发，从而达到请求转发的完整路由机制。

改造我们之前的项目，为pom.xml添加Eureka的依赖，使zuul项目注册到注册中心中

        <!-- Eureka的依赖 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>

修改application.yml，在zuul.routes节点下加入配置，为了防止出错，这里给出了包含上文中的传统路由配置，这里要注意的是面向服务的路由需要指定注册中心的地址

zuul:
  routes:
    traditional-url:                             #传统的路由配置,此名称可以自定义
      path: /tr-url/**                           #映射的url
      url: http://localhost:9001/                #被映射的url
    orient-service-url:                          #面向服务的路由配置,此名称可以自定义
      path: /os-url/**
      service-id: feign-customer                 #服务名
eureka:

  client:

    serviceUrl:

      defaultZone: http://peer1:1111/eureka/

重启zuul项目，postman进行测试，结果相同，路由正常

这里为了方便都映射到了http://localhost:9001/也就是feign-customer的项目，大家可以自行体验

3. 请求过滤

微服务应用中的每个客户端在提供服务的接口时，都会将访问权限加以限制，并不会放开所有的接口，为了安全，我们应该为每个微服务加入校验签名和鉴权等的过滤器或者拦截器，这样一来，会增加日后系统的维护难度，同时大部分的校验和鉴权的逻辑代码是相同的，那么我们就应该将这些重复逻辑提取出来，上文中曾说到“Zuul相当于整个微服务系统的门面”，那么接下来我们来看下在zuul网关中实现客户端的请求校验，即Spring Cloud Zuul 的核心功能之一的请求过滤

我们先定义一个简单的Zuul过滤器，实现检查HttpServletRequest中是否有accessToken参数，如果有就进行路由，没有则拒绝访问，还回 401 Unauthorized 错误

创建一个filter包下创建AccessFilter，继承ZuulFilter并重写以下方法

package com.cnblogs.hellxz.filter;
import com.netflix.zuul.ZuulFilter;

import com.netflix.zuul.context.RequestContext;

import org.apache.commons.lang.StringUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
/**


访问过滤器

*/

@Component

public class AccessFilter extends ZuulFilter {
private final Logger logger = LoggerFactory.getLogger(AccessFilter.class);
/**

过滤器类型选择：
pre 为路由前
route 为路由过程中
post 为路由过程后
error 为出现错误的时候
同时也支持static ，返回静态的响应，详情见StaticResponseFilter的实现
以上类型在会创建或添加或运行在FilterProcessor.runFilters(type)

*/

@Override

public String filterType() {

return "pre"; //ZuulFilter源码中注释"pre"为在路由前过滤

}

/**

用来过滤器排序执行的
@return 排序的序号

*/

@Override

public int filterOrder() {

return 0;

}

/**

是否通过这个过滤器，默认为true，改成false则不启用

*/

@Override

public boolean shouldFilter() {

return false; //返回true表示执行这个过滤器

}

/**

过滤器的逻辑

*/

@Override

public Object run() {

//获取当前请求上下文

RequestContext ctx = RequestContext.getCurrentContext();

//取出当前请求

HttpServletRequest request = ctx.getRequest();

logger.info("进入访问过滤器，访问的url:{}，访问的方法：{}",request.getRequestURL(),request.getMethod());

//从headers中取出key为accessToken值

String accessToken = request.getHeader("accessToken");//这里我把token写进headers中了

//这里简单校验下如果headers中没有这个accessToken或者该值为空的情况

//那么就拦截不入放行，返回401状态码

if(StringUtils.isEmpty(accessToken)) {

logger.info("当前请求没有accessToken");

//使用Zuul来过滤这次请求

ctx.setSendZuulResponse(false);

ctx.setResponseStatusCode(401);

return null;

}

logger.info("请求通过过滤器");

return null;

}

}