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

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

在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 

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

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

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

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

6. 工程结构如下：

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

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

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

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

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

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 时，服务接口返回：

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

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

-------------------------------------------------------------

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

源码见：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

关于 ZuulFilter：