程序包 cn.taketoday.web.annotation

Annotation Interface RequestHeader

@Documented @RequestParam @Retention(RUNTIME) @Target({PARAMETER,FIELD}) public @interface RequestHeader
Annotation which indicates that a method parameter should be bound to a web request header.

Supported for annotated handler methods in Web MVC and Infra WebFlux.

If the method parameter is Map<String, String>, MultiValueMap<String, String>, or HttpHeaders then the map is populated with all header names and values.

从以下版本开始:
2018-08-21 19:19
作者:
Juergen Hoeller, Sam Brannen, TODAY
另请参阅:

  • 可选元素概要

    可选元素
    修饰符和类型
    可选元素
    说明
    String
    defaultValue
    The default value to use as a fallback.
    String
    name
    The name of the request header to bind to.
    boolean
    required
    Whether the header is required.
    String
    value
    Alias for name().

  • 元素详细资料

    • value

      @AliasFor(annotation=RequestParam.class, attribute="value") String value
      Alias for name().
      默认值:
      ""

    • name

      @AliasFor(annotation=RequestParam.class, attribute="name") String name
      The name of the request header to bind to.
      从以下版本开始:
      4.0
      默认值:
      ""

    • required

      @AliasFor(annotation=RequestParam.class, attribute="required") boolean required
      Whether the header is required.

      Defaults to true, leading to an exception being thrown if the header is missing in the request. Switch this to false if you prefer a null value if the header is not present in the request.

      Alternatively, provide a defaultValue(), which implicitly sets this flag to false.

      默认值:
      true

    • defaultValue

      @AliasFor(annotation=RequestParam.class, attribute="defaultValue") String defaultValue
      The default value to use as a fallback.

      Supplying a default value implicitly sets required() to false.

      默认值:
      "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"