SpringCloud之动态路由（Zuul）|第五章-yellowcong

r囧r小猫 2022-05-29 03:58 188阅读 0赞

> 在SpringCloud的这个微服务系统中，所有的请求经过nginx做了负载均衡后，然后又到了zuul，来做一次负载均衡的分流处理操作。在springboot中，zuul主要实现了两个功能：1、用户分流处理，2、过滤 用户的请求。对于搭建动态路由(zuul)，主要 有一下几个步骤：1、配置pom.xml，添加`spring-cloud-starter-zuul`的依赖，2、配置application.yml，设置分流操作，3、配置启动类，添加`@EnableZuulProxy`注解，开启动态路由，4、配置过滤器，实现`ZuulFilter`抽象类，5、配置过滤器到启动类。第4和第5步，不是非必须的，而是自定义过滤器的操作

## 架构图 ##

这个架构图是我从[方志朋][Link 1]那儿偷过来的，zuul 这一层，可以用来做分流处理，对不同的业务，分流到指定的系统集群里面，然后通过ribbion和feign来调用服务。

![这里写图片描述][SouthEast]

## 代码地址 ##

https://gitee.com/yellowcong/springcloud/tree/master/chapter5

### 目录结构 ###

![这里写图片描述][SouthEast 1]

### 项目架构 ###

<table> 
 <thead> 
  <tr> 
   <th>节点</th> 
   <th>服务</th> 
   <th>项目名</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>yellowcong.com:8761</td> 
   <td>eureka注册服务</td> 
   <td>eureka-server</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8762</td> 
   <td>提供服务1</td> 
   <td>eureka-client</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8763</td> 
   <td>提供服务2</td> 
   <td>eureka-client2</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8764</td> 
   <td>ribbon服务</td> 
   <td>ribbon-server</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8765</td> 
   <td>feign服务</td> 
   <td>feign-server</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8766</td> 
   <td>zuul服务</td> 
   <td>zuul-server</td> 
  </tr> 
 </tbody> 
</table>

项目的架构图  
![这里写图片描述][SouthEast 2]

## 动态路由搭建（Zuul） ##

> 对于搭建动态路由(zuul)，主要 有一下几个步骤：1、配置pom.xml，添加`spring-cloud-starter-zuul`的依赖，2、配置application.yml，设置分流操作，3、配置启动类，添加`@EnableZuulProxy`注解，开启动态路由

### 1、配置pom.xml ###

想要zuul的动态路由，就必须得导入`spring-cloud-starter-zuul`的依赖，但是这个地方，有个问题，由于 jar包的冲突问题，我们要排除掉`spring-cloud-starter-eureka-server`中的`servlet-api`依赖包，

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-eureka-server</artifactId>
        <version>1.3.0.RELEASE</version>
        <exclusions>
           <exclusion>
               <groupId>javax.servlet</groupId>
               <artifactId>servlet-api</artifactId>
           </exclusion>
       </exclusions>
    </dependency>
    
    <dependency>
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-zuul</artifactId>
             <version>1.3.0.RELEASE</version>
         </dependency>

下面是完整的pom.xml配置

<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>
    
        <groupId>yellowcong.com</groupId>
        <artifactId>cas-client-springboot</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>cas-client-springboot</name>
        <url>http://maven.apache.org</url>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
        
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.10.RELEASE</version>
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
    
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</artifactId>
                <version>1.3.0.RELEASE</version>
                <exclusions>
                    <exclusion>
                        <groupId>javax.servlet</groupId>
                        <artifactId>servlet-api</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-zuul</artifactId>
                <version>1.3.0.RELEASE</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
        </dependencies>
        <build>
            <plugins>
                
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <dependencies>
                        <dependency>
                            <groupId>org.springframework</groupId>
                            <artifactId>springloaded</artifactId>
                            <version>1.2.4.RELEASE</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>
    </project>

### 2、配置application.yml ###

通过配置application.yml 来实现分流的操作，通过配置zuul.routes.<自定义名称>.path ，来配置不同请求，对应着不同的服务，实现了根据服务来分流。

下面的这段配置中，我将以`/ribbon`开头的请求，都发送到`service-ribbon`处理；以`/feign`开头的请求，都发送到`service-feign`处理

