cn.taketoday.web.bind.resolver.AbstractNamedValueResolvingStrategy

cn.taketoday.web.bind.resolver.RequestParamMethodArgumentResolver

所有已实现的接口:: ParameterResolvingStrategy, UriComponentsContributor

public class RequestParamMethodArgumentResolver extends AbstractNamedValueResolvingStrategy implements UriComponentsContributor

Resolves method arguments annotated with @RequestParam, arguments of type MultipartFile in conjunction with MultipartRequest abstraction, and arguments of type jakarta.servlet.http.Part in conjunction with Servlet multipart requests. This resolver can also be created in default resolution mode in which simple types (int, long, etc.) not annotated with @RequestParam are also treated as request parameters with the parameter name derived from the argument name.

If the method parameter type is Map, the name specified in the annotation is used to resolve the request parameter String value. The value is then converted to a Map via type conversion assuming a suitable Converter or PropertyEditor has been registered. Or if a request parameter name is not specified the RequestParamMapMethodArgumentResolver is used instead to provide access to all request parameters in the form of a map.

A WebDataBinder is invoked to apply type conversion to resolved request header values that don't yet match the method parameter type.

从以下版本开始:

4.0 2022/4/28 13:57

作者:

Arjen Poutsma, Rossen Stoyanchev, Brian Clozel, Harry Yang

另请参阅:

RequestParamMapMethodArgumentResolver

字段概要

字段

修饰符和类型

字段

说明

private static final cn.taketoday.core.TypeDescriptor

STRING_TYPE_DESCRIPTOR

private final boolean

useDefaultResolution
构造器概要

构造器

构造器

说明

RequestParamMethodArgumentResolver(boolean useDefaultResolution)

Create a new RequestParamMethodArgumentResolver instance.

RequestParamMethodArgumentResolver(cn.taketoday.beans.factory.config.ConfigurableBeanFactory beanFactory, boolean useDefaultResolution)

Create a new RequestParamMethodArgumentResolver instance.
方法概要

修饰符和类型

方法

说明

void

contributeMethodArgument(cn.taketoday.core.MethodParameter parameter, Object value, UriComponentsBuilder builder, Map<String,Object> uriVariables, cn.taketoday.core.conversion.ConversionService conversionService)

Process the given method argument and either update the UriComponentsBuilder or add to the map with URI variables to use to expand the URI after all arguments are processed.

protected String

formatUriValue(cn.taketoday.core.conversion.ConversionService cs, cn.taketoday.core.TypeDescriptor sourceType, Object value)

protected void

handleMissingValue(String name, cn.taketoday.core.MethodParameter parameter, RequestContext request)

Invoked when a named value is required, but AbstractNamedValueResolvingStrategy.resolveName(String, ResolvableMethodParameter, RequestContext) returned null and there is no default value.

protected void

handleMissingValueAfterConversion(String name, cn.taketoday.core.MethodParameter parameter, RequestContext request)

Invoked when a named value is present but becomes null after conversion.

protected void

handleMissingValueInternal(String name, cn.taketoday.core.MethodParameter parameter, RequestContext request, boolean missingAfterConversion)

protected Object

resolveName(String name, ResolvableMethodParameter resolvable, RequestContext request)

Resolve the given parameter type and value name into an argument value.

boolean

supportsParameter(cn.taketoday.core.MethodParameter parameter)

Supports the following: @RequestParam-annotated method arguments.

boolean

supportsParameter(ResolvableMethodParameter resolvable)

Whether the given parameter is supported by this resolver.

从类继承的方法 cn.taketoday.web.bind.resolver.AbstractNamedValueResolvingStrategy
getNamedValueInfo, handleMissingValue, handleResolvedValue, resolveArgument

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料
- STRING_TYPE_DESCRIPTOR
  
  private static final cn.taketoday.core.TypeDescriptor STRING_TYPE_DESCRIPTOR
- useDefaultResolution
  
  private final boolean useDefaultResolution
构造器详细资料
- RequestParamMethodArgumentResolver
  
  public RequestParamMethodArgumentResolver(boolean useDefaultResolution)
  
  Create a new RequestParamMethodArgumentResolver instance.
  
  参数:
  
  useDefaultResolution - in default resolution mode a method argument that is a simple type, as defined in BeanUtils.isSimpleProperty(java.lang.Class<?>), is treated as a request parameter even if it isn't annotated, the request parameter name is derived from the method parameter name.
- RequestParamMethodArgumentResolver
  
  public RequestParamMethodArgumentResolver(@Nullable cn.taketoday.beans.factory.config.ConfigurableBeanFactory beanFactory, boolean useDefaultResolution)
  
  Create a new RequestParamMethodArgumentResolver instance.
  
  参数:
  
  beanFactory - a bean factory used for resolving ${...} placeholder and #{...} SpEL expressions in default values, or null if default values are not expected to contain expressions
  
  useDefaultResolution - in default resolution mode a method argument that is a simple type, as defined in BeanUtils.isSimpleProperty(java.lang.Class<?>), is treated as a request parameter even if it isn't annotated, the request parameter name is derived from the method parameter name.
