一、常用注解回顾
1.1 @RequestBody与@ResponseBody
//注意并不要求@RequestBody与@ResponseBody成对使用。
public @ResponseBody AjaxResponse saveArticle(@RequestBody ArticleVO article)
如上代码所示:
- @RequestBody修饰请求参数,注解用于接收HTTP的body,默认是使用JSON的格式
- @ResponseBody修饰返回值,注解用于在HTTP的body中携带响应数据,默认是使用JSON的格式。如果不加该注解,spring响应字符串类型,是跳转到模板页面或jsp页面的开发模式。说白了:加上这个注解你开发的是一个数据接口,不加这个注解你开发的是一个页面跳转控制器。
那么我们有一个问题:如果我们想接收或XML数据该怎么办?我们想响应excel的数据格式该怎么办?我们后文来回答这个问题。
1.2. @RequestMapping注解
@RequestMapping注解是所有常用注解中,最有看点的一个注解,用于标注HTTP服务端点。它的很多属性对于丰富我们的应用开发方式方法,都有很重要的作用。如:
- value: 应用请求端点,最核心的属性,用于标志请求处理方法的唯一性;
- method: HTTP协议的method类型, 如:GET、POST、PUT、DELETE等;
- consumes: HTTP协议请求内容的数据类型(Content-Type),例如application/json, text/html;
- produces: HTTP协议响应内容的数据类型。下文会详细讲解。
- params: HTTP请求中必须包含某些参数值的时候,才允许被注解标注的方法处理请求。
- headers: HTTP请求中必须包含某些指定的header值,才允许被注解标注的方法处理请求。
@RequestMapping(value = "/article", method = POST)
@PostMapping(value = "/article")
上面代码中两种写法起到的是一样的效果,也就是PostMapping等同于@RequestMapping的method等于POST。同理:@GetMapping、@PutMapping、@DeleteMapping也都是简写的方式。
1.3. @RestController与@Controller
@Controller注解是开发中最常使用的注解,它的作用有两层含义:
- 一是告诉Spring,被该注解标注的类是一个Spring的Bean,需要被注入到Spring的上下文环境中。
- 二是该类里面所有被RequestMapping标注的注解都是HTTP服务端点。
@RestController相当于 @Controller和@ResponseBody结合。它有两层含义:
- 一是作为Controller的作用,将控制器类注入到Spring上下文环境,该类RequestMapping标注方法为HTTP服务端点。
- 二是作为ResponseBody的作用,请求响应默认使用的序列化方式是JSON,而不是跳转到jsp或模板页面。
@PathVariable 与@RequestParam
PathVariable用于URI上的{参数},如下方法用于删除一篇文章,其中id为文章id。如:我们的请求URL为“/article/1”,那么将匹配DeleteMapping并且PathVariable接收参数id=1。而RequestParam用于接收普通表单方式或者ajax模拟表单提交的参数数据。
@DeleteMapping("/article/{id}")
public @ResponseBody AjaxResponse deleteArticle(@PathVariable Long id) {
@PostMapping("/article")
public @ResponseBody AjaxResponse deleteArticle(@RequestParam Long id) {
二、接收复杂嵌套对象参数
有一些朋友可能还无法理解RequestBody注解存在的真正意义,表单数据提交用RequestParam就好了,为什么还要搞出来一个RequestBody注解呢?RequestBody注解的真正意义在于能够使用对象或者嵌套对象接收前端数据。