#配置eureka 的注册中心
    eureka:
      client:
        serviceUrl:
          defaultZone: http://yellowcong.com:8761/eureka/
    
    # 注册服务的端口
    server:
      port: 8766
    
    #配置当前服务的名称
    spring:
      application:
        name: service-zuul
    
    #配置路由规则 
    zuul:
      routes:
        app-a:
          path: /ribbon/** serviceId: service-ribbon app-b: path: /feign/** serviceId: service-feign

### 3、配置启动器 ###

通过添加`@EnableZuulProxy`注解，让动态路由生效

## 添加自定义过滤器 ##

> 1、配置过滤器，实现`ZuulFilter`抽象类，2、配置过滤器到启动类。第4和第5步，不是非必须的，而是自定义过滤器的操作

### 1、创建自定义过滤器 ###

自定义过滤器，需要实现`ZuulFilter`，然后复写里面的方法，主要是在run这个函数里面，添加过滤的逻辑处理操作，我这个逻辑处理操作是，只要带有token的参数，就处理这个请求，如果不带，就直接返回401状态码，并返回错误信息。

package com.yellowcong.filter;
    
    import javax.servlet.http.HttpServletRequest;
    
    import org.springframework.stereotype.Component;
    
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    
    /** * 创建日期:2018年3月16日 <br/> * 创建用户:yellowcong <br/> * 功能描述:自定义过滤器，需要实现ZuulFilter */
    @Component
    public class TokenFilter extends ZuulFilter { 
    
        /** * 过滤器的具体逻辑 ctx.setSendZuulResponse(false)令zuul不允许请求， * ctx.setResponseStatusCode(401)设置了其返回的错误码 * ctx.setResponseBody(body)编辑返回body内容 * * @return */
        @Override
        public Object run() {
            RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
    
            //获取token 的参数
            String token = request.getParameter("token");
            if(token == null) {
                //zuul不处理这条请求
                ctx.setSendZuulResponse(false);
                //设定返回的错误代码
                ctx.setResponseStatusCode(401);
    
                //写数据到浏览器
                ctx.setResponseBody("token is null");
                return null;
            }
            return null;
        }
    
        /** * 判断过滤器是否执行 * 本文true,永远过滤 */
        @Override
        public boolean shouldFilter() {
            return true;
        }
    
        /** * 通过int值来定义过滤器的执行顺序 */
        @Override
        public int filterOrder() {
            return 0;
        }
    
        /** * 返回过滤器类型 * * @return pre：可以在请求被路由之前调用 * routing：在路由请求时候被调用 * post：在routing和error过滤器之后被调用 * error：处理请求时发生错误时被调用 */
        @Override
        public String filterType() {
            return "pre";
        }
    
    }

### 2、注册过滤器到启动类 ###

package com.yellowcong;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    import org.springframework.context.annotation.Bean;
    
    import com.yellowcong.filter.TokenFilter;
    
    @SpringBootApplication
    @EnableDiscoveryClient
    //配置@EnableZuulProxy 注解 ，让动态路由生效
    @EnableZuulProxy
    public class ConfigMain { 
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigMain.class, args);
        }
    
        /** * 创建日期:2018年3月16日<br/> * 创建用户:yellowcong<br/> * 功能描述:注册过滤器 * @return */
        @Bean
        public TokenFilter getZuulFilter(){
            return new TokenFilter();
        }
    }

## 启动测试 ##

这个地方，我就简单测试了， 我将提供服务的两个都给关掉了，但是启动了 feign和ribbon，这样处于熔断的状态，就可以测试zuul是否有分流的效果了。

<table> 
 <thead> 
  <tr> 
   <th>项目名</th> 
   <th>启动顺序</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>eureka-server</td> 
   <td>1</td> 
  </tr> 
  <tr> 
   <td>eureka-client</td> 
   <td>2（不启动）</td> 
  </tr> 
  <tr> 
   <td>eureka-client2</td> 
   <td>3（不启动）</td> 
  </tr> 
  <tr> 
   <td>feign-server</td> 
   <td>4</td> 
  </tr> 
  <tr> 
   <td>ribbon-server</td> 
   <td>5</td> 
  </tr> 
  <tr> 
   <td>zuul-server</td> 
   <td>6</td> 
  </tr> 
 </tbody> 
