第五节:路由网关zuul
一、Zuul功能
Zuul的主要功能是路由转发和过滤器。这个时候,我们需要统一的入口,接口地址全部由该入口进入。比如用/api同一接口,/api/user 发给user服务器,/api/shop 发给shop服务器。
二、搭建Zuul网关
在第四小节的源码上,新建一个模块。右击项目,选择New--Module,选择Maven,点击next,再输入模块名zuul即可。
2.1 导入zuul网关依赖
<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>
2.2 编写application.yml配置文件
#找到注册中心的地址
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8761/eureka/
#当前项目准备部署的端口
server:
port: 8769
#当前项目的服务器名称
spring:
application:
name: service-zuul
#配置网关路由
zuul:
routes:
api-a:
#/api-ribbon/**请求转发到service-ribbon服务器
path: /api-ribbon/**
serviceId: service-ribbon
api-b:
#/api-feign/**请求转发到service-feign服务器
path: /api-feign/**
serviceId: service-feign
2.3 编写启动类
@EnableZuulProxy注解表明开启网关路由。
package com.safesoft.zuul;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
/**
* @author jay.zhou
* @date 2019/1/25
* @time 14:36
*/
@SpringBootApplication
@EnableZuulProxy
@EnableEurekaClient
@EnableDiscoveryClient
public class ApplicationZuul {
public static void main(String[] args) {
SpringApplication.run(ApplicationZuul.class, args);
}
}
2.4 测试
开启8761注册中心server,8762服务提供者client,8763服务提供者client,8764服务消费者ribbon,8765服务消费者feign,当前项目8769路由网关。
分别启动以后,访问http://localhost:8761/,查看注册中心中注册的微服务。我的本机效果如图。
我本机的http://localhost:8765/sayHello?name=dayu,发送给的是feign服务消费者,feign系统把请求再转发给服务提供者client。请求结果是:
我再向网关发送一条请求,http://localhost:8769/api-feign/sayHello?name=dayu,根据网关配置文件,/api-feign开头的请求会发给部署在8765端口下的feign服务器。所以,当前请求就相当于http://localhost:8765/sayHello?name=dayu。因为开启了两个Client,所以有可能请求会被转发到8763端口的服务器上。http://localhost:8769/api-feign/sayHello?name=dayu请求结果如图所示。
同理,发送http://localhost:8769/api-ribbon/hello?name=dayu,8769网关将请求发送给了部署在8764端口的服务器上,8764端口服务器再将请求发送给Client。根据负载均衡的配置,可能发送给8762端口处理,也可能发送给8763端口处理。
三、服务过滤
3.1 编写过滤器
zuul不仅只是路由,并且还能过滤,做一些安全验证。继续改造工程;
编写一个类继承ZuulFilter类即可。
filterType:返回一个字符串代表过滤器的类型,在zuul中定义了四种不同生命周期的过滤器类型,具体如下:
pre:路由之前
routing:路由之时
post: 路由之后
error:发送错误调用
filterOrder:过滤的顺序,越小优先级越高
shouldFilter:这里可以写逻辑判断,是否要过滤,本文true,永远过滤。
run:过滤器的具体逻辑。
package com.safesoft.zuul.filter;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
/**
* @author jay.zhou
* @date 2019/1/25
* @time 15:22
*/
@Component
public class SecurityFilter extends ZuulFilter {
@Override
public String filterType() {
//pre路由之前
//routing:路由之时
// post: 路由之后
// error:发送错误调用
return "pre";
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
//true表示拦截
return true;
}
@Override
public Object run() throws ZuulException {
//获取Request与Response接口对象
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();
String securityToken = request.getParameter("token");
if (securityToken == null) {
ctx.setSendZuulResponse(false);
//状态码
ctx.setResponseStatusCode(401);
try {
//返回响应
ctx.getResponse().getWriter().write("request failure , you do not have security token ");
} catch (Exception e) {
}
}
//return null 表示直接越过此Filter
return null;
}
}
3.2 测试过滤器
测试,重新启动这个网关zuul项目,其它五个项目都保证是开启状态的。
发送http://localhost:8769/api-feign/sayHello?name=dayu,然后再加上token即可看到效果。
四、源码下载
https://github.com/hairdryre/Study_SpringCloud
参考文章:史上最简单的SpringCloud教程 | 第五篇: 路由网关(zuul)(Finchley版本)
----------------------------------------------------分割线-------------------------------------------------------
下一篇:第六节:分布式配置中心SpringCloudConfig