本文是SpringCloud实战(五)-路由网关(zuul),若要关注前文,请点击传送门:
前文我们介绍了Hystrix断路器。在平常工作中,我们有时候希望将客户端和服务端之间增加一层防火墙,让客户端访问服务端必须通过这道防火墙检测是安全访问之后才让请求通过,否则打回。SpringCloud提供了路由网关(zuul)来做这道防火墙,我们可以将zuul放到外网进行部署,将其他的业务代码放到内网并不向外暴露接口,Client端如果要请求内网资源必须通过zuul来进行访问,此时zuul可以对请求进行校验、拦截、过滤,从而保证业务服务的安全性。
一、zuul简介
在微服务架构中,需要几个基础的服务治理组件,包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等,由这几个基础组件相互协作,共同组建了一个简单的微服务系统。一个简答的微服务系统如下图:
注意:A服务和B服务是可以相互调用的,作图的时候忘记了。并且配置服务也是注册到服务注册中心的。
在Spring Cloud微服务系统中,一种常见的负载均衡方式是,客户端的请求首先经过负载均衡(zuul、Ngnix),再到达服务网关(zuul集群),然后再到具体的服。,服务统一注册到高可用的服务注册中心集群,服务的所有的配置文件由配置服务管理(下一篇文章讲述),配置服务的配置文件放在git仓库,方便开发人员随时改配置。
二、准备工作
继续使用上一节的工程。在原有的工程上,创建一个新的工程。
三、创建service-zuul工程
新建一个spring-boot工程,取名为:service-feign。
3.1 maven依赖
<?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>
<parent>
<groupId>com.oal.microservice</groupId>
<artifactId>openAiLab</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<groupId>com.oal.microservice</groupId>
<artifactId>service-zuul</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>service-zuul</name>
<description>zuul</description>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
3.2 配置文件(application.yml)
eureka:
client:
serviceUrl:
defaultZone: http://eureka-serve-01:8761/eureka/
server:
port: 8768
spring:
application:
name: service-zuul
zuul:
routes:
api-a:
path: /api-a/**
serviceId: service-ribbon
api-b:
path: /api-b/**
serviceId: service-feign
首先指定服务注册中心的地址为http://eureka-serve-01:8761/eureka/,服务的端口为8768,服务名为service-zuul;以/api-a/ 开头的请求都转发给service-ribbon服务;以/api-b/开头的请求都转发给service-feign服务。
3.3 启动类(ServiceZuulApplication)
@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ServiceZuulApplication {
public static void main(String[] args) {
SpringApplication.run( ServiceZuulApplication.class, args);
}
}
3.4 自定义过滤器(MyFilter)
@Component
public class MyFilter extends ZuulFilter {
private final static Logger LOGGER = LoggerFactory.getLogger(MyFilter.class);
@Override
public String filterType() {
return "pre";
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();
LOGGER.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
Object accessToken = request.getParameter("token");
if(accessToken == null) {
LOGGER.warn("token is empty");
ctx.setSendZuulResponse(false);
ctx.setResponseStatusCode(401);
try {
ctx.getResponse().getWriter().write("token is empty");
} catch (Exception e){}
return null;
}
LOGGER.info("ok");
return null;
}
}
这里有几个属性需要注意一下:
filterType:返回一个字符串代表过滤器的类型,在zuul中定义了四种不同生命周期的过滤器类型,具体如下:
-pre:路由之前
-routing:路由之时
-post: 路由之后
-error:发送错误调用
filterOrder:过滤的顺序(最小为0,数字越小优先级越高)
shouldFilter:这里可以写逻辑判断,是否要过滤,本文true,永远过滤。
run:过滤器的具体逻辑。可用很复杂,包括查sql,nosql去判断该请求到底有没有权限访问。
依次运行这五个工程;打开浏览器访问:http://localhost:8768/api-a/hi?name=zzx&token=xxx,浏览器显示:
service-ribbon:hi zzx ,i am from port:8762
访问 http://localhost:8768/api-a/hi?name=zzx,浏览器显示:
token is empty
路由网关过滤器生效,拦截成功,高可用路由网关直接启动多个实例不同端口的就可以,就不赘述了。