程序包 cn.taketoday.web.handler.function

类 DefaultServerRequest

java.lang.Object

cn.taketoday.web.handler.function.DefaultServerRequest

所有已实现的接口:

ServerRequest, ServerResponse.Context

class DefaultServerRequest
extends Object
implements ServerRequest

ServerRequest implementation based on a RequestContext.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Sam Brannen, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
(专用程序包) static class	DefaultServerRequest.CheckNotModifiedResponse
(专用程序包) static class	DefaultServerRequest.DefaultRequestHeaders	Default implementation of ServerRequest.Headers.
private static final class	DefaultServerRequest.ServletAttributesMap
private static final class	DefaultServerRequest.ServletParametersMap

从接口继承的嵌套类/接口 cn.taketoday.web.handler.function.ServerRequest

ServerRequest.Builder, ServerRequest.Headers

字段概要

字段

修饰符和类型	字段	说明
private final Map<String,Object>	attributes
private final ServerRequest.Headers	headers
private final List<HttpMessageConverter<?>>	messageConverters
private final cn.taketoday.util.MultiValueMap<String,String>	params
private cn.taketoday.util.MultiValueMap<String,Multipart>	parts
private final RequestContext	requestContext
private final RequestPath	requestPath

构造器概要

构造器

构造器	说明
DefaultServerRequest(RequestContext requestContext, List<HttpMessageConverter<?>> messageConverters)

方法概要

修饰符和类型	方法	说明
Optional<Object>	attribute(String name)	Get the request attribute value if present.
Map<String,Object>	attributes()	Get a mutable map of request attributes.
<T> T	bind(Class<T> bindType, Consumer<WebDataBinder> dataBinderCustomizer)	Bind to this request and return an instance of the given type.
<T> T	body(cn.taketoday.core.ParameterizedTypeReference<T> bodyType)	Extract the body as an object of the given type.
<T> T	body(Class<T> bodyType)	Extract the body as an object of the given type.
(专用程序包) static Class<?>	bodyClass(Type type)
private <T> T	bodyInternal(Type bodyType, Class bodyClass)
(专用程序包) static Optional<ServerResponse>	checkNotModified(RequestContext context, Instant lastModified, String etag)
cn.taketoday.util.MultiValueMap<String,HttpCookie>	cookies()	Get the cookies of this request.
RequestContext	exchange()	Get the request that this request is based on.
private List<MediaType>	getSupportedMediaTypes(Class<?> bodyClass)
ServerRequest.Headers	headers()	Get the headers of this request.
List<HttpMessageConverter<?>>	messageConverters()	Get the readers used to convert the body of this request.
HttpMethod	method()	Get the HTTP method.
String	methodName()	Get the name of the HTTP method.
cn.taketoday.util.MultiValueMap<String,Multipart>	multipartData()	Get the parts of a multipart request, provided the Content-Type is "multipart/form-data", or an exception otherwise.
Optional<String>	param(String name)	Get the first parameter with the given name, if present.
cn.taketoday.util.MultiValueMap<String,String>	params()	Get all parameters for this request. parameters are contained in the query string or posted form data.
List<String>	params(String name)	Get the parameters with the given name.
Map<String,String>	pathVariables()	Get all path variables for this request.
Optional<InetSocketAddress>	remoteAddress()	Get the remote address to which this request is connected, if available.
RequestPath	requestPath()	Get the request path as a PathContainer.
String	toString()
URI	uri()	Get the request URI.
UriBuilder	uriBuilder()	Get a UriBuilderComponents from the URI associated with this ServerRequest.

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

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

从接口继承的方法 cn.taketoday.web.handler.function.ServerRequest

bind, checkNotModified, checkNotModified, checkNotModified, path, pathVariable

字段详细资料

headers

private final ServerRequest.Headers headers

requestPath

private final RequestPath requestPath

requestContext

private final RequestContext requestContext

attributes

private final Map<String,Object> attributes

params

private final cn.taketoday.util.MultiValueMap<String,String> params

messageConverters

private final List<HttpMessageConverter<?>> messageConverters

parts

@Nullable
private cn.taketoday.util.MultiValueMap<String,Multipart> parts

构造器详细资料

DefaultServerRequest

DefaultServerRequest(RequestContext requestContext,
 List<HttpMessageConverter<?>> messageConverters)

方法详细资料

method

public HttpMethod method()

从接口复制的说明: ServerRequest

Get the HTTP method.

指定者:

method 在接口中 ServerRequest

返回:

the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)

methodName

public String methodName()

从接口复制的说明: ServerRequest

Get the name of the HTTP method.

指定者:

methodName 在接口中 ServerRequest

返回:

the HTTP method as a String

uri

public URI uri()

从接口复制的说明: ServerRequest

Get the request URI.

指定者:

uri 在接口中 ServerRequest

uriBuilder

public UriBuilder uriBuilder()

从接口复制的说明: ServerRequest

Get a UriBuilderComponents from the URI associated with this ServerRequest.

指定者:

uriBuilder 在接口中 ServerRequest

返回:

a URI builder

requestPath

public RequestPath requestPath()

从接口复制的说明: ServerRequest

Get the request path as a PathContainer.

指定者:

requestPath 在接口中 ServerRequest

headers

public ServerRequest.Headers headers()

从接口复制的说明: ServerRequest

Get the headers of this request.

指定者:

headers 在接口中 ServerRequest

cookies

public cn.taketoday.util.MultiValueMap<String,HttpCookie> cookies()

从接口复制的说明: ServerRequest

Get the cookies of this request.

指定者:

cookies 在接口中 ServerRequest

exchange

public RequestContext exchange()

从接口复制的说明: ServerRequest

Get the request that this request is based on.

指定者:

exchange 在接口中 ServerRequest

remoteAddress

public Optional<InetSocketAddress> remoteAddress()

从接口复制的说明: ServerRequest

Get the remote address to which this request is connected, if available.

指定者:

remoteAddress 在接口中 ServerRequest

messageConverters

public List<HttpMessageConverter<?>> messageConverters()

从接口复制的说明: ServerRequest

Get the readers used to convert the body of this request.

指定者:

messageConverters 在接口中 ServerRequest

指定者:

messageConverters 在接口中 ServerResponse.Context

返回:

the list of message writers

body

public <T> T body(Class<T> bodyType)
           throws IOException

从接口复制的说明: ServerRequest

Extract the body as an object of the given type.

指定者:

body 在接口中 ServerRequest

类型参数:

T - the body type

参数:

bodyType - the type of return value

返回:

the body

抛出:

IOException

body

public <T> T body(cn.taketoday.core.ParameterizedTypeReference<T> bodyType)
           throws IOException

从接口复制的说明: ServerRequest

Extract the body as an object of the given type.

指定者:

body 在接口中 ServerRequest

类型参数:

T - the body type

参数:

bodyType - the type of return value

返回:

the body

抛出:

IOException

bodyClass

static Class<?> bodyClass(Type type)

bodyInternal

private <T> T bodyInternal(Type bodyType,
 Class bodyClass)
                    throws IOException

抛出:

IOException

getSupportedMediaTypes

private List<MediaType> getSupportedMediaTypes(Class<?> bodyClass)

bind

public <T> T bind(Class<T> bindType,
 Consumer<WebDataBinder> dataBinderCustomizer)
           throws cn.taketoday.validation.BindException

从接口复制的说明: ServerRequest

Bind to this request and return an instance of the given type.

指定者:

bind 在接口中 ServerRequest

类型参数:

T - the type to bind to

参数:

bindType - the type of class to bind this request to

dataBinderCustomizer - used to customize the data binder, e.g. set (dis)allowed fields

返回:

a constructed and bound instance of bindType

抛出:

cn.taketoday.validation.BindException - in case of binding errors

attribute

public Optional<Object> attribute(String name)

从接口复制的说明: ServerRequest

Get the request attribute value if present.

指定者:

attribute 在接口中 ServerRequest

参数:

name - the attribute name

返回:

the attribute value

attributes

public Map<String,Object> attributes()

从接口复制的说明: ServerRequest

Get a mutable map of request attributes.

指定者:

attributes 在接口中 ServerRequest

返回:

the request attributes

param

public Optional<String> param(String name)

从接口复制的说明: ServerRequest

Get the first parameter with the given name, if present. parameters are contained in the query string or posted form data.

指定者:

param 在接口中 ServerRequest

参数:

name - the parameter name

返回:

the parameter value

另请参阅:

• RequestContext.getParameter(String)

params

public List<String> params(String name)

从接口复制的说明: ServerRequest

Get the parameters with the given name.

parameters are contained in the query string or posted form data.

指定者:

params 在接口中 ServerRequest

参数:

name - the parameter name

返回:

the parameter value

另请参阅:

• RequestContext.getParameter(String)

params

public cn.taketoday.util.MultiValueMap<String,String> params()

从接口复制的说明: ServerRequest

Get all parameters for this request. parameters are contained in the query string or posted form data.

指定者:

params 在接口中 ServerRequest

另请参阅:

• RequestContext.getParameters()

multipartData

public cn.taketoday.util.MultiValueMap<String,Multipart> multipartData()
                                                                throws IOException

从接口复制的说明: ServerRequest

Get the parts of a multipart request, provided the Content-Type is "multipart/form-data", or an exception otherwise.

指定者:

multipartData 在接口中 ServerRequest

返回:

the multipart data, mapping from name to part(s)

抛出:

IOException - if an I/O error occurred during the retrieval

另请参阅:

• RequestContext.getMultipartRequest()
• MultipartRequest.multipartData()

pathVariables

public Map<String,String> pathVariables()

从接口复制的说明: ServerRequest

Get all path variables for this request.

指定者:

pathVariables 在接口中 ServerRequest

toString

public String toString()

覆盖:

toString 在类中 Object

checkNotModified

static Optional<ServerResponse> checkNotModified(RequestContext context,
 @Nullable
 Instant lastModified,
 @Nullable
 String etag)