方法详细资料
- supportsParameter
  
  public boolean supportsParameter(cn.taketoday.core.MethodParameter parameter)
  Supports the following:
  
  @RequestParam-annotated method arguments. This excludes Map params where the annotation does not specify a name. See RequestParamMapMethodArgumentResolver instead for such params.
  Arguments of type MultipartFile unless annotated with @RequestPart.
  Arguments of type Part unless annotated with @RequestPart.
  In default resolution mode, simple type arguments even if not with @RequestParam.
  指定者:
  
  supportsParameter 在接口中 UriComponentsContributor
- supportsParameter
  
  public boolean supportsParameter(ResolvableMethodParameter resolvable)
  
  从接口复制的说明: ParameterResolvingStrategy
  
  Whether the given parameter is supported by this resolver.
  static match
  
  指定者:
  
  supportsParameter 在接口中 ParameterResolvingStrategy
- resolveName
  
  @Nullable protected Object resolveName(String name, ResolvableMethodParameter resolvable, RequestContext request) throws Exception
  
  从类复制的说明: AbstractNamedValueResolvingStrategy
  
  Resolve the given parameter type and value name into an argument value.
  
  指定者:
  
  resolveName 在类中 AbstractNamedValueResolvingStrategy
  
  参数:
  
  name - the name of the value being resolved
  
  resolvable - the method parameter to resolve to an argument value (pre-nested in case of a Optional declaration)
  
  request - the current request context
  
  返回:
  
  the resolved argument (may be null)
  
  抛出:
  
  Exception - in case of errors
- handleMissingValue
  
  protected void handleMissingValue(String name, cn.taketoday.core.MethodParameter parameter, RequestContext request) throws Exception
  
  从类复制的说明: AbstractNamedValueResolvingStrategy
  
  Invoked when a named value is required, but AbstractNamedValueResolvingStrategy.resolveName(String, ResolvableMethodParameter, RequestContext) returned null and there is no default value. Subclasses typically throw an exception in this case.
  
  覆盖:
  
  handleMissingValue 在类中 AbstractNamedValueResolvingStrategy
  
  参数:
  
  name - the name for the value
  
  parameter - the method parameter
  
  request - the current request
  
  抛出:
  
  Exception
- handleMissingValueAfterConversion
  
  protected void handleMissingValueAfterConversion(String name, cn.taketoday.core.MethodParameter parameter, RequestContext request) throws Exception
  
  从类复制的说明: AbstractNamedValueResolvingStrategy
  
  Invoked when a named value is present but becomes null after conversion.
  
  覆盖:
  
  handleMissingValueAfterConversion 在类中 AbstractNamedValueResolvingStrategy
  
  参数:
  
  name - the name for the value
  
  parameter - the method parameter
  
  request - the current request
  
  抛出:
  
  Exception
- handleMissingValueInternal
  
  protected void handleMissingValueInternal(String name, cn.taketoday.core.MethodParameter parameter, RequestContext request, boolean missingAfterConversion) throws Exception
  
  抛出:
  
  Exception
- contributeMethodArgument
  
  public void contributeMethodArgument(cn.taketoday.core.MethodParameter parameter, @Nullable Object value, UriComponentsBuilder builder, Map<String,Object> uriVariables, cn.taketoday.core.conversion.ConversionService conversionService)
  
  从接口复制的说明: UriComponentsContributor
  
  Process the given method argument and either update the UriComponentsBuilder or add to the map with URI variables to use to expand the URI after all arguments are processed.
  
  指定者:
  
  contributeMethodArgument 在接口中 UriComponentsContributor
  
  参数:
  
  parameter - the controller method parameter (never null)
  
  value - the argument value (possibly null)
  
  builder - the builder to update (never null)
  
  uriVariables - a map to add URI variables to (never null)
  
  conversionService - a ConversionService to format values as Strings
- formatUriValue
  
  @Nullable protected String formatUriValue(@Nullable cn.taketoday.core.conversion.ConversionService cs, @Nullable cn.taketoday.core.TypeDescriptor sourceType, @Nullable Object value)

类 RequestParamMethodArgumentResolver

字段概要

构造器概要

方法概要

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

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

字段详细资料

STRING_TYPE_DESCRIPTOR

useDefaultResolution

构造器详细资料

RequestParamMethodArgumentResolver

RequestParamMethodArgumentResolver

方法详细资料

supportsParameter

supportsParameter

resolveName

handleMissingValue

handleMissingValueAfterConversion

handleMissingValueInternal

contributeMethodArgument

formatUriValue