如何為Spring Cloud Gateway加上全局過(guò)濾器
既然是一個(gè)網(wǎng)關(guān)。那么全局過(guò)濾器肯定是少不了的一個(gè)存在。像是鑒權(quán)、認(rèn)證啥的不可能每個(gè)服務(wù)都做一次,一般都是在網(wǎng)關(guān)處就搞定了。
Zuul他就有很強(qiáng)大的過(guò)濾器體系來(lái)給人使用。
Gateway當(dāng)然也不會(huì)差這么點(diǎn)東西。
對(duì)于SpringCloud體系來(lái)說(shuō),一切的實(shí)現(xiàn)都是那么的簡(jiǎn)單。那么廢話不多說(shuō),直接開(kāi)始寫(xiě)起來(lái)。
Gateway內(nèi)部有一個(gè)接口 名為GlobalFilter,這個(gè)就是Gateway的全局過(guò)濾器接口,只要在應(yīng)用中實(shí)現(xiàn)此接口后注冊(cè)為Spring的Bean,背后就會(huì)幫你將這個(gè)實(shí)現(xiàn)注冊(cè)到全局過(guò)濾器鏈條里邊去。
我這里就簡(jiǎn)單的寫(xiě)了個(gè)模擬鑒權(quán)的過(guò)濾器實(shí)現(xiàn):
@Component public class AuthFilter implements GlobalFilter, Ordered { @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { String token = exchange.getRequest().getHeaders().getFirst("Authorization"); //不為空則通過(guò) if (!StringUtils.isEmpty(token)) return chain.filter(exchange); ServerHttpResponse response = exchange.getResponse(); // 封裝錯(cuò)誤信息 Map<String, Object> responseData = Maps.newHashMapWithExpectedSize(3); responseData.put("code", HttpStatus.UNAUTHORIZED.value()); responseData.put("message", "Token is empty"); responseData.put("cause", "Token is empty"); // 將信息轉(zhuǎn)換為 JSON ObjectMapper objectMapper = new ObjectMapper(); byte[] data = new byte[0]; try { data = objectMapper.writeValueAsBytes(responseData); } catch (JsonProcessingException e) { e.printStackTrace(); } // 返回錯(cuò)誤信息json DataBuffer buffer = response.bufferFactory().wrap(data); response.setStatusCode(HttpStatus.UNAUTHORIZED); response.getHeaders().add("Content-Type", "application/json;charset=UTF-8"); return response.writeWith(Mono.just(buffer)); } //最后執(zhí)行 @Override public int getOrder() { return Ordered.LOWEST_PRECEDENCE; } }
雖說(shuō)是鑒權(quán),但實(shí)際上我這就是個(gè)簡(jiǎn)單的demo而已。想知道真正的Spring Security鑒權(quán)/認(rèn)證怎么寫(xiě)?
我以前寫(xiě)的這個(gè):https://github.com/skypyb/code_demo/tree/master/spring-security-demo 應(yīng)該可以幫助你。
看我寫(xiě)的這個(gè)過(guò)濾器內(nèi)部實(shí)現(xiàn)哈,其實(shí)就是拿出Request Header中的 Authorization字段(token) 然后判斷是否存在。不存在就返回錯(cuò)誤,存在就交給鏈條中的下一個(gè)過(guò)濾器。
過(guò)濾器其實(shí)也沒(méi)啥好說(shuō)的,那么說(shuō)說(shuō)限流。
關(guān)于限流這個(gè)東西,常見(jiàn)的算法就是漏桶和令牌桶了,對(duì)于一個(gè)應(yīng)用單機(jī)限流來(lái)說(shuō)也復(fù)雜不到哪兒去。
靠著google guava包里的RateLimiter工具都能搞定大多數(shù)場(chǎng)景了。
不過(guò)既然人家Gateway好心好意給你搞了個(gè)限流的實(shí)現(xiàn)。那么還是尊重他用一下。
由于Gateway是用的Redis和lua腳本實(shí)現(xiàn)了令牌桶的算法,那么先導(dǎo)入幾個(gè)需要的依賴:
<!--Redis begin--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis-reactive</artifactId> </dependency> <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> </dependency> <!--Redis end-->
既然是Redis,那還是先配一下Redis序列化先:
@Configuration public class RedisConfig { @Bean public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) { RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>(); StringRedisSerializer stringRedisSerializer = new StringRedisSerializer(); redisTemplate.setKeySerializer(stringRedisSerializer); redisTemplate.setHashKeySerializer(stringRedisSerializer); redisTemplate.setValueSerializer(new Jackson2JsonRedisSerializer<Object>(Object.class)); redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer()); redisTemplate.setConnectionFactory(connectionFactory); return redisTemplate; } }
萬(wàn)事俱備,開(kāi)始進(jìn)行限流的具體實(shí)現(xiàn)了。
既然是限流,那么也得有個(gè)限流策略
是根據(jù)用戶來(lái)限流呢?還是說(shuō)根據(jù)請(qǐng)求路徑限流?或者是IP限流?
不過(guò)這個(gè)都是由需求來(lái)決定了,我這就簡(jiǎn)單的寫(xiě)個(gè)根據(jù)IP來(lái)限流的。
人家也給你封裝完畢了,只需要你自己實(shí)現(xiàn)KeyResolver這個(gè)接口就可以。
由于實(shí)現(xiàn)這個(gè)一般來(lái)說(shuō)也就一行代碼,所以我就不寫(xiě)個(gè)單獨(dú)的類去實(shí)現(xiàn)了,而是直接寫(xiě)在配置類里邊。
@Configuration public class GatewayRateLimiterConfig { /** * Gateway通過(guò)內(nèi)置的RequestRateLimiter過(guò)濾器實(shí)現(xiàn)限流,用的是令牌桶算法,借助Redis保存中間數(shù)據(jù) * 這里自定義一個(gè)KeyResolver * 作用是對(duì)來(lái)源ip進(jìn)行限流 */ @Bean(value = "ipKeyResolver") public KeyResolver ipKeyResolver() { return exchange -> Mono.just(exchange.getRequest().getRemoteAddress().getAddress().getHostAddress()); } }
看,我其實(shí)只需要返回我需要限制的東西就可以了。我這里提取到用戶的IP將其返回,即可實(shí)現(xiàn)通過(guò)ip來(lái)進(jìn)行限流的策略。
不過(guò)限流相關(guān)的配置寫(xiě)了,那也得用起來(lái)。
這個(gè)怎么用起來(lái)? 其實(shí)直接在配置文件里配置就OK了
spring: application: # 應(yīng)用名稱 name: sc-demo-alibaba-gateway cloud: nacos: discovery: server-addr: 192.168.3.105:8848 #注冊(cè)進(jìn)nacos # 使用 Sentinel 作為熔斷器 sentinel: transport: port: 18102 dashboard: 192.168.3.105:8858 # 路由網(wǎng)關(guān)配置 gateway: # 這里是設(shè)置與服務(wù)注冊(cè)發(fā)現(xiàn)組件結(jié)合,這樣可以采用服務(wù)名的路由策略 discovery: locator: enabled: true # 配置路由規(guī)則 routes: - id: ROUTER#sc-demo-alibaba-consumer #這個(gè)是路由ID,需要保證在所有路由定義中唯一,值隨便寫(xiě)就是了 # 采用 LoadBalanceClient 方式請(qǐng)求,以 lb:// 開(kāi)頭,后面的是注冊(cè)在 Nacos 上的服務(wù)名 uri: lb://sc-demo-alibaba-consumer predicates: # Method ,這里是匹配 GET 和 POST 請(qǐng)求 - Method=GET,POST filters: - name: RequestRateLimiter args: redis-rate-limiter.burstCapacity: 20 redis-rate-limiter.replenishRate: 5 key-resolver: '#{@ipKeyResolver}' - id: ROUTER#sc-demo-alibaba-provider uri: lb://sc-demo-alibaba-provider predicates: - Method=GET,POST #Redis配置 redis: host: 192.168.3.105 port: 6379 #Redis連接池配置 jedis: pool: min-idle: 0 max-idle: 8 max-active: 8 max-wait: -1ms server: port: 8888 feign: sentinel: enabled: true management: endpoints: web: exposure: include: "*" # 配置日志級(jí)別,方別調(diào)試 logging: level: org.springframework.cloud.gateway: debug
這里可以看到,除了Redis配置 ( spring.redis.** )以外。
主要就是對(duì)于Getway的配置。
在Gateway路由配置中,設(shè)置了一個(gè)filters參數(shù)。
這個(gè)是為了指定路由的各種過(guò)濾器的。這個(gè)參數(shù)也有很多種,可以參考官方講解: https://cloud.spring.io/spring-cloud-gateway/2.0.x/single/spring-cloud-gateway.html#gateway-route-filters
我這就是指定了一個(gè)RequestRateLimiter,請(qǐng)求限流。
- redis-rate-limiter.burstCapacity: 20
這個(gè)參數(shù)表示突發(fā)容量,即每秒可以最大通過(guò)多少次請(qǐng)求
- redis-rate-limiter.replenishRate: 5
這個(gè)是令牌桶的補(bǔ)充速度,每秒往桶里邊放幾個(gè)令牌
- key-resolver: ‘#{@ipKeyResolver}'
這個(gè)就是用上KeyResolver的具體實(shí)現(xiàn)了,這里用spel表達(dá)式指定我寫(xiě)的那個(gè)ip限制類
準(zhǔn)備好之后將應(yīng)用啟動(dòng)就完事了,想測(cè)的話可以用jmeter測(cè)測(cè)看,或者將請(qǐng)求限制寫(xiě)的更小一點(diǎn),在網(wǎng)頁(yè)上狂按f5也行。
以上就是如何為Spring Cloud Gateway加上全局過(guò)濾器的詳細(xì)內(nèi)容,更多關(guān)于Spring Cloud Gateway添加全局過(guò)濾器的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
spring MVC cors跨域?qū)崿F(xiàn)源碼解析
本文主要介紹了spring MVC cors跨域?qū)崿F(xiàn)源碼解析。具有很好的參考價(jià)值,下面跟著小編一起來(lái)看下吧2017-02-02Java多線程實(shí)戰(zhàn)之單例模式與多線程的實(shí)例詳解
今天小編就為大家分享一篇關(guān)于Java多線程實(shí)戰(zhàn)之單例模式與多線程的實(shí)例詳解,小編覺(jué)得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來(lái)看看吧2019-02-02功能強(qiáng)大的TraceId?搭配?ELK使用詳解
這篇文章主要為大家介紹了功能強(qiáng)大的TraceId?搭配?ELK使用詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-09-09Springboot如何通過(guò)自定義工具類獲取bean
這篇文章主要介紹了Springboot通過(guò)自定義工具類獲取bean方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-09-09java中List集合及其實(shí)現(xiàn)類的方法詳解
本篇文章給大家?guī)?lái)的內(nèi)容是關(guān)于java中List集合及其實(shí)現(xiàn)類的方法介紹(附代碼),有一定的參考價(jià)值,有需要的朋友可以參考一下,希望對(duì)你有所幫助。下面我們就來(lái)學(xué)習(xí)一下吧2019-06-06idea新建Springboot項(xiàng)目,設(shè)置默認(rèn)maven和jdk版本方式
這篇文章主要介紹了idea新建Springboot項(xiàng)目,設(shè)置默認(rèn)maven和jdk版本方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-12-12Apache Dubbo的SPI機(jī)制是如何實(shí)現(xiàn)的
SPI全稱為Service Provider Interface,對(duì)應(yīng)中文為服務(wù)發(fā)現(xiàn)機(jī)制。SPI類似一種可插拔機(jī)制,首先需要定義一個(gè)接口或一個(gè)約定,然后不同的場(chǎng)景可以對(duì)其進(jìn)行實(shí)現(xiàn),調(diào)用方在使用的時(shí)候無(wú)需過(guò)多關(guān)注具體的實(shí)現(xiàn)細(xì)節(jié)。在Java中,SPI體現(xiàn)了面向接口編程的思想,滿足開(kāi)閉設(shè)計(jì)原則。2021-06-06如何將默認(rèn)的maven倉(cāng)庫(kù)改為阿里的maven倉(cāng)庫(kù)
這篇文章主要介紹了如何將默認(rèn)的maven倉(cāng)庫(kù)改為阿里的maven倉(cāng)庫(kù),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-12-12JAVA實(shí)現(xiàn)DOC轉(zhuǎn)PDF的示例代碼
Word作為目前主流的文本編輯軟件之一,功能十分強(qiáng)大,但是在傳輸?shù)臅r(shí)候不穩(wěn)定,那么如何從DOC轉(zhuǎn)PDF,本文就來(lái)介紹一下,感興趣的可以了解一下2021-08-08