springmvc-ajax传递对象至controller的方法

发表于 更新于 分类于 ， ，

前言

最近在写一个项目，基于springmvc+spring+mybatis，其中涉及用ajax向controller发送数据的功能。因为不想使用spring的form标签，所以想看看有没有方法将ajax中的json数据直接转化为controller方法中的对象接收并处理。以下将逐渐介绍各种不同情况下传递json数据并封装的方法

基础类型

如果传递的json数据为基础类型（Int，String等）的话，则只需要用@RequestParam标注方法中的参数就行了。
ajax代码

1
2
3
4
5
6
7
8
9
$.ajax({
    url : "someurl",
    type : "POST",
    dataType : "JSON",
    data : {"name":"test", "password":"testpassword"},    
    success : function (data) {
       console.log(data)
    }
})

java代码

1
2
3
4
@RequestMapping("someurl")
public @ResponseBody SomeData basicType(@RequestParam String name, @RequestParam String password){
    //具体方法
}

在这里@ResponseBody说明返回的是一个对象。@RequestParam的用法还很多，具体可以去参考springmvc的文档

简单的对象类型

简单的对象类型是指，在对象中不包含复杂的数据结构类似于list，map等。在这里可以使用标签@ModelAttribute来直接将JSON数据封装成对象。
假设我们有一个用户对象，用户的属性包括name，age

1
2
3
4
5
public class User{
    private String name;
    private int age;
    //getters and setters
}

ajax传输的数据如下

1
2
3
4
5
6
7
8
9
10
11
12
$.ajax({
    url : "someurl",
    type : "POST",
    dataType : "JSON",
    data : {
        'name : 'test',
        'age' : 10
    },
    success : function (data) {
        console.log(data)
    }
})

controller中的代码如下

1
2
3
4
@RequestMapping("someurl")
public @ResponseBody SomeData objects(@ModelAttribute User user){
//具体方法
}

springmvc 暂时不支持接收并生成多个modelAttribute

数组类型

有些情况下，可能需要传递一组相同类型的数据，比如添加一组用户的信息。这是可以通过ajax传递一个数组给controller方法。具体情况可以参考这个回答
这个回答给的非常的详细具体，需要补充的是，接收端的数据结构无论是List或是T[]都可以成功获得数组数据。

复杂的对象

但是上面的方法有一个问题，就是只能接收纯数组数据。假设一个对象，比如用户，该用户下的属性除了包含name(名称)，age（年龄）之外，还有一个联系方式属性contacts（List），如何才能将既包含基本类型又包含数组类型的JSON数据直接封装成对象呢？这里就需要标签@RequestBody
ajax代码如下，需要注意的是，这里需要用JSON.stringfy()方法将json数据转化成字符流，添加至requestbody中。且在ajax方法中必须指明contentType和dataType属性。

1
2
3
4
5
6
7
  public class User{
    private String name;
    private int age;
    private List<String> contacts;
    //或是 private String[] contacts;
    //getters and setters
}  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
$.ajax({
    var user = {
        'name' : 'test',
        'age ' : 10,
        'contacts' : ['12313','123213123']
    }
    url : "someurl",
    type : "POST",
    dataType : "JSON",
    contentType:"application/json",
    data : JSON.stringify(user),
    success : function (data) {
        console.log(data)
    }
})

java代码如下 

1
2
3
4
@RequestMapping("someurl")
public @ResponseBody SomeData complicateObject(@RequestBody User user){
    //方法详情
}