程序包 com.alibaba.csp.sentinel.adapter.gateway.common.param

类 ConfigurableRequestItemParser<T>

java.lang.Object

com.alibaba.csp.sentinel.adapter.gateway.common.param.ConfigurableRequestItemParser<T>

所有已实现的接口:

RequestItemParser<T>

public class ConfigurableRequestItemParser<T>
extends Object
implements RequestItemParser<T>

delegate RequestItemParser, support add extractors to customize request item parse.

example: if you want to get client real ip in multi nginx proxy, you can register SentinelGatewayFilter bean as follows ConfigurableRequestItemParser parser = new ConfigurableRequestItemParser<>(new ServerWebExchangeItemParser()); List headerNames = Arrays.asList("X-Real-IP", "Client-IP"); parser.addRemoteAddressExtractor(serverWebExchange -> { for (String headerKey : headerNames) { String remoteAddress = serverWebExchange.getRequest().getHeaders().getFirst(headerKey); if (StringUtils.hasLength(remoteAddress)) { return remoteAddress; } } return null; }); return new SentinelGatewayFilter(parser);

作者:

icodening

构造器概要

构造器

构造器	说明
ConfigurableRequestItemParser(RequestItemParser<T> delegate)

方法概要

修饰符和类型	方法	说明
ConfigurableRequestItemParser<T>	addCookieValueExtractor(BiFunction<T,String,String> extractor)
ConfigurableRequestItemParser<T>	addHeaderExtractor(BiFunction<T,String,String> extractor)
ConfigurableRequestItemParser<T>	addPathExtractor(Function<T,String> extractor)
ConfigurableRequestItemParser<T>	addRemoteAddressExtractor(Function<T,String> extractor)
ConfigurableRequestItemParser<T>	addUrlParamExtractor(BiFunction<T,String,String> extractor)
String	getCookieValue(T request, String cookieName)	Get the cookie value associated with the cookie name.
String	getHeader(T request, String key)	Get the header associated with the header key.
String	getPath(T request)	Get API path from the request.
String	getRemoteAddress(T request)	Get remote address from the request.
String	getUrlParam(T request, String paramName)	Get the parameter value associated with the parameter name.

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

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

构造器详细资料

ConfigurableRequestItemParser

public ConfigurableRequestItemParser(RequestItemParser<T> delegate)

方法详细资料

getPath

public String getPath(T request)

从接口复制的说明: RequestItemParser

Get API path from the request.

指定者:

getPath 在接口中 RequestItemParser<T>

参数:

request - valid request

返回:

API path

getRemoteAddress

public String getRemoteAddress(T request)

从接口复制的说明: RequestItemParser

Get remote address from the request.

指定者:

getRemoteAddress 在接口中 RequestItemParser<T>

参数:

request - valid request

返回:

remote address

getHeader

public String getHeader(T request,
 String key)

从接口复制的说明: RequestItemParser

Get the header associated with the header key.

指定者:

getHeader 在接口中 RequestItemParser<T>

参数:

request - valid request

key - valid header key

返回:

the header

getUrlParam

public String getUrlParam(T request,
 String paramName)

从接口复制的说明: RequestItemParser

Get the parameter value associated with the parameter name.

指定者:

getUrlParam 在接口中 RequestItemParser<T>

参数:

request - valid request

paramName - valid parameter name

返回:

the parameter value

getCookieValue

public String getCookieValue(T request,
 String cookieName)

从接口复制的说明: RequestItemParser

Get the cookie value associated with the cookie name.

指定者:

getCookieValue 在接口中 RequestItemParser<T>

参数:

request - valid request

cookieName - valid cookie name

返回:

the cookie value

addPathExtractor

public ConfigurableRequestItemParser<T> addPathExtractor(Function<T,String> extractor)

addRemoteAddressExtractor

public ConfigurableRequestItemParser<T> addRemoteAddressExtractor(Function<T,String> extractor)

addHeaderExtractor

public ConfigurableRequestItemParser<T> addHeaderExtractor(BiFunction<T,String,String> extractor)

addUrlParamExtractor

public ConfigurableRequestItemParser<T> addUrlParamExtractor(BiFunction<T,String,String> extractor)

addCookieValueExtractor

public ConfigurableRequestItemParser<T> addCookieValueExtractor(BiFunction<T,String,String> extractor)