spring cloud的网关服务Zuul

傷城~ 2022-06-04 23:57 219阅读 0赞

微服务架构讲究系统的高内聚性，即只做该系统该做的事情，而其他的事情可以通过网关去做。spring cloud的zuul可以快速的搭建一个网关系统，其主要功能如下：  
![这里写图片描述][SouthEast]  
当加入了spring cloud的zuul后，架构图大致如下：  
![这里写图片描述][SouthEast 1]

下面我们使用zuul来快速搭建一个官网系统

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

## 1.添加依赖 ##

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.4.RELEASE</version>
    </parent>
    
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Dalston.SR3</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>
    </dependencies>
    
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <configuration>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

## 2.编写启动类 ##

@EnableZuulProxy
    @SpringBootApplication
    public class ApiGatewayApplication { 
    
        public static void main(String[] args) {
            SpringApplication.run(ApiGatewayApplication.class, args);
        }
    
    }

## 3.编写yml配置文件 ##

server:
      port: 6677 #服务端口
    
    spring: 
      application:  
        name: spring-cloud-gateway #指定服务名
    zuul: 
      routes: 
        caclulate: #caclulate这个名字是任意写的
          path: /caclulate/** #配置请求URL的请求规则
          serviceId: com-spring-caclu #指定Eureka注册中心中的服务id
    
    eureka:
      client:
        registerWithEureka: true #是否将自己注册到Eureka服务中，默认为true
        fetchRegistry: true #是否从Eureka中获取注册信息，默认为true
        serviceUrl: #Eureka客户端与Eureka服务端进行交互的地址
          defaultZone: http://cloud:cloud@127.0.0.1:6868/eureka/
      instance: 
        prefer-ip-address: true #将自己的ip地址注册到Eureka服务中

前往eureka的注册中心，我们发现该服务已经注册到该服务中心了。  
此时，我们只需要访问/caclulate/\*\*,该网关服务执行玩自己该做的事情之后，就会转发到对应的服务（com-spring-caclu）下面去执行目标代码。

上面配置文件中，转发路由的配置是比较常用的一种写法，也是比较好用的，它不会破坏Hystrix、Ribbon特性，下面还有几种配置路由的方式可以参考一下：

**3.1 指定服务id**

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

**3.2 忽略指定服务**

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

**3.3 忽略所有服务，只是有路由指定**

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

**3.4 同时配置path和url**

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

**3.5 使用正则表达式指定路由规则**

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

**3.6 路由前缀**

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

**3.7 忽略某些路径**

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

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

下面我们通过一个示例来演示一下zuul如何来使用  
我们只需要创建一个类来继承ZuulFilter这个抽象类，并实现其4个抽象方法即可：

1、shouldFilter：返回一个Boolean值，判断该过滤器是否需要执行。返回true执行，返回false不执行。
    2、run：过滤器的具体业务逻辑。
    3、filterType：返回字符串代表过滤器的类型
        a)pre：请求在被路由之前执行
        b)routing：在路由请求时调用
        c)post：在routing和errror过滤器之后调用
        d)error：处理请求时发生错误调用
    filterOrder：通过返回的int值来定义过滤器的执行顺序，数字越小优先级越高。

下面是一个实例代码：

@Component //加入到Spring容器
    public class UserLoginZuulFilter extends ZuulFilter{ 
    
        @Override
        public boolean shouldFilter() {
            return true; // 该过滤器需要执行
        }
    
        @Override
        public Object run() { //编写业务逻辑
            RequestContext requestContext = RequestContext.getCurrentContext();
            HttpServletRequest request = requestContext.getRequest();
            String token = request.getParameter("token");
            if(StringUtils.isEmpty(token)){
                requestContext.setSendZuulResponse(false); // 过滤该请求，不对其进行路由
                requestContext.setResponseStatusCode(401); // 设置响应状态码
                return null;
            }
            return null;
        }
    
        @Override
        public String filterType() {
            return "pre"; // 设置过滤器类型为：pre
        }
    
        @Override
        public int filterOrder() {
            return 0;// 设置执行顺序
        }
    }

这个时候，当我们再次访问的时候，如果没有token这个参数，那么就会直接返回，并抛出401状态码。

[SouthEast]: /images/20220605/db33be5685b14e2ba74ad0a6879e08dc.png
[SouthEast 1]: /images/20220605/89b8f199b06b4ad281a88745989d88e9.png
[SouthEast 2]: /images/20220605/aa5a070ffca3429388e408a29e6c8b68.png
[SouthEast 3]: /images/20220605/5c204b8da7cc4ae49ed235087278fc5f.png
[SouthEast 4]: /images/20220605/79916dd3d3584b5481d58b857a3abe96.png
[SouthEast 5]: /images/20220605/621d6a2c210e4fb3822f385cccdf829e.png
[SouthEast 6]: /images/20220605/d429c03906104f94abac7dfc342c3cb5.png
[SouthEast 7]: /images/20220605/85ea5b6cb9974177815d2b33e7e84e3b.png
[SouthEast 8]: /images/20220605/6e0f766c2d6f474d80f9061e5e4c58ac.png