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

更新时间：2018年05月07日 09:58:08 作者：fengqiuzhihua

这篇文章主要给大家介绍了关于Spring Cloud入门教程之Zuul实现API网关与请求过滤的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。

简介

Zuul是Netflix基于JVM的路由器和服务器端负载均衡器。最常用的场景是替换Nginx反向代理后台微服务供前端UI访问。

Zuul使用Ribbon来定位一个通过发现转发的实例，所有请求都以hystrix命令执行，所以故障将显示在Hystrix指标中。

注：Zuul不包括发现客户端，因此对于基于服务ID的路由，需要在类路径中提供其中一个路由

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

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

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

基础环境

JDK 1.8
Maven 3.3.9
IntelliJ 2018.1
Git

项目源码

点击这里

创建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也会自动进行负载均衡。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

Spring Boot 2.x 实现文件上传功能
这篇文章主要介绍了Spring Boot 2.x 实现文件上传功能,本文分步骤通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-01-01
Spring Boot Actuator监控的简单使用方法示例代码详解
这篇文章主要介绍了Spring Boot Actuator监控的简单使用，本文通过实例代码图文相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2020-06-06
Java实现滑动验证码(前端部分)
这篇文章主要为大家介绍了如何用Java语言实现滑动验证码的生成(前端部分)，文中的示例代码讲解详细，具有一定的学习价值，感兴趣的小伙伴可以跟随小编学习一下
2022-10-10
mybatis的Configuration详解
这篇文章主要介绍了mybatis的Configuration详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-11-11
java实现电脑端扫描二维码
这篇文章主要为大家详细介绍了java实现电脑端扫描二维码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-10-10
一篇文章带你了解Java Stream流
Stream流是数据渠道，用于操作数据源（集合、数组等）所生成的元素序列。这篇文章主要介绍了Java8新特性Stream流的相关资料，需要的朋友参考下吧
2021-08-08
SpringBoot使用MyBatis时的几种传参规范示例
使用Mybatis作为持久层框架时，对于数据库的增删改查等操作都需要参数的传递，本文就详细的介绍了一下SpringBoot使用MyBatis时的几种传参规范示例，感兴趣的可以了解一下
2022-02-02
java实现一个桌球小游戏
这篇文章主要为大家详细介绍了java实现一个桌球小游戏，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-07-07
java创建jar包并被项目引用步骤详解
这篇文章主要介绍了java创建jar包并被项目引用步骤详解，jar包实现了特定功能的,java字节码文件的压缩包，更多相关内容需要的朋友可以参考一下
2022-07-07
java图片验证码实现示例分享
这篇文章主要介绍了java实现图片验证码示例,需要的朋友可以参考下
2014-02-02

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

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具