SpringCloud系列之Zuul網(wǎng)關(guān)和Zuul過(guò)濾器
Zuul網(wǎng)關(guān)
什么是Zuul網(wǎng)關(guān)?
Zuul是SpringCloud全家桶的微服務(wù)網(wǎng)關(guān)。所有從app或者網(wǎng)站(第三方)來(lái)的請(qǐng)求都會(huì)經(jīng)過(guò)Zuul到達(dá)后端的Netflix應(yīng)用程序。作為一個(gè)邊界性質(zhì)的應(yīng)用程序,Zuul提供了動(dòng)態(tài)路由、監(jiān)控、彈性負(fù)載和安全功能。
Zuul底層利用filter實(shí)現(xiàn)如下功能:
- 認(rèn)證和安全,識(shí)別每個(gè)需要認(rèn)證的資源,拒絕不服務(wù)要求的請(qǐng)求。
- 性能檢測(cè),在服務(wù)邊界追蹤并統(tǒng)計(jì)數(shù)據(jù),提供精確的生產(chǎn)視圖。
- 動(dòng)態(tài)路由,根據(jù)需要將請(qǐng)求動(dòng)態(tài)路由到后端集群。
- 壓力測(cè)試,逐漸增加對(duì)集群的流量以及了解其性能。
- 負(fù)載卸載,預(yù)先為每種類(lèi)型的請(qǐng)求分配容量,當(dāng)請(qǐng)求超過(guò)流量時(shí)自動(dòng)丟棄。靜態(tài)資源處理,直接在邊界返回某種響應(yīng)。
- 靜態(tài)資源處理,直接在Zuul處理靜態(tài)資源并響應(yīng),而并非轉(zhuǎn)發(fā)這些請(qǐng)求到內(nèi)部集群中。
- 多區(qū)域彈性,跨越AWS區(qū)域進(jìn)行請(qǐng)求路由,旨在實(shí)現(xiàn)ELB使用多樣化并保證邊緣位置與使用者盡可能接近。
Zuul網(wǎng)關(guān)Demo
引入jar包:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
<version>1.3.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zuul</artifactId>
<version>1.3.5.RELEASE</version>
</dependency>
配置文件:application.yml。
server:
port: 7004 # 端口
spring:
application:
name: zuul-getway # 服務(wù)名
eureka:
client:
service-url:
defaultZone: http://jack:666@localhost:8764/eureka/ # 需要注冊(cè)到eureka
instance:
instance-id: ${spring.application.name}:${server.port}
zuul:
routes:
order-service: /od/** # 對(duì)某個(gè)服務(wù)自定義路由規(guī)則
serviceId: order-service # 這個(gè)配置可以實(shí)現(xiàn)負(fù)載均衡,默認(rèn)是輪詢(xún)
# 設(shè)置某些服務(wù)不要進(jìn)行反向代理 進(jìn)行路由,多個(gè)服務(wù)用逗號(hào)隔開(kāi)
ignored-services: order-service, user-service
prefix: /api # 請(qǐng)求路徑的前綴
查看是否注冊(cè)到eureka。
Eureka注冊(cè)中心
訪問(wèn)路徑:
localhost:7004/api/od/getOrder?token=1235。
(后面帶token是因?yàn)槲遗渲昧藀re過(guò)濾器,下面會(huì)介紹)。
Zuul過(guò)濾器
Zuul四種過(guò)濾器類(lèi)型,這些類(lèi)型對(duì)應(yīng)請(qǐng)求的生命周期
- pre(前置):在請(qǐng)求被路由之前調(diào)用。可利用這種過(guò)濾器來(lái)實(shí)現(xiàn)身份認(rèn)證、在集群中選擇請(qǐng)求的微服務(wù),記錄調(diào)試等。
- routing(路由):將請(qǐng)求路由到微服務(wù)。用于構(gòu)建發(fā)送給微服務(wù)的請(qǐng)求,并使用apache httpclient或netflix ribbon請(qǐng)求微服務(wù)。
- post(后置):在路由到微服務(wù)后執(zhí)行。可用于響應(yīng)添加標(biāo)準(zhǔn)的http header、收集統(tǒng)計(jì)信息和指標(biāo)、將響應(yīng)從微服務(wù)發(fā)送到客戶(hù)端。
- error(錯(cuò)誤):在其他階段發(fā)送錯(cuò)誤時(shí)執(zhí)行該過(guò)濾器。
注:除了默認(rèn)的過(guò)濾器類(lèi)型以外Zuul還允許創(chuàng)建自定義的過(guò)濾器類(lèi)型。
如何禁用過(guò)濾器?
很簡(jiǎn)單,只需設(shè)置zuul.ClassName.filterType.disable=true ,即可禁用SimpleClassName所對(duì)應(yīng)的過(guò)濾器。例如:zuul.TokenFilter.pre.disable=true; 即可禁用TokenFilter過(guò)濾器。
pre過(guò)濾器
例子: 鑒權(quán)認(rèn)證。如果參數(shù)帶了token就允許訪問(wèn)。
/**
* pre過(guò)濾器
* @Author Big.Hu
*/
@Component
public class TokenFilter extends ZuulFilter {
@Override
public Object run() {
System.err.println("執(zhí)行pre前置過(guò)濾器。。。。。。。。。");
RequestContext currentContext = RequestContext.getCurrentContext();
HttpServletRequest request = currentContext.getRequest();
StringBuffer requestURL = request.getRequestURL();
System.out.println("requestURL:" + requestURL);
// 獲取請(qǐng)求的參數(shù)
String token = request.getParameter("token");
if (StringUtils.isEmpty(token)) {
// 如果參數(shù)為空則過(guò)濾該請(qǐng)求,不對(duì)其進(jìn)行路由
currentContext.setSendZuulResponse(false);
// 設(shè)置錯(cuò)誤碼:401
currentContext.setResponseStatusCode(HttpStatus.SC_UNAUTHORIZED);
currentContext.set("SUCCESS", false);
} else {
// 不過(guò)濾該請(qǐng)求,對(duì)其進(jìn)行路由
currentContext.setSendZuulResponse(true);
// 設(shè)置成功碼:200
currentContext.setResponseStatusCode(HttpStatus.SC_OK);
currentContext.set("SUCCESS", true);
}
System.out.println("token:" + token);
return null;
}
/**
* 當(dāng)前filter類(lèi)型:pre、post、route、error
*/
@Override
public String filterType() {
return FilterConstants.PRE_TYPE;
}
/**
* 表示當(dāng)前filter優(yōu)先級(jí)
*/
@Override
public int filterOrder() {
return FilterConstants.PRE_DECORATION_FILTER_ORDER - 1;
}
/**
* 是否執(zhí)行該過(guò)濾器?
**/
@Override
public boolean shouldFilter() {
return true;
}
}
POST過(guò)濾器
例: 在返回的時(shí)候設(shè)置一個(gè)cookie。
/**
* Post過(guò)濾器
* @Author Big.Hu
*/
@Component
public class PostFilter extends ZuulFilter {
/**
* POST過(guò)濾器:在route和error過(guò)濾器之后執(zhí)行
*/
@Override
public String filterType() {
return FilterConstants.POST_TYPE;
}
@Override
public int filterOrder() {
return FilterConstants.SEND_RESPONSE_FILTER_ORDER - 1;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() {
System.err.println("執(zhí)行Post過(guò)濾器。。。。。。。。。");
RequestContext currentContext = RequestContext.getCurrentContext();
HttpServletResponse response = currentContext.getResponse();
Cookie cookie = new Cookie("name", "Jack.Hu");
cookie.setMaxAge(60 * 60 * 24);
response.addCookie(cookie);
return null;
}
}
訪問(wèn)路徑:
localhost:7004/api/od/getOrder。
(沒(méi)帶token參數(shù))請(qǐng)求被pre過(guò)濾器過(guò)濾掉了。
不帶token請(qǐng)求
帶上token參數(shù)請(qǐng)求成功!
帶token請(qǐng)求
再按f12看post過(guò)濾器設(shè)置的cookie。
查看cookie
控制臺(tái):
控制臺(tái)