org.apache.shenyu.plugin.api

接口 ShenyuPlugin

public interface ShenyuPlugin

the shenyu plugin interface.

方法概要

限定符和类型	方法和说明
default void	after(org.springframework.web.server.ServerWebExchange exchange) Plugin after operation.
default void	before(org.springframework.web.server.ServerWebExchange exchange) Plugin before operation.
reactor.core.publisher.Mono<java.lang.Void>	execute(org.springframework.web.server.ServerWebExchange exchange, ShenyuPluginChain chain) Process the Web request and (optionally) delegate to the next WebFilter through the given ShenyuPluginChain.
int	getOrder() return plugin order .
default java.lang.String	named() acquire plugin name.
default boolean	skip(org.springframework.web.server.ServerWebExchange exchange) plugin is executed.
default boolean	skip(org.springframework.web.server.ServerWebExchange exchange, org.apache.shenyu.common.enums.RpcTypeEnum... rpcTypes) plugin is executed.
default boolean	skipExcept(org.springframework.web.server.ServerWebExchange exchange, org.apache.shenyu.common.enums.RpcTypeEnum... exceptRpcTypes) the plugin execute skip except some rpc types.
default boolean	skipExceptHttpLike(org.springframework.web.server.ServerWebExchange exchange) Skip the non http call.

方法详细资料

execute

reactor.core.publisher.Mono<java.lang.Void> execute(org.springframework.web.server.ServerWebExchange exchange,
                                                    ShenyuPluginChain chain)

Process the Web request and (optionally) delegate to the next WebFilter through the given ShenyuPluginChain.

参数:

exchange - the current server exchange

chain - provides a way to delegate to the next filter

返回:

Mono<Void> to indicate when request processing is complete

getOrder

int getOrder()

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

返回:

int order

named

default java.lang.String named()

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

返回:

plugin name.

skip

default boolean skip(org.springframework.web.server.ServerWebExchange exchange)

plugin is executed. if return true this plugin can not execute.

参数:

exchange - the current server exchange

返回:

default false.

skip

default boolean skip(org.springframework.web.server.ServerWebExchange exchange,
                     org.apache.shenyu.common.enums.RpcTypeEnum... rpcTypes)

plugin is executed. if return true this plugin can not execute.

the same for:

 Objects.equals(rpcType, typeA.getName())
 || Objects.equals(rpcType, typeB.getName())
 || Objects.equals(rpcType, type...getName())
 
 

参数:

exchange - the current server exchange

rpcTypes - the skip rpc type list

返回:

current rpcType == someone rpcType

skipExcept

default boolean skipExcept(org.springframework.web.server.ServerWebExchange exchange,
                           org.apache.shenyu.common.enums.RpcTypeEnum... exceptRpcTypes)

the plugin execute skip except some rpc types. if return true this plugin can not execute.

the same for:

 !Objects.equals(rpcType, typeA.getName())
 && !Objects.equals(rpcType, typeB.getName())
 && !Objects.equals(rpcType, type...getName())
 
 

参数:

exchange - the current server exchange

exceptRpcTypes - the except rpc type list

返回:

current rpcType != someone exceptRpcType

skipExceptHttpLike

default boolean skipExceptHttpLike(org.springframework.web.server.ServerWebExchange exchange)

Skip the non http call. if return true this plugin can not execute.

参数:

exchange - the current server exchange

返回:

http/spring cloud return true, others false.

before

default void before(org.springframework.web.server.ServerWebExchange exchange)

Plugin before operation.

参数:

exchange - context

after

default void after(org.springframework.web.server.ServerWebExchange exchange)

Plugin after operation.

参数:

exchange - context