</table>

访问节点 [http://yellowcong.com:8761][http_yellowcong.com_8761] ,查看到提供服务的两个节点已经挂掉了。  
![这里写图片描述][SouthEast 3]

### 测试访问 ###

<table> 
 <thead> 
  <tr> 
   <th>地址</th> 
   <th>结果</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="http://yellowcong.com:8766/feign/hi/xx?token=12" rel="nofollow">http://yellowcong.com:8766/feign/hi/xx?token=12</a></td> 
   <td>feign 系统</td> 
  </tr> 
  <tr> 
   <td><a href="http://yellowcong.com:8766/ribbon/hi/xx?token=12" rel="nofollow">http://yellowcong.com:8766/ribbon/hi/xx?token=12</a></td> 
   <td>ribbon系统</td> 
  </tr> 
  <tr> 
   <td><a href="http://yellowcong.com:8766/ribbon/hi/xx" rel="nofollow">http://yellowcong.com:8766/ribbon/hi/xx</a></td> 
   <td>报异常</td> 
  </tr> 
 </tbody> 
</table>

具体可以看下图的结果。  
![这里写图片描述][SouthEast 4]

## 常见问题 ##

### Unable to start embedded Tomcat ###

出现了不能启动tomcat的错误，这个错误的原因，多半是由于maven的依赖出了问题。

org.springframework.context.ApplicationContextException: Unable to start embedded container; nested exception is org.springframework.boot.context.embedded.EmbeddedServletContainerException: Unable to start embedded Tomcat
        at org.springframework.boot.context.embedded.EmbeddedWebApplicationContext.onRefresh(EmbeddedWebApplicationContext.java:137) ~[spring-boot-1.5.10.RELEASE.jar:1.5.10.RELEASE]
        at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:537) ~[spring-context-4.3.14.RELEASE.jar:4.3.14.RELEASE]
        at org.springframework.boot.context.embedded.EmbeddedWebApplicationContext.refresh(EmbeddedWebApplicationContext.java:122) ~[spring-boot-1.5.10.RELEASE.jar:1.5.10.RELEASE]
        at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:693) [spring-boot-1.5.10.RELEASE.jar:1.5.10.RELEASE]
        at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:360) [spring-boot-1.5.10.RELEASE.jar:1.5.10.RELEASE]
        at org.springframework.boot.SpringApplication.run(SpringApplication.java:303) [spring-boot-1.5.10.RELEASE.jar:1.5.10.RELEASE]
        at org.springframework.boot.SpringApplication.run(SpringApplication.java:1118) [spring-boot-1.5.10.RELEASE.jar:1.5.10.RELEASE]
        at org.springframework.boot.SpringApplication.run(SpringApplication.java:1107) [spring-boot-1.5.10.RELEASE.jar:1.5.10.RELEASE]
        at com.yellowcong.ConfigMain.main(ConfigMain.java:17) [classes/:na]

后来排查发现，是由于`spring-cloud-starter-eureka-server`中的servlet-api 包捣鬼，我们把他排除掉，不到入，即可解决问题了。

## 参考文章 ##

1、 [史上最简单的SpringCloud教程 | 第五篇: 路由网关(zuul)][SpringCloud_ _ _ _zuul]

2、[spring cloud学习(四) 动态路由][spring cloud_]

[Link 1]: http://blog.csdn.net/forezp
[SouthEast]: /images/20220529/42f6c388ba71479abdc6883eb6204c6c.png
[SouthEast 1]: /images/20220529/6be02f8455974c2797fe0aacad3872da.png
[SouthEast 2]: /images/20220529/be547e4338d74b82b7c9bd303fd1d022.png
[http_yellowcong.com_8761]: http://yellowcong.com:8761
[SouthEast 3]: /images/20220529/280dd02e41c9492dbd49e928fab511a4.png
[SouthEast 4]: /images/20220529/b4783e1f3cd446ebb0b1e30c6cf29b0c.png
[SpringCloud_ _ _ _zuul]: http://blog.csdn.net/forezp/article/details/69939114
[spring cloud_]: http://www.cnblogs.com/andyfengzp/p/6831696.html