springCloud - 第6篇 - 网关的实现：ZUUL

分手后的思念是犯贱 2021-11-23 07:14 248阅读 0赞

[前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。][Link 1]

在Spring Cloud 微服务系统中，一种常见的负载均衡方式是，客户端的请求首先经过负载均衡（zuul、Ngnix），再到达服务网关（zuul集群），然后再到具体的服务。服务统一注册到高可用的服务注册中心集群，服务的所有的配置文件由配置服务管理，配置文件放在 git 仓库，方便开发人员随时更新配置。

Zuul 的主要功能是路由转发和过滤器。路由功能是微服务的一部分，比如／api/user 转发到到 user 服务，/api/shop 转发到到 shop服务。zuul 默认和 Ribbon 结合实现了负载均衡的功能。  
  
以上出自：https://blog.csdn.net/forezp/article/details/81041012

实现网关：

1. file - new - module

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70][]

2. spring Initializr - module SDK 选择自己的 JDK ，其余的可以不用填写，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 1][]

3. 填写工程相关信息：包名、工程名等，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 2][]

4. spring cloud routing - 勾选 zuul，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 3][]

5. 工程名，代码存放位置等，finish 。

![2019072608504280.png][]

6. 工程结构如下：

![20190726085117375.png][]

7. pom.xml：(  没有使用base 工程的pom 。换来换去，只有 2.0.5 这个版本能正常引用所有 jar )

<?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>
    	<groupId>com.zuul</groupId>
    	<artifactId>zuul</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>zuul</name>
    	<description>网关（路由）</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.5.RELEASE</version>
            <relativePath />
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
            <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</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-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <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>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

8. 在工程启动类上加注解： @EnableZuulProxy ，开启网关功能 。

package com.zuul.zuul;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    
    @SpringBootApplication
    @EnableEurekaClient
    
    // 开启网关
    @EnableZuulProxy
    public class ZuulApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(ZuulApplication.class, args);
    	}
    
    }

9. 配置文件：

# 注册中心 - 端口： 1234、工程名： eureka （见 eureka 工程中配置）。
    eureka.client.serviceUrl.defaultZone= http://localhost:1234/eureka/
    
    # 端口
    server.port= 2222
    
    # 工程名
    spring.application.name= zuul
    
    # 以/api-x/ 开头的请求都转发给服务 : ribbon
    # ribbon 是服务名，见 ribbon 工程的配置文件 
    zuul.routes.api-x.path= /api-x/**
    zuul.routes.api-x.serviceId= ribbon
    
    # 以/api-y/开头的请求都转发给服务 ：feign
    zuul.routes.api-y.path = /api-y/**
    zuul.routes.api-y.serviceId= feign

10. 在 feign 、ribbon 工程的 controller 中分别加上一句：“ 我来自服务 xxx ” :

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 5][]

11. 启动 5 个工程：eureka（端口1234）、feign （端口8702）、ribbon（端口8701）、

see-param（端口8803）、zuul（端口2222） ,可见 4 个不同服务都已注册成功 。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 6][]

12. 测试 api-x 的请求、测试 api-y 的请求，可见实现了对应的转发：

![2019072609054852.png][]

![20190726090626524.png][]

至此，网关的请求转发就已经实现。

13. zuul 过滤功能实现 。

new 一个类：JYZuulFilter， 继承 ZuulFilter ，实现其 abstract 方法：

package com.zuul.zuul;
    
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    import com.netflix.zuul.exception.ZuulException;
    import org.springframework.stereotype.Component;
    
    import java.util.Objects;
    
    /**
     * @author yujiang
     * @description
     * @date 2019/7/25 16:24
     */
    @Component
    public class JYZuulFilter extends ZuulFilter {
    
    
        @Override
        public String filterType() {
            return "pre";
        }
    
        @Override
        public int filterOrder() {
            return 0;
        }
    
        @Override
        public boolean shouldFilter() {
            return true;
        }
    
        @Override
        public Object run() throws ZuulException {
    
            RequestContext rc = RequestContext.getCurrentContext();
            if (Objects.isNull(rc.getRequest().getParameter("name"))) {
                rc.setSendZuulResponse(false);
                try {
                    rc.getResponse().getWriter().write(" name cannot be null ...");
                } catch (Exception e) {
                }
                return null;
            }
            return null;
        }
    
    }

14. 测试 请求中不带参数 name 时，服务接口返回：

![20190726091127979.png][]

![20190726091200998.png][]

请求中有参数 name 时，服务接口返回：

![20190726091605500.png][]

![20190726091720502.png][]

这样，过滤功能也实现了。

\-------------------------------------------------------------

下一篇：[springCloud - 第7篇 - 配置文件管理中心 ( SpringCloud Config )][springCloud - _7_ - _ _ SpringCloud Config]

源码见：[https://gitee.com/FJ\_WoMenDeShiJie/springcloud-zuul][https_gitee.com_FJ_WoMenDeShiJie_springcloud-zuul]

\-------------------------------------------------------------

PS：这个系列不定时更新，只是个人的学习分享，

内容全程参考书目：

《Spring Cloud 与 Docker 微服务架构空实战 》、

《Spring Cloud 微服务实战》及此书作者博客：http://blog.didispace.com/spring-cloud-learning/

《深入理解 Spring Cloud 与微服务构建》及此书作者博客：https://blog.csdn.net/forezp/article/details/70148833  
\--------------------------------------------------------------

以下出自：[https://blog.csdn.net/forezp/article/details/81041012][https_blog.csdn.net_forezp_article_details_81041012]

关于 ZuulFilter：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 7][]

[Link 1]: https://www.captainai.net/jiangyu1013/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70]: /images/20211122/6cd5119aac734c7f85eae1e94ce2cb2c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 1]: /images/20211122/394aa3b3e27c4f2388a8b2b9153b6526.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 2]: /images/20211122/4643d07155b64fca8ed4e51cea92bf36.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 3]: /images/20211122/20ac79e6e39b4aa48fc684d70eb43a47.png
[2019072608504280.png]: /images/20211122/33d6ded37d964c438c6b1ccfc7d7608f.png
[20190726085117375.png]: /images/20211122/e59bd42538a641c88ac0b70fa8611882.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 4]: /images/20211122/f2d630c98ce845f6b25e3968990d0507.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 5]: /images/20211122/570ca36e19bf477e9667a9389726b550.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 6]: /images/20211122/19af2f665fc34d119299bf7fff890ff6.png
[2019072609054852.png]: /images/20211122/2a9f1cb18d5b4087938e98a46666b9da.png
[20190726090626524.png]: /images/20211122/f09f136f8573487b81e0d9a3ec2d0036.png
[20190726091127979.png]: /images/20211122/7c8c49e3fb13453f9854c798e3671de3.png
[20190726091200998.png]: /images/20211122/280dd41b31804ba19e13f9e3a0a91b0f.png
[20190726091605500.png]: /images/20211122/c8f36ef684c14ac9a2ea807ddf1bdfa6.png
[20190726091720502.png]: /images/20211122/81a12beca0e14213948fc9bd95d9ae76.png
[springCloud - _7_ - _ _ SpringCloud Config]: https://blog.csdn.net/jiangyu1013/article/details/97812612
[https_gitee.com_FJ_WoMenDeShiJie_springcloud-zuul]: https://gitee.com/FJ_WoMenDeShiJie/springcloud-zuul
[https_blog.csdn.net_forezp_article_details_81041012]: https://blog.csdn.net/forezp/article/details/81041012
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 7]: /images/20211122/183729a1187041bda44821554bb0374e.png