Spring MVC常用注解

2021-09-11 07:56:24

启用包扫描逐渐功能：
<context:component-scan base-package="org.xxx.xxx"
例如：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

    <context:component-scan base-package="org.springframework.samples.petclinic.web"/>

    <!-- ... -->
</beans>

@Controller

指示一个控制器。

@RequestMapping

请求动作映射,@RequestMapping注释来将URL映射/appointments到整个类或特定的处理程序方法

属性：

value:String[]类型，非必需，用于将请求的实际地址映射到方法上

name:String 类型，非必需，给映射地址一个别名

method:RequestMethod[],非必需，指定请求类型，GET,POST,HEAD,OPTIONS,PUT,PATCH,DELETE,TRACE

consumes:String[]类型，非必需，指定请求的提交内容类型（Content-Type）如：application/json,text/html等

produces:String类型，非必需，指定返回的内容类型，必须是request请求头重所包含的类型。

params:String[]类型，非必需，指定request中必须包含某些值时，才用这个方法处理。

headers:String[]类型，非必需，指定request中有指定的header时，才用这个方法处理。

Path:String[]类型，非必需，在Servlet环境中，只用uri映射

请求方法中可以出现的参数类型：
org.springframework.web.context.request.WebRequest
org.springframework.web.context.request.NativeWebRequest
java.util.Locale 当前请求的语言环境
java.util.TimeZone 时区
java.io.InputStream或java.io.Reader
java.io.OutputStream或java.io.Writer
org.springframework.http.HttpMethod
java.security.Principal
HttpEntity <?>参数用于访问Servlet的HTTP请求的标题和内容
java.util.Map / org.springframework.ui.Model / org.springframework.ui.ModelMap 视图隐含模型
org.springframework.web.servlet.mvc.support.RedirectAttributes 重定向
命令或表单对象
基本数据类型，如int,String,double...
复杂数据类型，如自定义的POJO对象
HandlerAdapter
org.springframework.validation.Errors / org.springframework.validation.BindingResult 验证结果
org.springframework.web.bind.support.SessionStatus 会话状态
org.springframework.web.util.UriComponentsBuilder
@PathVariable 注解参数访问URI模板变量。
@MatrixVariable 注释参数用于访问位于URI路径段键值对对，矩阵变量。
@RequestParam 注解参数访问特定的Servlet请求参数，请求参数绑定。
@RequestHeader 注解参数访问特定的servlet请求HTTP标头，映射请求头。
@RequestBody 注解参数访问HTTP请求主体，注解映射请求体
@RequestPart 注解参数访问“的multipart / form-data的”请求部分的内容。处理客户端上传文件，多部分文件上传的支持
@SessionAttribute 注解参数会话属性
@RequestAttribute 注解参数访问请求属性
可简记如下：
（1 ）HttpServlet 对象，主要包括HttpServletRequest 、HttpServletResponse 和HttpSession 对象。这些参数Spring 在调用处理器方法的时候会自动给它们赋值，所以当在处理器方法中需要使用到这些对象的时候，可以直接在方法上给定一个方法参数的申明，然后在方法体里面直接用就可以了。但是有一点需要注意的是在使用HttpSession 对象的时候，如果此时HttpSession 对象还没有建立起来的话就会有问题。
（2 ）Spring 自己的WebRequest 对象。使用该对象可以访问到存放在HttpServletRequest 和HttpSession 中的属性值。
（3 ）InputStream 、OutputStream 、Reader 和Writer 。 InputStream 和Reader 是针对HttpServletRequest 而言的，可以从里面取数据；OutputStream 和Writer 是针对HttpServletResponse 而言的，可以往里面写数据。
（4 ）使用@PathVariable 、@RequestParam 、@CookieValue 和@RequestHeader 标记的参数。
（5 ）使用@ModelAttribute 标记的参数。
（6 ）java.util.Map 、Spring 封装的Model 和ModelMap 。这些都可以用来封装模型数据，用来给视图做展示。
（7 ）实体类。可以用来接收上传的参数。
（8 ）Spring 封装的MultipartFile 。用来接收上传文件的。
（9 ）Spring 封装的Errors 和BindingResult 对象。这两个对象参数必须紧接在需要验证的实体对象参数之后，它里面包含了实体对象的验证结果。

请求处理方法可以返回的类型：
（1 ）一个包含模型和视图的ModelAndView 对象。
（2 ）一个模型对象，这主要包括Spring 封装好的Model 和ModelMap ，以及java.util.Map ，当没有视图返回的时候视图名称将由RequestToViewNameTranslator 来决定。
（3 ）一个View 对象。这个时候如果在渲染视图的过程中模型的话就可以给处理器方法定义一个模型参数，然后在方法体里面往模型中添加值。
（4 ）一个String 字符串。这往往代表的是一个视图名称。这个时候如果需要在渲染视图的过程中需要模型的话就可以给处理器方法一个模型参数，然后在方法体里面往模型中添加值就可以了。
（5 ）返回值是void 。这种情况一般是我们直接把返回结果写到HttpServletResponse 中了，如果没有写的话，那么Spring 将会利用RequestToViewNameTranslator 来返回一个对应的视图名称。如果视图中需要模型的话，处理方法与返回字符串的情况相同。
（6 ）如果处理器方法被注解@ResponseBody 标记的话，那么处理器方法的任何返回类型都会通过HttpMessageConverters 转换之后写到HttpServletResponse 中，而不会像上面的那些情况一样当做视图或者模型来处理。
（7 ）除以上几种情况之外的其他任何返回类型都会被当做模型中的一个属性来处理，而返回的视图还是由RequestToViewNameTranslator 来决定，添加到模型中的属性名称可以在该方法上用@ModelAttribute(“attributeName”) 来定义，否则将使用返回类型的类名称的首字母小写形式来表示。使用@ModelAttribute 标记的方法会在@RequestMapping 标记的方法执行之前执行。

@RequestParam

用于将指定的请求参数赋值给方法中的形参。

属性：

name:String类型，非必需，指定请求头绑定的名称。

value:String类型，非必需，namme属性的别名。

required:boolean类型，非必需，指定参数是否必须绑定。

defaultValue:String类型，非必需，参数默认值。

@PathVariable

属性
value:String类型，非必需，如果省略则默认绑定同名参数，表示取值uri中的变量值。

@RequestHeader

将请求头数据映射到处理方法的参数上。

属性：

name:String类型，非必需，请求头绑定的名称。

value:String类型，非必需，name的别名。

required:boolean类型，非必需，指定参数是否必须绑定。

defaultValue:String类型，非必需，参数默认值。

@CookieValue

映射请求头的Cookie信息到处理方法的参数上。

属性：

name:String类型，非必需，请求头绑定的名称。

value:String类型，非必需，name的别名。

required:boolean类型，非必需，指定参数是否必须绑定。

defaultValue:String类型，非必需，参数默认值。

@SessionAttributes

允许我们有选择的指定Model中的哪些属性需要转存到HttpSession对象中。

属性：

names:String[]类型，非必需，Model中属性的名称，即存在HttpSession中的名称。

value:String[]类型，非必需，names属性的别名。

types:Class<?>[],非必需，指定参数是否必须绑定。
只能声明在类上，不能声明到方法上。

码农公寓