org.dromara.soul.web.plugin.function

类 RateLimiterPlugin

java.lang.Object

org.dromara.soul.web.plugin.AbstractSoulPlugin

org.dromara.soul.web.plugin.function.RateLimiterPlugin

所有已实现的接口:

SoulPlugin

public class RateLimiterPlugin
extends AbstractSoulPlugin

RateLimiter Plugin.

作者:

xiaoyu(Myth)

构造器概要

构造器

构造器和说明
RateLimiterPlugin(LocalCacheManager localCacheManager, RedisRateLimiter redisRateLimiter) Instantiates a new Rate limiter plugin.

方法概要

限定符和类型	方法和说明
protected reactor.core.publisher.Mono<Void>	doExecute(org.springframework.web.server.ServerWebExchange exchange, SoulPluginChain chain, SelectorData selector, RuleData rule) this is Template Method child has Implement your own logic.
int	getOrder() return plugin order .
String	named() acquire plugin name.
PluginTypeEnum	pluginType() return plugin type.

从类继承的方法 org.dromara.soul.web.plugin.AbstractSoulPlugin

execute

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.dromara.soul.web.plugin.SoulPlugin

skip

构造器详细资料

RateLimiterPlugin

public RateLimiterPlugin(LocalCacheManager localCacheManager,
                         RedisRateLimiter redisRateLimiter)

Instantiates a new Rate limiter plugin.

参数:

localCacheManager - the local cache manager

redisRateLimiter - the redis rate limiter

方法详细资料

named

public String named()

从接口复制的说明: SoulPlugin

acquire plugin name. this is plugin name define if you extend AbstractSoulPlugin you must Provide the right name. if you impl AbstractSoulPlugin this attribute not use.

返回:

plugin name.

pluginType

public PluginTypeEnum pluginType()

return plugin type.

返回:

PluginTypeEnum

getOrder

public int getOrder()

从接口复制的说明: SoulPlugin

return plugin order . This attribute To determine the plugin execution order in the same type plugin.

返回:

int order

doExecute

protected reactor.core.publisher.Mono<Void> doExecute(org.springframework.web.server.ServerWebExchange exchange,
                                                      SoulPluginChain chain,
                                                      SelectorData selector,
                                                      RuleData rule)

从类复制的说明: AbstractSoulPlugin

this is Template Method child has Implement your own logic.

指定者:

doExecute 在类中 AbstractSoulPlugin

参数:

exchange - exchange the current server exchange ServerWebExchange

chain - chain the current chain ServerWebExchange

selector - selector SelectorData

rule - rule RuleData

返回:

Mono<Void> to indicate when request handling is complete