SpringMVC常用注解

SpringMVC常用注解

最近在学习SSM框架，遇到一些注解，在这里记录一下。

@controller

@Controller 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping 注解。

@RequestMapping

@RequestMapping用于映射url到控制器类的一个特定处理程序方法。可用于方法或者类上面。也就是可以通过url找到对应的方法。

@RequestMapping有8个属性。

value：指定请求的实际地址。

method：指定请求的method类型（GET,POST,PUT,DELETE）等。

consumes：指定处理请求的提交内容类型（Context-Type）。

produces：指定返回的内容类型，还可以设置返回值的字符编码。

params：指定request中必须包含某些参数值，才让该方法处理。

headers：指定request中必须包含某些指定的header值，才让该方法处理请求。

注解在控制类上

@RequestMapping 标记在Controller 类上的时候，里面使用@RequestMapping 标记的方法的请求地址都是相对于类上的@RequestMapping 而言的。

注解在方法上

当Controller 类上没有标记@RequestMapping 注解时，方法上的@RequestMapping 都是绝对路径。

@GetMapping

@GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写。该注解将HTTP Get 映射到 特定的处理方法上。

@PostMapping

@PostMapping是一个组合注解，是@RequestMapping(method = RequestMethod.POST)的缩写。该注解将HTTP Post 映射到 特定的处理方法上。

@PutMapping

@PutMapping和@PostMapping作用等同，都是用来向服务器提交信息。如果是添加信息，倾向于用@PostMapping，如果是更新信息，倾向于用@PutMapping。

@ResponseBody

@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

@ResponseBody是作用在方法上的，@ResponseBody 表示该方法的返回结果直接写入 HTTP response body 中，一般在异步获取数据时使用【也就是AJAX】。
注意：在使用 @RequestMapping后，返回值通常解析为跳转路径，但是加上 @ResponseBody 后返回结果不会被解析为跳转路径，而是直接写入 HTTP response body 中。

@RequestBody

@RequestBody 注解则是将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。作用：该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上； 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

@RequestAttribute

获取HTTP的请求（request）对象属性值，用来传递给控制器的参数。

@PathVariable

@PathVariable 映射 URL 绑定的占位符

通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。

@NotNull：

不能为null，但可以为empty(""," “,” ") ，一般用在基本数据类型的非空校验上，而且被其标注的字段可以使用 @size/@Max/@Min对字段数值进行大小的控制

@NotEmpty：

不能为null，而且长度必须大于0(" “,” ")，一般用在集合类上面

@NotBlank：

这玩意只能作用在接收的String类型上，注意是只能，不能为null，而且调用trim()后，长度必须大于0

@JsonIgnore和@JsonIgnoreProperties

User实体中会有字段password字段，当返回用户信息给前台的时候，当然是不希望将password值也一并返回，

所以，可以在password属性上加上注解JsonIgnore

或者，可以在User类上加上注解@JsonIgnoreProperties(value = “{password}”)

都可以在json序列化时将java bean中的一些属性忽略掉，序列化和反序列化都受影响。

@JsonRootName

@JsonRootName(value=“rootNode”) 使用在类上，标注为该类在转换为json string的时候，需要新增一个根节点rootNode.

 JSON:{"rootNode":{"address":$#,"age":123}}

写在最后，这只是一小部分，以后遇到其他的再补充。