类 RequestPredicates
- java.lang.Object
- org.springframework.web.servlet.function.RequestPredicates
public abstract class RequestPredicates extends Object
Implementations ofRequestPredicate
that implement various useful request matching operations, such as matching based on path, HTTP method, etc.- 从以下版本开始:
- 5.2
- 作者:
- Arjen Poutsma
嵌套类概要
嵌套类 修饰符和类型 类 说明 static interface
RequestPredicates.Visitor
Receives notifications from the logical structure of request predicates.
构造器概要
构造器 构造器 说明 RequestPredicates()
方法概要
所有方法 静态方法 具体方法 修饰符和类型 方法 说明 static RequestPredicate
accept(MediaType... mediaTypes)
Return aRequestPredicate
that tests if the request's accept header is compatible with any of the given media types.static RequestPredicate
all()
Return aRequestPredicate
that always matches.static RequestPredicate
contentType(MediaType... mediaTypes)
Return aRequestPredicate
that tests if the request's content type is included by any of the given media types.static RequestPredicate
DELETE(String pattern)
Return aRequestPredicate
that matches if request's HTTP method isDELETE
and the givenpattern
matches against the request path.static RequestPredicate
GET(String pattern)
Return aRequestPredicate
that matches if request's HTTP method isGET
and the givenpattern
matches against the request path.static RequestPredicate
HEAD(String pattern)
Return aRequestPredicate
that matches if request's HTTP method isHEAD
and the givenpattern
matches against the request path.static RequestPredicate
headers(Predicate<ServerRequest.Headers> headersPredicate)
Return aRequestPredicate
that tests the request's headers against the given headers predicate.static RequestPredicate
method(HttpMethod httpMethod)
Return aRequestPredicate
that matches if the request's HTTP method is equal to the given method.static RequestPredicate
methods(HttpMethod... httpMethods)
Return aRequestPredicate
that matches if the request's HTTP method is equal to one the of the given methods.static RequestPredicate
OPTIONS(String pattern)
Return aRequestPredicate
that matches if request's HTTP method isOPTIONS
and the givenpattern
matches against the request path.static RequestPredicate
param(String name, String value)
Return aRequestPredicate
that matches if the request's parameter of the given name has the given value.static RequestPredicate
param(String name, Predicate<String> predicate)
Return aRequestPredicate
that tests the request's parameter of the given name against the given predicate.static RequestPredicate
PATCH(String pattern)
Return aRequestPredicate
that matches if request's HTTP method isPATCH
and the givenpattern
matches against the request path.static RequestPredicate
path(String pattern)
Return aRequestPredicate
that tests the request path against the given path pattern.static RequestPredicate
pathExtension(String extension)
Return aRequestPredicate
that matches if the request's path has the given extension.static RequestPredicate
pathExtension(Predicate<String> extensionPredicate)
Return aRequestPredicate
that matches if the request's path matches the given predicate.static Function<String,RequestPredicate>
pathPredicates(PathPatternParser patternParser)
Return a function that creates new path-matchingRequestPredicates
from pattern Strings using the givenPathPatternParser
.static RequestPredicate
POST(String pattern)
Return aRequestPredicate
that matches if request's HTTP method isPOST
and the givenpattern
matches against the request path.static RequestPredicate
PUT(String pattern)
Return aRequestPredicate
that matches if request's HTTP method isPUT
and the givenpattern
matches against the request path.
构造器详细资料
RequestPredicates
public RequestPredicates()
方法详细资料
all
public static RequestPredicate all()
Return aRequestPredicate
that always matches.- 返回:
- a predicate that always matches
method
public static RequestPredicate method(HttpMethod httpMethod)
Return aRequestPredicate
that 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 aRequestPredicate
that 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
path
public static RequestPredicate path(String pattern)
Return aRequestPredicate
that 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-matchingRequestPredicates
from pattern Strings using the givenPathPatternParser
.This method can be used to specify a non-default, customized
PathPatternParser
when 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
RequestPredicates
instance
headers
public static RequestPredicate headers(Predicate<ServerRequest.Headers> headersPredicate)
Return aRequestPredicate
that 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 aRequestPredicate
that 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 aRequestPredicate
that 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 aRequestPredicate
that matches if request's HTTP method isGET
and the givenpattern
matches 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 aRequestPredicate
that matches if request's HTTP method isHEAD
and the givenpattern
matches 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 aRequestPredicate
that matches if request's HTTP method isPOST
and the givenpattern
matches 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 aRequestPredicate
that matches if request's HTTP method isPUT
and the givenpattern
matches 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 aRequestPredicate
that matches if request's HTTP method isPATCH
and the givenpattern
matches 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 aRequestPredicate
that matches if request's HTTP method isDELETE
and the givenpattern
matches 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 aRequestPredicate
that matches if request's HTTP method isOPTIONS
and the givenpattern
matches 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 aRequestPredicate
that 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 aRequestPredicate
that 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
param
public static RequestPredicate param(String name, String value)
Return aRequestPredicate
that matches if the request's parameter of the given name has the given value.- 参数:
name
- the name of the parameter to test againstvalue
- the value of the parameter to test against- 返回:
- a predicate that matches if the parameter has the given value
- 另请参阅:
ServerRequest.param(String)
param
public static RequestPredicate param(String name, Predicate<String> predicate)
Return aRequestPredicate
that tests the request's parameter of the given name against the given predicate.- 参数:
name
- the name of the parameter to test againstpredicate
- the predicate to test against the parameter value- 返回:
- a predicate that matches the given predicate against the parameter of the given name
- 另请参阅:
ServerRequest.param(String)