com.yanzhenjie.andserver.annotation

Annotation Type RequestMapping

@Target(value={METHOD,TYPE})
 @Retention(value=SOURCE)
public @interface RequestMapping

Created by Zhenjie Yan on 2018/6/3.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	consumes The consumable media types of the mapped request, narrowing the primary mapping.
java.lang.String[]	headers The headers of the mapped request, narrowing the primary mapping.
RequestMethod[]	method The HTTP request methods to map to, narrowing the primary mapping: GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.
java.lang.String[]	params The parameters of the mapped request, narrowing the primary mapping.
java.lang.String[]	path The primary mapping expressed by this annotation.
java.lang.String[]	produces The producible media types of the mapped request, narrowing the primary mapping.
java.lang.String[]	value Alias for path().

Element Detail

value

public abstract java.lang.String[] value

Alias for path().

Default:

{}

path

public abstract java.lang.String[] path

The primary mapping expressed by this annotation. For example @RequestMapping ("/foo") is equivalent to @RequestMapping (path="/foo").

Supported at the type level as well as at the method level. When used at the type level, all method-level mappings inherit this primary mapping, narrowing it for a specific handler method.

Default:

{}

method

public abstract RequestMethod[] method

The HTTP request methods to map to, narrowing the primary mapping: GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.

Supported at the type level as well as at the method level. When used at the type level, all method-level mappings inherit this HTTP method restriction (i.e. the type-level restriction gets checked before the handler method is even resolved).

Default:

{}

params

public abstract java.lang.String[] params

The parameters of the mapped request, narrowing the primary mapping.

A sequence of "myParam=myValue" style expressions, with a request only mapped if each such parameter is found to have the given value. Expressions can be negated by using the "!=" operator, as in "myParam!=myValue". "myParam" style expressions are also supported, with such parameters having to be present in the request (allowed to have any value). Finally, "!myParam" style expressions indicate that the specified parameter is not supposed to be present in the request.

Supported at the type level as well as at the method level. When used at the type level, all method-level mappings inherit this parameter restriction (i.e. the type-level restriction gets checked before the handler method is even resolved).

Default:

{}

headers

public abstract java.lang.String[] headers

The headers of the mapped request, narrowing the primary mapping.

A sequence of "My-Header=myValue" style expressions, with a request only mapped if each such header is found to have the given value. Expressions can be negated by using the "!=" operator, as in "My-Header!=myValue". "My-Header" style expressions are also supported, with such headers having to be present in the request (allowed to have any value). Finally, "!My-Header" style expressions indicate that the specified header is not supposed to be present in the request.

Also supports media type wildcards (*), for headers such as Accept and Content-Type. For instance,

 @RequestMapping(value = "/something", headers = "content-type=text/*") 

will match requests with a Content-Type of "text/html", "text/plain", etc.

Supported at the type level as well as at the method level. When used at the type level, all method-level mappings inherit this header restriction (i .e. the type-level restriction gets checked before the handler method is even resolved).

Default:

{}

consumes

public abstract java.lang.String[] consumes

The consumable media types of the mapped request, narrowing the primary mapping.

The format is a single media type or a sequence of media types, with a request only mapped if the Content-Type matches one of these media types. Examples:

 consumes = "text/plain" consumes = {"text/plain", "application/*"} 

Expressions can be negated by using the "!" operator, as in "!text/plain", which matches all requests with a Content-Type other than "text/plain".

Supported at the type level as well as at the method level. When used at the type level, all method-level mappings override this consumes restriction.

Default:

{}

produces

public abstract java.lang.String[] produces

The producible media types of the mapped request, narrowing the primary mapping.

The format is a single media type or a sequence of media types, with a request only mapped if the Accept matches one of these media types. Examples:

 produces = "text/plain" produces = {"text/plain", "application/*"} produces =
 "application/json; charset=UTF-8" 

It affects the actual content type written, for example to produce a JSON response with UTF-8 encoding, "application/json; charset=UTF-8" should be used.

Expressions can be negated by using the "!" operator, as in "!text/plain", which matches all requests with a Accept other than "text/plain".

Supported at the type level as well as at the method level. When used at the type level, all method-level mappings override this produces restriction.

Default:

{}