3.2.2 请求处理方法中可出现的参数类型
- 请求处理方法中可以出现的类型

3.2.2 请求处理方法中可出现的参数类型

每个请求处理方法可以有多个不同类型的参数。
如果需要访问HttpServletRequest对象,则可以添加HttpServletRequest作为参数, Spring会将对象正确地传递给方法:

@RequestMapping(value="/login")
public String login(httpServletRequest request){
    return "login";
}

如果需要访问HttpSession对象,则可以添加HttpSession作为参数, Spring会将对象正确地传递给方法:

请求处理方法中可以出现的类型

下面是可以在请求处理方法中出现的参数类型:

javax.servlet包下可以作为在请求处理方法参数的类

javax.servlet.ServletRequest或javax.servlet.http.HttpServletRequest
javax.servlet.ServletResponse或javax.servlet.http.HttpServletResponse
javax.servlet.http.HttpSession

java.io包下可以作为在请求处理方法参数的类

java.io.InputStream或java.io.Reader- java.io.OutputStream或java.io.Writer

java.util包下可以作为在请求处理方法参数的类

java.util.Locale
java.util.Map

java.security包下可以作为在请求处理方法参数的类

java.security.PrincipalHttpEntity<?>

org.springframework.web包中可以作为在请求处理方法参数的类

org.springframework.web.context.request.WebRequest或org.springframework.web.context.request.NativeWebRequest
org.springframework.web.bind.support.SessionStatus
org.springframework.web.util.UriComponentsBuilder
org.springframework.web.servlet.mvc.support.RedirectAttributes

这里重点说明一下org.springframework.web.context.request.WebRequest这个对象。 WebRequest是Spring MVC提供的统一请求访问接口,

WebRequest可以访问请求相关数据,如参数数据、
WebRequest可以访问请求头数据,
WebRequest 可以访问请求作用域的数据
WebRequest可以访问会话作用域中的数据

但是WebRequest无法访问Cookie区数据,

NativeWebRequest继承了WebRequest,并提供访问本地Servlet API的方法。
WebRequest中有如下这些重点方法:

方法	描述
`getParameter(String name)`	根据请求参数名获取请求参数值。等同于`Servlet API`的`request.getParameter(String name)`。
`getHeader(String name)`	根据请求头参数名获取请求头参数值，等同于`ServletAPI`的`request.getHeader(String name)`
`setAttribute(String name,Object value,int scope)`	保存数据到指定的作用域
`getAttribute(String name,int scope)`	从指定的作用域中提取数据
其中
- `setAttribute`方法等同于`Servlet API`的`scope(request,session).setAttribute(String name,Object value)`方法。参数中的`int scope`是`WebRequest`对象中定义的两个常量`SCOPE_REQUEST`(请求作用域)、`SCOPE_SESSION`(会话作用域)
- `getAttribute`方法等同于`Servlet API`的`scope(request,session).getAttribute(String name)`方法。

从框架的无侵入性来说,建议使用WebRequest对象替代Servlet API的HttpServletRequest对象和HttpSession对象。

org.springframework.ui包中可以作为在请求处理方法参数的类

org.springframework.ui.Model
org.springframework.ui.ModelMap

org.springframework.ui.Model是其中最重要的类型。这不是一个Servlet API类型,而是一个Spring MVC类型,其中包含了Map对象用来存储数据。如果方法中添加了Model参数,则每次调用请求处理方法时, Spring MVC都会创建Model对象,并将其作为参数传递给方法。

org.springframework.validation包中可以作为在请求处理方法参数的类

org.springframework.validation.Errors
org.springframework.validation.BindingResult

可以出现在请求处理方法参数列表中的注解

@PathVariable注解、
@MatrixVariable注解、
@RequestParam注解、
@RequestHeader注解、
@RequestBody注解、
@RequestPart注解

原文链接: 3.2.2 请求处理方法中可出现的参数类型