类 RequestPredicates
- java.lang.Object
- org.springframework.web.reactive.function.server.RequestPredicates
public abstract class RequestPredicates extends Object
Implementations ofRequestPredicatethat implement various useful request matching operations, such as matching based on path, HTTP method, etc.- 从以下版本开始:
- 5.0
- 作者:
- Arjen Poutsma
嵌套类概要
嵌套类 修饰符和类型 类 说明 static interfaceRequestPredicates.VisitorReceives notifications from the logical structure of request predicates.
构造器概要
构造器 构造器 说明 RequestPredicates()
方法概要
所有方法 静态方法 具体方法 修饰符和类型 方法 说明 static RequestPredicateaccept(MediaType... mediaTypes)Return aRequestPredicatethat tests if the request's accept header is compatible with any of the given media types.static RequestPredicateall()Return aRequestPredicatethat always matches.static RequestPredicatecontentType(MediaType... mediaTypes)Return aRequestPredicatethat tests if the request's content type is included by any of the given media types.static RequestPredicateDELETE(String pattern)Return aRequestPredicatethat matches if request's HTTP method isDELETEand the givenpatternmatches against the request path.static RequestPredicateGET(String pattern)Return aRequestPredicatethat matches if request's HTTP method isGETand the givenpatternmatches against the request path.static RequestPredicateHEAD(String pattern)Return aRequestPredicatethat matches if request's HTTP method isHEADand the givenpatternmatches against the request path.static RequestPredicateheaders(Predicate<ServerRequest.Headers> headersPredicate)Return aRequestPredicatethat tests the request's headers against the given headers predicate.static RequestPredicatemethod(HttpMethod httpMethod)Return aRequestPredicatethat matches if the request's HTTP method is equal to the given method.static RequestPredicatemethods(HttpMethod... httpMethods)Return aRequestPredicatethat matches if the request's HTTP method is equal to one the of the given methods.static RequestPredicateOPTIONS(String pattern)Return aRequestPredicatethat matches if request's HTTP method isOPTIONSand the givenpatternmatches against the request path.static RequestPredicatePATCH(String pattern)Return aRequestPredicatethat matches if request's HTTP method isPATCHand the givenpatternmatches against the request path.static RequestPredicatepath(String pattern)Return aRequestPredicatethat tests the request path against the given path pattern.static RequestPredicatepathExtension(String extension)Return aRequestPredicatethat matches if the request's path has the given extension.static RequestPredicatepathExtension(Predicate<String> extensionPredicate)Return aRequestPredicatethat matches if the request's path matches the given predicate.static Function<String,RequestPredicate>pathPredicates(PathPatternParser patternParser)Return a function that creates new path-matchingRequestPredicatesfrom pattern Strings using the givenPathPatternParser.static RequestPredicatePOST(String pattern)Return aRequestPredicatethat matches if request's HTTP method isPOSTand the givenpatternmatches against the request path.static RequestPredicatePUT(String pattern)Return aRequestPredicatethat matches if request's HTTP method isPUTand the givenpatternmatches against the request path.static RequestPredicatequeryParam(String name, String value)Return aRequestPredicatethat matches if the request's query parameter of the given name has the given value.static RequestPredicatequeryParam(String name, Predicate<String> predicate)Return aRequestPredicatethat tests the request's query parameter of the given name against the given predicate.
构造器详细资料
RequestPredicates
public RequestPredicates()
方法详细资料
all
public static RequestPredicate all()
Return aRequestPredicatethat always matches.- 返回:
- a predicate that always matches
method
public static RequestPredicate method(HttpMethod httpMethod)
Return aRequestPredicatethat matches if the request's HTTP method is equal to the given method.- 参数:
httpMethod- the HTTP method to match against- 返回:
- a predicate that tests against the given HTTP method
methods
public static RequestPredicate methods(HttpMethod... httpMethods)
Return aRequestPredicatethat matches if the request's HTTP method is equal to one the of the given methods.- 参数:
httpMethods- the HTTP methods to match against- 返回:
- a predicate that tests against the given HTTP methods
- 从以下版本开始:
- 5.1
path
public static RequestPredicate path(String pattern)
Return aRequestPredicatethat tests the request path against the given path pattern.- 参数:
pattern- the pattern to match to- 返回:
- a predicate that tests against the given path pattern
pathPredicates
public static Function<String,RequestPredicate> pathPredicates(PathPatternParser patternParser)
Return a function that creates new path-matchingRequestPredicatesfrom pattern Strings using the givenPathPatternParser.This method can be used to specify a non-default, customized
PathPatternParserwhen resolving path patterns.- 参数:
patternParser- the parser used to parse patterns given to the returned function- 返回:
- a function that resolves a pattern String into a path-matching
RequestPredicatesinstance
headers
public static RequestPredicate headers(Predicate<ServerRequest.Headers> headersPredicate)
Return aRequestPredicatethat tests the request's headers against the given headers predicate.- 参数:
headersPredicate- a predicate that tests against the request headers- 返回:
- a predicate that tests against the given header predicate
contentType
public static RequestPredicate contentType(MediaType... mediaTypes)
Return aRequestPredicatethat tests if the request's content type is included by any of the given media types.- 参数:
mediaTypes- the media types to match the request's content type against- 返回:
- a predicate that tests the request's content type against the given media types
accept
public static RequestPredicate accept(MediaType... mediaTypes)
Return aRequestPredicatethat tests if the request's accept header is compatible with any of the given media types.- 参数:
mediaTypes- the media types to match the request's accept header against- 返回:
- a predicate that tests the request's accept header against the given media types
GET
public static RequestPredicate GET(String pattern)
Return aRequestPredicatethat matches if request's HTTP method isGETand the givenpatternmatches against the request path.- 参数:
pattern- the path pattern to match against- 返回:
- a predicate that matches if the request method is GET and if the given pattern matches against the request path
HEAD
public static RequestPredicate HEAD(String pattern)
Return aRequestPredicatethat matches if request's HTTP method isHEADand the givenpatternmatches against the request path.- 参数:
pattern- the path pattern to match against- 返回:
- a predicate that matches if the request method is HEAD and if the given pattern matches against the request path
POST
public static RequestPredicate POST(String pattern)
Return aRequestPredicatethat matches if request's HTTP method isPOSTand the givenpatternmatches against the request path.- 参数:
pattern- the path pattern to match against- 返回:
- a predicate that matches if the request method is POST and if the given pattern matches against the request path
PUT
public static RequestPredicate PUT(String pattern)
Return aRequestPredicatethat matches if request's HTTP method isPUTand the givenpatternmatches against the request path.- 参数:
pattern- the path pattern to match against- 返回:
- a predicate that matches if the request method is PUT and if the given pattern matches against the request path
PATCH
public static RequestPredicate PATCH(String pattern)
Return aRequestPredicatethat matches if request's HTTP method isPATCHand the givenpatternmatches against the request path.- 参数:
pattern- the path pattern to match against- 返回:
- a predicate that matches if the request method is PATCH and if the given pattern matches against the request path
DELETE
public static RequestPredicate DELETE(String pattern)
Return aRequestPredicatethat matches if request's HTTP method isDELETEand the givenpatternmatches against the request path.- 参数:
pattern- the path pattern to match against- 返回:
- a predicate that matches if the request method is DELETE and if the given pattern matches against the request path
OPTIONS
public static RequestPredicate OPTIONS(String pattern)
Return aRequestPredicatethat matches if request's HTTP method isOPTIONSand the givenpatternmatches against the request path.- 参数:
pattern- the path pattern to match against- 返回:
- a predicate that matches if the request method is OPTIONS and if the given pattern matches against the request path
pathExtension
public static RequestPredicate pathExtension(String extension)
Return aRequestPredicatethat matches if the request's path has the given extension.- 参数:
extension- the path extension to match against, ignoring case- 返回:
- a predicate that matches if the request's path has the given file extension
pathExtension
public static RequestPredicate pathExtension(Predicate<String> extensionPredicate)
Return aRequestPredicatethat matches if the request's path matches the given predicate.- 参数:
extensionPredicate- the predicate to test against the request path extension- 返回:
- a predicate that matches if the given predicate matches against the request's path file extension
queryParam
public static RequestPredicate queryParam(String name, String value)
Return aRequestPredicatethat matches if the request's query parameter of the given name has the given value.- 参数:
name- the name of the query parameter to test againstvalue- the value of the query parameter to test against- 返回:
- a predicate that matches if the query parameter has the given value
- 从以下版本开始:
- 5.0.7
- 另请参阅:
ServerRequest.queryParam(String)
queryParam
public static RequestPredicate queryParam(String name, Predicate<String> predicate)
Return aRequestPredicatethat tests the request's query parameter of the given name against the given predicate.- 参数:
name- the name of the query parameter to test againstpredicate- the predicate to test against the query parameter value- 返回:
- a predicate that matches the given predicate against the query parameter of the given name
- 另请参阅:
ServerRequest.queryParam(String)