SpringCloud-搭建微服务网关-使用Zuul组件

Zuul搭建的网关在微服务中主要担当各个微服务的访问检查转发，利用这些特征我们通常使用Zuul做一些以前Filter的任务，例如用户登录验证，权限验证，日志等。

1.application.yml的配置

server:
  port: 9000
spring:
  application:
    name: psd-zuul

eureka:
  client:
    service-url:
      #     这个单地址是单个eureka的时候使用的，如果是eureka集群则应该全部协商斌且使用使用“,”隔开
      #     defaultZone: http://server1:8000/eureka/, http://server2:8001/eureka/, http://server3:8002/eureka/
      defaultZone: http://localhost:8000/eureka/

zuul:
  prefix: /cloud
  routes:
    user:
      path: /psd-service-user/**
      serviceId: eureka-client-psd-service-user
      strip-prefix: false
    goods:
      path: /psd-service-goods/**
      serviceId: eureka-client-psd-service-goods
      strip-prefix: false

2.pom.xml的配置

<?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">
    <parent>
        <artifactId>purchase-sale-deposit</artifactId>
        <groupId>com.lg.psd</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>psd-zuul</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <!-- 模块名及描述信息 -->
    <name>psd-zuul</name>
    <description>Spring Cloud Gateway</description>

    <dependencies>
        <!--
            Eureka 客户端, 客户端向 Eureka Server 注册的时候会提供一系列的元数据信息, 例如: 主机, 端口, 健康检查url等
            Eureka Server 接受每个客户端发送的心跳信息, 如果在某个配置的超时时间内未接收到心跳信息, 实例会被从注册列表中移除
        -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- 服务网关 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <!-- apache 工具类 -->
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>1.3.2</version>
        </dependency>
    </dependencies>

    <!--
        SpringBoot的Maven插件, 能够以Maven的方式为应用提供SpringBoot的支持，可以将
        SpringBoot应用打包为可执行的jar或war文件, 然后以通常的方式运行SpringBoot应用
     -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3.服务启动类的配置

package com.lg.psd;

import org.springframework.boot.SpringApplication;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

/**
 * <h1>网关应用程序</h1>
 * EnableZuulProxy: 标识当前的应用是 Zuul Server
 * SpringCloudApplication: 用于简化配置的组合注解,
 *  组合了 @SpringBootApplication + @EnableDiscoveryClient + @EnableCircuitBreaker
 * Created by Qinyi.
 */
@EnableZuulProxy
@SpringCloudApplication
public class ZuulApplication {
    public static void main(String[] args) {
        SpringApplication.run(ZuulApplication.class, args);
    }
}

4.编写访问前的Filter-监视访问前的请求

package com.lg.psd.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
import org.springframework.stereotype.Component;

/**
 * 请求成功之后的filter
 */
@Slf4j
@Component
public class PreRequestFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.PRE_TYPE;// pre:请求之前 post:请求之后
    }

    @Override
    public int filterOrder() {
        return 0;// 数值越小优先顺序越高
    }

    @Override
    public boolean shouldFilter() {
        return true;// 是否开启当前filter
    }

    @Override
    public Object run() throws ZuulException {
        // 用于在过滤器之间传递消息。它的数据保存在每个请求的 ThreadLocal 中。它用于存储请求路由到哪里、错误、HttpServletRequest、
        // HttpServletResponse 都存储在 RequestContext中。RequestContext 扩展了 ConcurrentHashMap, 所以,
        // 任何数据都可以存储在上下文中。
        RequestContext ctx = RequestContext.getCurrentContext();

        // 存储客户端发起请求的时间戳
        ctx.set("startTime", System.currentTimeMillis());
        return null;
    }
}

4.编写访问后的Filter-监视访问后的请求

package com.lg.psd.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

/**
 * <h1>请求之后的filter</h1>
 */
@Slf4j
@Component
public class AccessRequestFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.POST_TYPE;// pre:请求之前 post:请求之后
    }

    @Override
    public int filterOrder() {
        // zuul 组件默认的 response filter 的 order 是 1000（因为zuul的FilterConstants.SEND_RESPONSE_FILTER_ORDER
        // 常量就是1000），所以我们的 response 过滤器的 order要在 FilterConstants.SEND_RESPONSE_FILTER_ORDER 之前，否则不起作用。
        return FilterConstants.SEND_RESPONSE_FILTER_ORDER - 1;
    }

    @Override
    public boolean shouldFilter() {
        return true;// 是否开启当前filter
    }

    @Override
    public Object run() throws ZuulException {
        RequestContext context = RequestContext.getCurrentContext();
        HttpServletRequest request = context.getRequest();
        // 从上下文中取出 PreRequestFilter 设置的请求时间戳
        Long startTime = (Long) context.get("startTime");
        String uri = request.getRequestURI();
        long duration = System.currentTimeMillis() - startTime;

        // 从网关通过的请求都会打印这条日志记录: uri + duration
        log.info("uri: " + uri + ", duration: " + duration / 100 + "ms");
        return null;
    }
}

访问测试，查看log打印，打印成功，完成。

附上Gitee的源码：

SpringCloud微服务-进销存实战