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

最新推荐文章于 2024-02-19 11:40:04 发布
最新推荐文章于 2024-02-19 11:40:04 发布
阅读量4.7k 收藏 2
点赞数 2
分类专栏： springcloud 文章标签： 微服务
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yelllowcong/article/details/79580646
版权

在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步，不是非必须的，而是自定义过滤器的操作

架构图

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

这里写图片描述

代码地址

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

目录结构

这里写图片描述

项目架构

节点服务项目名
yellowcong.com:8761eureka注册服务eureka-server
yellowcong.com:8762提供服务1eureka-client
yellowcong.com:8763提供服务2eureka-client2
yellowcong.com:8764ribbon服务ribbon-server
yellowcong.com:8765feign服务feign-server
yellowcong.com:8766zuul服务zuul-server

项目的架构图
这里写图片描述

动态路由搭建（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依赖包，

<!--eureka server -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-eureka-server</artifactId>
    <version>1.3.0.RELEASE</version><!--$NO-MVN-MAN-VER$-->
    <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><!--$NO-MVN-MAN-VER$-->
     </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>

        <!--eureka server -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka-server</artifactId>
            <version>1.3.0.RELEASE</version><!--$NO-MVN-MAN-VER$-->
            <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><!--$NO-MVN-MAN-VER$-->
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>
    <build>
        <plugins>
            <!-- 添加spring的插件， 就可以直接通过 mvn spring-boot:run 运行了 -->
            <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注解，让动态路由生效 

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;

@SpringBootApplication
@EnableDiscoveryClient
//配置@EnableZuulProxy 注解 ，让动态路由生效
@EnableZuulProxy
public class ConfigMain {

    public static void main(String[] args) {
        SpringApplication.run(ConfigMain.class, args);
    }

}

添加自定义过滤器

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是否有分流的效果了。

项目名启动顺序
eureka-server1
eureka-client2（不启动）
eureka-client23（不启动）
feign-server4
ribbon-server5
zuul-server6

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

测试访问

地址结果
http://yellowcong.com:8766/feign/hi/xx?token=12feign 系统
http://yellowcong.com:8766/ribbon/hi/xx?token=12ribbon系统
http://yellowcong.com:8766/ribbon/hi/xx报异常

具体可以看下图的结果。
这里写图片描述

常见问题

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 包捣鬼，我们把他排除掉，不到入，即可解决问题了。

<!--eureka server -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-eureka-server</artifactId>
    <version>1.3.0.RELEASE</version><!--$NO-MVN-MAN-VER$-->
    <exclusions>
       <exclusion>
           <groupId>javax.servlet</groupId>
           <artifactId>servlet-api</artifactId>
       </exclusion>
   </exclusions>
</dependency>

参考文章

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

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

