Spring Cloud入门教程 - Zuul实现API网关和请求过滤

简介

Zuul是Spring Cloud提供的api网关和过滤组件，它提供以下功能：

• 认证
• 过滤
• 压力测试
• Canary测试
• 动态路由
• 服务迁移
• 负载均衡
• 安全
• 静态请求处理
• 动态流量管理

在本教程中，咱们将用zuul，把web端的请求/product转发到对应的产品服务上，而且定义一个pre过滤器来验证是否通过了zuul的转发。

基础环境

• JDK 1.8
• Maven 3.3.9
• IntelliJ 2018.1
• Git

项目源码

Gitee码云

建立Zuul服务

在IntelliJ中建立一个maven项目：

• cn.zxuqian
• apiGateway

而后在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">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.zxuqian</groupId>
    <artifactId>apiGateway</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <!-- name has changed, before: spring-cloud-starter-zuul -->
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <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-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.M9</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <properties>
        <java.version>1.8</java.version>
    </properties>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/libs-milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

</project>

须要注意的是，Spring官网的教程给的zuul的artifactId为spring-cloud-starter-zuul，这个是旧版zuul的名字，在咱们的Finchley.M9版本中已经改名为spring-cloud-starter-netflix-zuul。

添加src/main/resources/bootstrap.yml文件，指定spring.application.name：

spring:
  application:
    name: zuul-server

建立cn.zxuqian.Application类：

package cn.zxuqian;

import cn.zxuqian.filters.PreFilter;
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;

@EnableZuulProxy
@EnableDiscoveryClient
@SpringBootApplication
public class Application {

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

    @Bean
    public PreFilter preFilter() {
        return new PreFilter();
    }
}

这里使用了`@EnableZuulProxy`来指定使用zuul的反向代理，把咱们的请求转发到对应的服务器上。而后启用了`eureka`的服务发现。Zuul默认也会使用Ribbon作负载均衡，因此能够经过eureka发现已注册的服务。`PreFilter`是一个预过滤器，用来在request请求被处理以前进行一些操做，它的代码以下：

package cn.zxuqian.filters;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServletRequest;

public class PreFilter extends ZuulFilter {

private static Logger log = LoggerFactory.getLogger(PreFilter.class);

@Override
public String filterType() {
    return "pre";
}

@Override
public int filterOrder() {
    return 1;
}

@Override
public boolean shouldFilter() {
    return true;
}

@Override
public Object run() throws ZuulException {
    RequestContext ctx = RequestContext.getCurrentContext();
    HttpServletRequest request = ctx.getRequest();

    log.info(String.format("%s 方式请求 %s", request.getMethod(), request.getRequestURL().toString()));

    return null;
}

}

`filterType` - Zuul内置的filter类型有四种，`pre`, `route`，`post`，`error`，分别表明请求处理前，处理时，处理后和出错后。
`filterOrder` - 指定了该过滤器执行的顺序。
`shouldFilter` - 是否开启此过滤器。
`run` - 过滤器的业务逻辑。这里只是简单的log了一下reqeust的请求方式和请求的路径。

接下来，在咱们的配置中心的git仓库中建立`zuul-server.yml`文件，并添加以下配置：

server:
port: 8083
zuul:
routes:

products:
  path: /product/**
  serviceId: product-service

这里配置了zuul的端口为8083，而后映射全部`/product/`的请求到咱们的`product-service`服务上。若是不配置`serviceId`，那么`products`这个Key就会默认做为ServiceId，而咱们的例子中，ServiceId包括了`-`，因此在下边显示指定了ServiceId。配置完成后提交到git。

## 更新productService

productService的uri作了一点改动，使其更符合rest风格：

@RequestMapping("/list")
public String productList() {

log.info("Access to /products endpoint");
return "外套，夹克，毛衣，T恤";

}

这里`@RequestMapping`匹配的路径改成了`/list`，以前是`/products`。

## 更新web客户端

在咱们的web客户端的`ProductService`中添加一个新的方法：

public String productListZuul() {

return this.restTemplate.getForObject("http://zuul-server/product/list", String.class);

}

此次咱们直接请求`zuul-server`服务，而后由它把咱们的请求反射代理到`product-service`服务。最后在`ProductController`中添加一个请求处理方法：

@RequestMapping("/product/list")
public String productListZuul() {

return productService.productListZuul();

}

用来处理`/product/list`请求，而后调用`ProductService`类中的方法。

## 测试

使用`mvn spring-boot:run`启动`configServer`，`registry`, `zuulServer`, `productService`，`web`这几个工程，而后启动第二个`productService`，使用`SERVER_PORT=8082 spring-boot:run`。
访问几回`http://localhost:8080/product/list`，而后除了会在浏览器看到返回的结果，咱们还会在`zuulServer`的命令行窗口中看到以下字样：

>  GET 方式请求 http://xuqians-imac:8083/product/list

而后在两个`productService`的命令行窗口中，咱们还会看到随机出现的

> Access to /products endpoint

说明`zuulServer`也会自动进行负载均衡。

欢迎访问个人博客[张旭乾的博客]("http://zxuqian.cn/spring-cloud-tutorial-zuul/")

你们有什么想法欢迎来讨论。