網(wǎng)關(guān)概述
- 網(wǎng)關(guān)旨在為微服務(wù)架構(gòu)提供一種簡單而有效的統(tǒng)一的API路由管理方式秉扑。
- 在微服務(wù)架構(gòu)中, 不同的微服務(wù)可以有不同的網(wǎng)絡(luò)地址,各個微服務(wù)之間通過相互調(diào)用完成用戶請求蛹批,客戶端可能通過調(diào)用N個微服務(wù)的接口完成一個用戶請求。
- 存在的問題:
- 客戶端多次請求不同的微服務(wù)篮愉,增加客戶端的復(fù)雜性
- 認證復(fù)雜腐芍,每個服務(wù)都要進行認證
- http求情不同服務(wù)次數(shù)增加,性能不高
- 網(wǎng)關(guān)就是系統(tǒng)的入口试躏,封裝了應(yīng)用程序的內(nèi)部結(jié)構(gòu)猪勇,為客戶端提供統(tǒng)一服務(wù),一些與業(yè)務(wù)本身功能無關(guān)的公共邏輯可以在這里實現(xiàn)颠蕴,諸如認證泣刹、鑒權(quán)、監(jiān)控犀被、緩存椅您、負載均衡、流量監(jiān)控寡键、路由轉(zhuǎn)發(fā)等掀泳。
Gateway 網(wǎng)關(guān)快速入門
1. 搭建網(wǎng)關(guān)模塊
2. 引入依賴:starter-gateway
<dependencies>
<!--引入gateway網(wǎng)關(guān)-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
</dependencies>
3. 編寫啟動類
package com.itheima.gateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class ApiGatewayApp {
public static void main(String[] args) {
SpringApplication.run(ApiGatewayApp.class, args);
}
}
4. 編寫配置文件
server:
port: 80
spring:
application:
name: api-gateway-server
cloud: #網(wǎng)關(guān)配置
gateway: #路由配置: 轉(zhuǎn)發(fā)規(guī)則
routes: #集合。
- id: gateway-provider #ID:唯一標(biāo)示西轩,默認是一個UUID
uri: http://localhost:8001/ #uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件员舵,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/goods/**
5. 啟動測試
Gateway 網(wǎng)關(guān)路由配置 - 靜態(tài)路由
server:
port: 80
spring:
application:
name: api-gateway-server
cloud: #網(wǎng)關(guān)配置
gateway: #路由配置: 轉(zhuǎn)發(fā)規(guī)則
routes: #集合。
- id: gateway-provider #ID:唯一標(biāo)示藕畔,默認是一個UUID
uri: http://localhost:8001/ #uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件马僻,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/goods/**
- id: gateway-consumer #ID:唯一標(biāo)示,默認是一個UUID
uri: http://localhost:9000/ #uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件注服,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/order/**
Gateway 網(wǎng)關(guān)路由配置 - 動態(tài)路由
- 引入eureka-client配置
- 修改uri屬性:uri:lb://服務(wù)名稱
server:
port: 80
spring:
application:
name: api-gateway-server
cloud: #網(wǎng)關(guān)配置
gateway: #路由配置: 轉(zhuǎn)發(fā)規(guī)則
routes: #集合韭邓。
- id: gateway-provider #ID:唯一標(biāo)示,默認是一個UUID
uri: lb://GATEWAY-PROVIDER #動態(tài)路由 #uri: http://localhost:8001/ #靜態(tài)路由uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件祠汇,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/goods/**
- id: gateway-consumer #ID:唯一標(biāo)示仍秤,默認是一個UUID
uri: lb://GATEWAY-CONSUMER #動態(tài)路由 #靜態(tài)路由uri: http://localhost:9000/ #uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/order/**
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
Gateway 網(wǎng)關(guān)路由配置 - 微服務(wù)名稱配置
server:
port: 80
spring:
application:
name: api-gateway-server
cloud: #網(wǎng)關(guān)配置
gateway: #路由配置: 轉(zhuǎn)發(fā)規(guī)則
routes: #集合可很。
- id: gateway-provider #ID:唯一標(biāo)示诗力,默認是一個UUID
uri: lb://GATEWAY-PROVIDER #動態(tài)路由 #uri: http://localhost:8001/ #靜態(tài)路由uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/goods/**
- id: gateway-consumer #ID:唯一標(biāo)示,默認是一個UUID
uri: lb://GATEWAY-CONSUMER #動態(tài)路由 #靜態(tài)路由uri: http://localhost:9000/ #uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件苇本,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/order/**
discovery: #微服務(wù)名稱配置
locator:
enabled: true #設(shè)置為true 請求路徑前可以添加微服務(wù)名稱
lower-case-service-id: true #允許為小寫
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
Gateway 過濾器
-
Gateway支持過濾器功能袜茧,懟請求或響應(yīng)進行攔截,完成一些通用操作瓣窄。
- Gateway 提供兩種過濾方式:“pre” 和 “post”
- pre過濾器笛厦,在轉(zhuǎn)發(fā)之前執(zhí)行,可以做參數(shù)校驗俺夕、權(quán)限校驗裳凸、流量監(jiān)控、日志輸出劝贸、協(xié)議轉(zhuǎn)換等姨谷。
- post過濾器,在響應(yīng)之前執(zhí)行映九,可以做響應(yīng)內(nèi)容梦湘、響應(yīng)頭的修改、日志的輸出件甥、流量監(jiān)控等捌议。
- Gateway還提供了兩種類型過濾器
- GatewayFilter:局部過濾器,針對單個路由
- GlobalFilter:全局過濾器引有,針對所有路由
Gateway過濾器 - 局部過濾器
- GatewayFilter局部過濾器瓣颅,是針對單個路由的過濾器。
- 在SpringCloudGateway組件中提供了大量內(nèi)置的局部過濾器轿曙,對請求和響應(yīng)坐過濾操作弄捕。
- 遵循約定大于配置的思想僻孝,只需要在配置文件配置局部過濾器名稱导帝,并為其制定對應(yīng)的值。就可以讓其生效穿铆。
server:
port: 80
spring:
application:
name: api-gateway-server
cloud: #網(wǎng)關(guān)配置
gateway: #路由配置: 轉(zhuǎn)發(fā)規(guī)則
routes: #集合您单。
- id: gateway-provider #ID:唯一標(biāo)示,默認是一個UUID
uri: lb://GATEWAY-PROVIDER #動態(tài)路由 #uri: http://localhost:8001/ #靜態(tài)路由uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件荞雏,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/goods/**
filter:
- AddRequestParameter=username,zhangsan #filters過濾器:配置局部過濾器
- id: gateway-consumer #ID:唯一標(biāo)示虐秦,默認是一個UUID
uri: lb://GATEWAY-CONSUMER #動態(tài)路由 #靜態(tài)路由uri: http://localhost:9000/ #uri:轉(zhuǎn)發(fā)路徑
predicates: #predicates: 條件,用于請求網(wǎng)關(guān)路徑的匹配規(guī)則
- path=/order/**
discovery: #微服務(wù)名稱配置
locator:
enabled: true #設(shè)置為true 請求路徑前可以添加微服務(wù)名稱
lower-case-service-id: true #允許為小寫
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
Gateway過濾器 - 全局過濾器
GlobaFilter 全局過濾器凤优,不需要在配置文件中配置悦陋,系統(tǒng)初始化時加載,并作用在每個路由上筑辨。
-
SpringCloud Gateway核心的功能也是通過內(nèi)置的全局過濾器來完成俺驶。
自定義全局過濾器步驟:
- 定義類實現(xiàn)GlobalFilter和Ordered接口
- 復(fù)寫方法
- 完成邏輯處理
package com.itheima.gateway.filter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
public class MyFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("自定義全局過濾器執(zhí)行了。棍辕。暮现。");
return chain.filter(exchange); //放行
}
/**
* 過濾器排序
* @return 數(shù)值越小 越先執(zhí)行
*/
@Override
public int getOrder() {
return 0;
}
}