狂飙的yellowcong
关注
  • 2
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
专栏目录
SpringCloud Zuul实现动态路由
08-26
主要介绍了SpringCloud Zuul实现动态路由，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot - 配置文件application.yml使用详解（附：Profile多环境配置）
weixin_46916570的博客
02-09 5569
（1）YAML是 JSON 的超集，简洁而强大，是一种专门用来书写配置文件的语言，可以替代 application.properties。（2）在创建一个 SpringBoot 项目时，引入的 spring-boot-starter-web 依赖间接地引入了 snakeyaml 依赖， snakeyaml 会实现对 YAML 配置的解析。（3）YAML 的使用非常简单，利用缩进来表示层级关系，并且大小写敏感。
SpringBoot多环境启动配置
无心
06-07 1497
SpringBoot多环境启动配置
Spring Cloud微服务网关Zuul动态路由配置
weixin_42008170的博客
02-19 1042
动态路由配置是很多网关在实际项目中需要用到的功能。但是像Zuul、Spring Cloud Gateway这些是没有提供完善的功能，使得需要开发者自己去实现。不像Apache Shenyu网关提供了很多开箱即用的功能，如果开发量较大，可以结合实际项目调研一下Apache Shenyu。本文提到了手动刷新路由配置并且还有可以优化的地方，但是写到这里本文的篇幅已经不短了，这一部分将在下一篇中把坑给填了。# 总结动态路由配置是很多网关在实际项目中需要用到的功能。
服务网关 Zuul基本使用
weixin_39639119的博客
08-08 3555
API 网关是一个更为智能的应用服务器，它的定义类似面向对象设计模式中的Facade模式，它的存在就像是整个微服务架构系统的门面一样，所有的外部客户端访问都需要经过它来进行调度和过滤。它除了要实现请求路由，负载均衡，校验过滤等功能之外，还需要更多能力，比如与服务治理框架的结合，请求转发时的熔断机制，服务的聚合等一系列高级功能     路由规则： zuul默认会将通过以服务名作为contex...
Spring Cloud Zuul网关 Filter、熔断、重试、高可用的使用方式。
weixin_33704591的博客
01-31 1919
时间过的很快，写springcloud(十)：服务网关zuul初级篇还在半年前，现在已经是2018年了，我们继续探讨Zuul更高级的使用方式。 上篇文章主要介绍了Zuul网关使用模式，以及自动转发机制，但其实Zuul还有更多的应用场景，比如：鉴权、流量转发、请求统计等等，这些功能都可以使用Zuul来实现。 Zuul的核心 Filter是Zuul的核心，用来实现对外服务的控制。Filter的生命周期...
Spring Cloud 九：Zuul网关介绍与使用
吃透Java
12-15 4782
一，网关 前面我们把服务治理，服务注册发现，服务调用，熔断，已经分析完了，微服务基本模块已经有了，也可以做微服务了。但完成一个复杂的业务，可能需要多个微服务合作来完成，比如下单，需要用户服务，支付服务，地图服务，订单服务。网关一般是我们对外服务的窗口，进行服务内外隔离。一般微服务都在内网，不做安全验证。网关是介于客户端（外部调用方比如app，h5）和微服务的中间层。 什么是Zuul？ Zuul作为微服务系统的网关组件，是从设备和网站到Netflix流应用程序后端的所有请求的前门。zuul作为整个应用的流量入
Spring Cloud 网关服务 zuul 动态路由的实现方法
08-25
网关服务是流量的唯一入口。不能随便停服务。所以动态路由就显得尤为必要。这篇文章主要介绍了Spring Cloud 网关服务 zuul 三 动态路由的相关知识,需要的朋友可以参考下
springcloud Zuul动态路由的实现
08-26
主要介绍了springcloud Zuul动态路由的实现，详细的介绍了什么是Zuu及其动态路由的实现，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Spring Cloud Zuul路由规则动态更新解析
08-25
主要介绍了Spring Cloud Zuul路由规则动态更新解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
spring-cloud-starter-netflix-zuul-2.0.0.RELEASE
01-17
可用的spring-cloud-starter-netflix-zuul-2.0.0.RELEASE包，maven上的spring-cloud-starter-netflix-zuul-2.0.0.RELEASE已经没了。
springcloud之zuul的配置及优化
k393393的博客
06-18 2057
zuul 是netflix开源的一个网关服务器，本质就是个servelet服务，它的两大功能，其一是过滤功能，其二是路由功能。
zuul网关 路由url与service-id配置
xwnxwn的专栏
10-07 3869
在zuul中有两种路由配置： 1. 通过访问ip及端口号映射 2.通过服务名称映射 在上节代码基础上： 首先我把服务提供者与服务消费者都开了集群： 先配置第一种： 更改网关application.yml server: port: 8090 eureka: client: service-url: default-zone: http://localhost:8761/eureka spring: application: name: ..
基于feign远程调用，自定义配置
xujiangyu1的博客
02-01 152
基于Feign的远程调用（http）
SpringCloud 之OpenFeign 自定义配置和使用/自定义拦截器
weixin_44137464的博客
10-21 4032
OpenFeign
Spring Cloud微服务网关Zuul动态路由配置优化和手动触发路由刷新
2301_76607156的博客
04-12 487
通过两篇文章讲述了Zuul网关的动态路由配置的原理和实战，接口的类图并不复杂，很多Zuul的组件在和里面注入到了Spring容器，可以看一下里面都有什么组件，并分析一下其功能，能够很快地理解Zuul的一些功能原理。
Zuul 实现动态路由
qq_42026600的博客
06-23 1522
zuul实现动态路由
SpringCloud- 第十二篇 Zuul概念及原理(一)
weixin_48598018的博客
07-21 472
1：Zuul是什么 Zuul是Netflix开源的API网关。 API网关，类似于面向对象设计模式中的Facade模式，它的存在就像是整个微服务架构系统的门面一样，所有的外部客户端访问都需要经过它来进行调度和过滤，它除了要实现请求路由，负载均衡，来源合法性检测，权限校验，反爬虫等功能之外，还需要更多能力，比如与服务治理框架的结合，请求转发时的熔断机制，服务的聚合等一系列的高级功能。 官网：https://github.com/Netflix/zuul/ 2：Zuul能干什么 身份验证和安全 - 识别每个资
JVM-对象创建和路由
godme
03-30 248
总体流程 Created with Raphaël 2.2.0开始new确定类模板创建指向常量池中的类的符号引用是否找到(加载)模板？虚拟机分配对象空间初始化对象默认值执行指定初始化方法结束加载、解析、初始化类yesno 内存分配 指针碰撞 最简单的情况，就是这样：内存空间连续，一侧使用，一次空闲 当需要申请内存的时候，通过分界指针的移动，就可以为新创建的对象分配内存，这种方式称作``指针碰撞`...
spring-cloud-starter-netflix-zuul和spring-cloud-starter-zuul区别
最新发布
03-08
spring-cloud-starter-netflix-zuul和spring-cloud-starter-zuul是Spring Cloud框架中用于构建微服务网关的两个组件。它们之间的区别如下： 1. spring-cloud-starter-netflix-zuul：这是基于Netflix Zuul的Spring ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

狂飙的yellowcong

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值