程序包 cn.taketoday.web.bind.resolver

类 RequestResponseBodyMethodProcessor

java.lang.Object

cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodArgumentResolver

cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodProcessor

cn.taketoday.web.bind.resolver.RequestResponseBodyMethodProcessor

所有已实现的接口:

ParameterResolvingStrategy, HandlerMethodReturnValueHandler, ReturnValueHandler

public class RequestResponseBodyMethodProcessor
extends AbstractMessageConverterMethodProcessor
implements HandlerMethodReturnValueHandler

Resolves method arguments annotated with @RequestBody and handles return values from methods annotated with @ResponseBody by reading and writing to the body of the request or response with an HttpMessageConverter.

从以下版本开始:

4.0 2022/1/23 17:14

作者:

Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller, Harry Yang

嵌套类概要

从类继承的嵌套类/接口 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodProcessor

AbstractMessageConverterMethodProcessor.ServletDelegate

字段概要

从类继承的字段 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodArgumentResolver

messageConverters

从接口继承的字段 cn.taketoday.web.ReturnValueHandler

NONE_RETURN_VALUE

构造器概要

构造器

构造器	说明
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters)	Basic constructor with converters only.
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager)	Basic constructor with converters and ContentNegotiationManager.
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice)	Complete constructor for resolving @RequestBody and handling @ResponseBody.
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters, List<Object> requestResponseBodyAdvice)	Complete constructor for resolving @RequestBody method arguments.

方法概要

修饰符和类型	方法	说明
protected boolean	checkRequired(cn.taketoday.core.MethodParameter parameter)
void	handleReturnValue(RequestContext context, Object handler, Object returnValue)	Handle result of the handler
protected Object	readWithMessageConverters(RequestContext request, cn.taketoday.core.MethodParameter parameter, Type paramType)	Create the method argument value of the expected parameter type by reading from the given request.
Object	resolveArgument(RequestContext context, ResolvableMethodParameter resolvable)	Throws MethodArgumentNotValidException if validation fails.
boolean	supportsHandlerMethod(HandlerMethod handler)	Whether the given method is supported by this handler.
boolean	supportsParameter(ResolvableMethodParameter resolvable)	Whether the given parameter is supported by this resolver.
boolean	supportsReturnValue(Object returnValue)	If this ReturnValueHandler supports the target handler's result

从类继承的方法 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodProcessor

getProducibleMediaTypes, getProducibleMediaTypes, getReturnValueType, isResourceType, writeWithMessageConverters

从类继承的方法 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodArgumentResolver

adaptArgumentIfNecessary, closeStreamIfNecessary, getAdvice, getSupportedMediaTypes, isBindExceptionRequired, readWithMessageConverters, validateIfApplicable, validateIfApplicable

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

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

从接口继承的方法 cn.taketoday.web.handler.result.HandlerMethodReturnValueHandler

handleHandlerMethodReturnValue, supportsHandler

构造器详细资料

RequestResponseBodyMethodProcessor

public RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters)

Basic constructor with converters only. Suitable for resolving @RequestBody. For handling @ResponseBody consider also providing a ContentNegotiationManager.

RequestResponseBodyMethodProcessor

public RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters,
 @Nullable
 ContentNegotiationManager manager)

Basic constructor with converters and ContentNegotiationManager. Suitable for resolving @RequestBody and handling @ResponseBody without Request~ or ResponseBodyAdvice.

RequestResponseBodyMethodProcessor

public RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters,
 @Nullable
 List<Object> requestResponseBodyAdvice)

Complete constructor for resolving @RequestBody method arguments. For handling @ResponseBody consider also providing a ContentNegotiationManager.

RequestResponseBodyMethodProcessor

public RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> converters,
 @Nullable
 ContentNegotiationManager manager,
 @Nullable
 List<Object> requestResponseBodyAdvice)

Complete constructor for resolving @RequestBody and handling @ResponseBody.

方法详细资料

supportsParameter

public boolean supportsParameter(ResolvableMethodParameter resolvable)

从接口复制的说明: ParameterResolvingStrategy

Whether the given parameter is supported by this resolver.

static match

指定者:

supportsParameter 在接口中 ParameterResolvingStrategy

resolveArgument

@Nullable
public Object resolveArgument(RequestContext context,
 ResolvableMethodParameter resolvable)
                       throws Throwable

Throws MethodArgumentNotValidException if validation fails.

指定者:

resolveArgument 在接口中 ParameterResolvingStrategy

参数:

context - Current request context

resolvable - resolvable parameter

返回:

method parameter instance

抛出:

HttpMessageNotReadableException - if RequestBody.required() is true and there is no body content or if there is no suitable converter to read the content with.

Throwable - if any Exception occurred

另请参阅:

• MethodParameterResolvingException

readWithMessageConverters

protected Object readWithMessageConverters(RequestContext request,
 cn.taketoday.core.MethodParameter parameter,
 Type paramType)
                                    throws IOException,
HttpMediaTypeNotSupportedException,
HttpMessageNotReadableException

从类复制的说明: AbstractMessageConverterMethodArgumentResolver

Create the method argument value of the expected parameter type by reading from the given request.

覆盖:

readWithMessageConverters 在类中 AbstractMessageConverterMethodArgumentResolver

参数:

request - the current request

parameter - the method parameter descriptor (may be null)

paramType - the type of the argument value to be created

返回:

the created method argument value

抛出:

IOException - if the reading from the request fails

HttpMediaTypeNotSupportedException - if no suitable message converter is found

HttpMessageNotReadableException

checkRequired

protected boolean checkRequired(cn.taketoday.core.MethodParameter parameter)

supportsHandlerMethod

public boolean supportsHandlerMethod(HandlerMethod handler)

从接口复制的说明: HandlerMethodReturnValueHandler

Whether the given method is supported by this handler.

指定者:

supportsHandlerMethod 在接口中 HandlerMethodReturnValueHandler

返回:

true if this handler supports the supplied return type; false otherwise

另请参阅:

• HandlerMethod

supportsReturnValue

public boolean supportsReturnValue(@Nullable
 Object returnValue)

从接口复制的说明: ReturnValueHandler

If this ReturnValueHandler supports the target handler's result

This method can test this ReturnValueHandler supports the target handler in application runtime

指定者:

supportsReturnValue 在接口中 ReturnValueHandler

参数:

returnValue - Target handler's return-value or result

返回:

If this ReturnValueHandler supports the target handler's result

handleReturnValue

public void handleReturnValue(RequestContext context,
 @Nullable
 Object handler,
 @Nullable
 Object returnValue)
                       throws Exception

从接口复制的说明: HandlerMethodReturnValueHandler

Handle result of the handler

指定者:

handleReturnValue 在接口中 HandlerMethodReturnValueHandler

指定者:

handleReturnValue 在接口中 ReturnValueHandler

参数:

context - Current HTTP request context

handler - handler may be HandlerMethod

returnValue - Handler execution result Or HandlerExceptionHandler return value

抛出:

Exception - return-value handled failed