SpringMVC中参数绑定常用注解

不积跬步，无以至千里。 不积小流，无以成江海。

今天在写一个Ajax请求到Controller时被参数接收的问题耽误了很久。随后详细查了SpringMVC中Controller参数绑定注解，整理记录如下。

在写SpringMVC参数绑定注解前，先看看该如何使用Ajax请求。

Ajax中Content-Type

HTTP请求中使用 Content-Type 这个字段来表示报文主体的对象类型。下面是常用的 Content-Type

• application/x-www-form-urlencoded

这是最常用的POST提交数据的方式。Ajax中不设置Content-Type则默认以这种方式提交数据。

数据格式以key=value&key2=value2 的方式进行编码，作为一个FormData对象进行发送。

• multipart/form-data

在使用表单进行上传文件时使用这种方式。这里不详细展开。

• application/json

这种方式现在很常用，它表示数据是序列化的JSON字符串。通常配合 JSON.stringify() 将一个对象转化成JSON字符串。

• text/xml

表示数据是XML的格式。data中传递的数据需要符合XML格式。

常用注解

在接收请求中的参数时我们经常使用以下注解，可以根据它们处理的Request不同部分分类：

• 处理Request Uri (指Uri中的Variable，不包括拼接在URL中的 QueryString )
  • @PathVariable
• 处理Request Header
  • @RequestHeader
  • @CookieValue
• 处理Request Body
  • @ReuqestParam
  • @RequestBody
• 处理 Attribute 类型
  • @SessionAttributes
  • @ModelAttribute

@PathVariable

示例：

1
2

@PostMapping(value = "/{userId}/roles")
public void queryUserAndRoles(HttpServletRequest request, @PathVariable Long userId) {}

@RequestHeader

从名字可以知道它是获取Request的Header部分字段。

示例：

一个Request Header:

1
2
3
4
5
6
7

POST /dwp/contract/rebuildpdf HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Content-Length: 20
Pragma: no-cache
Cache-Control: no-cache
Accept: application/json, text/javascript, */*; q=0.01

在Controller中获取Request Header中的 Host 与 Content-Length 字段值

1
2

@PostMapping(value = "/dwp/contract/headerInfo")
public void headerInfo(@RequestHeader("Host") String Host, @RequestHeader("Content-Length") String ContentLength) {}

@CookieValue

获取Request Header 中 Cookie 中的值。

示例：

有如下Cookie：

1

Cookie: _ga=GA1.1.54311297.1548073822; Webstorm-244b1d3=90a9034f-e9c9-4a89-86a7-aaef4addf18e; Idea-4ae3b438=0eb7fd0e-54c2-4672-960c-36b458508707; Webstorm-ead79411=ce4860a6-bbd1-487d-900b-3b8fd9825418; Hm_lvt_3a101c3aa7d1cde834d9d6b197500902=1557208148,1559381054; loginKey=cbe4e8d0-059e-4bd3-82f9-5360e570839a; 

在Controller中获取Cookie中的loginKey的值：

1
2

@RequestMapping(value = "/dwp/contract/rebuildpdf")
public void rebuildpdf(HttpServletRequest request, @CookieValue("loginKey") String cookieLoginKey){}

@ReuqestParam

requestParam有两种情况：

1、处理简单类型绑定

可以处理使用request.getParameter()获取的String，或Get方式中的queryParams ，和POST 方式中 form data的值

示例：

Ajax：

1
2
3
4
5
6

$.ajax({
    url:_basePath + '/dwp/contract/rebuildpdf?contractTempNumber=' + $('#contractTempNumber').val(),
    type: "GET",
    dataType: "json",
    contentType: "application/json",
});

Controller:

1
2
3

@RequestMapping(value = "/dwp/contract/rebuildpdf")
@ResponseBody
public ResponseData rebuildpdf(HttpServletRequest request,  @RequestParam String contractTempNumber){}

2、处理表单数据

获取Request中的formData参数。因此Ajax请求时Content-Type 必须是 application/x-www-form-urlencoded ,data中传的是对象。

示例：

Ajax：

1
2
3
4
5
6
7
8

$.ajax({
    url:_basePath + '/dwp/contract/rebuildpdf',
    type: "POST",
    dataType: "json",
    data: {
        contractTempNumber: $('#contractTempNumber').val()
    }
});

Controller:

1
2

@RequestMapping(value = "/dwp/contract/rebuildpdf")
public void rebuildpdf(HttpServletRequest request, @RequestParam String contractTempNumber){}

@RequestBody

获取Request 的Body

示例：

Ajax：

使用JSON.stringify 把对象转化成JSON字符串

1
2
3
4
5
6
7

$.ajax({
    url:_basePath + '/dwp/contract/rebuildpdf',
    type: "POST",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify({contractTempNumber:  $('#contractTempNumber').val()})
});

Controller:

对象DwpContracts中有contractTempNumber 这个属性字段。

1
2

@RequestMapping(value = "/dwp/contract/rebuildpdf")
public void rebuildpdf(HttpServletRequest request,  @RequestBody DwpContracts contract){}

@SessionAttributes

该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；

示例：

1
2
3
4
5
6

@Controller
@RequestMapping("/editPet.do")
@SessionAttributes("pet")
public class EditPetForm {
    // ...
}

@ModelAttribute

该注解有两个用法，一个是用于方法上，一个是用于参数上；

用于方法上时： 通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；

用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：

A） @SessionAttributes 启用的attribute 对象上；

B） @ModelAttribute 用于方法上时指定的model对象；

C） 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

用到方法上@ModelAttribute的示例代码：

1
2
3
4
5
6
7
8
9

// Add one attribute
// The return value of the method is added to the model under the name "account"
// You can customize the name via @ModelAttribute("myAccount")
 
@ModelAttribute
public Account addAccount(@RequestParam String number) {
    return accountManager.findAccount(number);
}

用在参数上的@ModelAttribute示例代码：

1
2
3
4

@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet) {
}

首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。

参考：https://blog.csdn.net/walkerjong/article/details/7946109