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);}@Beanpublic 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);@Overridepublic String filterType() {return "pre";}@Overridepublic int filterOrder() {return 1;}@Overridepublic boolean shouldFilter() {return true;}@Overridepublic 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
也会自动进行负载均衡。
欢迎访问我的博客张旭乾的博客
大家有什么想法欢迎来讨论。
转载于:https://blog.51cto.com/13727459/2113223
Spring Cloud入门教程 - Zuul实现API网关和请求过滤相关推荐
- Spring Cloud入门教程(二):客户端负载均衡(Ribbon)
对于大型应用系统负载均衡(LB:Load Balancing)是首要被解决一个问题.在微服务之前LB方案主要是集中式负载均衡方案,在服务消费者和服务提供者之间又一个独立的LB,LB通常是专门的硬件,如 ...
- 微服务理念与Spring Cloud入门-----父工程与API子工程的创建教程
前言 随着软件工程的规模的迅速扩大,对响应的速度的要求的越来越高,软件的开发过程面临越来越大的挑战.为了提高开发的效率,和质量,以及对成本的压缩,对软件的模块化,以及希望像硬件模块一样,能即插即用,成 ...
- Spring Cloud 入门 之 Zuul 篇(五)
一.前言 随着业务的扩展,微服务会不对增加,相应的其对外开放的 API 接口也势必增多,这不利于前端的调用以及不同场景下数据的返回,因此,我们通常都需要设计一个 API 网关作为一个统一的 API 入 ...
- spring cloud 学习(6) - zuul 微服务网关
微服务架构体系中,通常一个业务系统会有很多的微服务,比如:OrderService.ProductService.UserService...,为了让调用更简单,一般会在这些服务前端再封装一层,类似下 ...
- Spring Cloud 入门教程(二): 配置管理
使用Config Server,您可以在所有环境中管理应用程序的外部属性.客户端和服务器上的概念映射与Spring Environment和PropertySource抽象相同,因此它们与Spring ...
- 访问 localhost 的请求遭到拒绝_软件架构-Spring Cloud Zuul作为API网关实现请求路由转发...
感谢老铁们的支持,不同的微服务一般有不同的网络地址,而外部的客户端可能需要调用多个服务的接口才能完成一个业务需求.比如一个电影购票的手机APP,可能回调用电影分类微服务,用户微服务,支付微服务等. 源 ...
- Spring Cloud入门教程-Hystrix断路器实现容错和降级
简介 Spring cloud提供了Hystrix容错库用以在服务不可用时,对配置了断路器的方法实行降级策略,临时调用备用方法.这篇文章将创建一个产品微服务,注册到eureka服务注册中心,然后我们使 ...
- Alibaba Sentinel对接Spring Cloud Gateway关于不显示API管理及请求链路的坑附带解决方案
在调试Sentinel对接Scg网关的时候,出现了一个比较坑的现象,就是网关菜单,不显示请求链路和API管理的菜单项,这个问题主要是由于,Sentinel的dashboard前端sidebar.js的 ...
- Spring Cloud入门,看这篇就够了!
点击▲关注 "中生代技术" 给公众号标星置顶 更多精彩 第一时间直达 概述 首先我给大家看一张图,如果大家对这张图有些地方不太理解的话,我希望你们看完我这篇文章会恍然大悟. 什 ...
最新文章
- Linq 无法删除尚未附加的实体的问题
- pandas教程:pandas主要功能详解
- 让java的多重继承成为现实!
- 服务器linux启动,Linux 服务器环境启动
- c语言根据图片轮廓图,c语言通过opencv实现轮廓处理与切割
- java语言怎么建立窗口awt,java.awt.Frame类:创建窗口
- Struts2实现简单的在线人数统计
- [在windows上使用Unix工具]cygwin
- 汽车之家监控系统的第一次里程碑
- Android基于mAppWidget实现手绘地图(一)--简介
- dnf如何快速拾取物品_极简断舍离|如何快速处理闲置物品?
- 快慢指针 —— 链表中点
- 【对讲机的那点事】对讲机数字语音加密,保障通信安全
- 你会用LaTeX写毕业论文么?
- linux支持hd610显卡吗,HD610和UHD630区别大吗 UHD630对比HD610的区别
- 用python模拟clark变换和park变换
- android学习笔记-连接新大陆物联网云平台控制stm32
- Office和Visio2019兼容下载
- 开关电源输出纹波主要来源五个方面?示波器测纹波方法?
- 吹了一个多月的联想Z5竟然是低端机,指望靠这个崛起就是痴人说梦