Spring MVC数据绑定方式

目录

• 基本类型、包装类型、数组（以参数age为例）
• 一、基本类型
• 二、包装类型
• 三、数组
• 简单对象、多层级对象、同属性对象
• 一、简单对象（User类：name, age）
• 二、多层级对象（User类：name, age, contactInfo、ContactInfo类：phone, adress）
• 三、同属性对象（User类：name, age、Admin类：name, age）
• List、Set、Map
• 一、List
• 二、Set
• 三、Map
• JSON、XML
• 一、JSON
• 二、XML

 定义：简单绑定是将一个用户界面元素（控件）的属性绑定到一个类型（对象）实例上的某个属性的方法。

基本类型、包装类型、数组（以参数age为例）

一、基本类型

1、key是必须的，即age是必须传值的

2、只能是int类型，即传给age的值必须为int类型且范围也只能是int类型

如果没有传age，后台会报500错误，会提示当前的age是不可以为空的

如果age传一个字符串abc，Spring MVC会进行拦截，报400参数错误异常

@Controller
public class TestController{
    /*
        RequestMapping注解
        value：RequestMapping的属性，指定请求的实际地址
        method：RequestMapping的属性，指定请求的method类型，分为GET、POST、PUT、DELETE等
        headers：RequestMapping的属性
                 指定request中必须包含指定的header值，才能处理该请求
    */
    @RequestMapping(value = "baseType.do", method = RequestMethod.GET)
    @ResponseBody    //方法的返回值会放到ResponseBody数据区里
    /*
        RequestParam注解
        value：RequestParam的属性，起别名
        required：RequestParam的属性，是否必传，默认值是true
    */
    public String baseType(@RequestParam(value = "xage") int age){
        return "age：" + age;
    }
}

二、包装类型

1、可以不传key，即age可以为空

@Controller
public class TestController{
    @RequestMapping(value = "baseType.do")
    @ResponseBody
    public String baseType(Integer age){
        return "age：" + age;
    }
}

此时访问localhost:8080/baseType.do，前台显示age：null

注意：在开发过程中，对可能为空的数据，最好将参数数据定义为包装类型

三、数组

一次性传多个值，例如基本类型、包装类型、String的对象类型

@Controller
public class TestController{
    @RequestMapping(value = "array.do")
    @ResponseBody
    public String array(String[] age){
        StringBuilder sdf = new StringBuilder();
        for(String item : age){
            sbf.append(item).append(" ");
        }
        return sbf.toString();
    }
}

此时访问localhost:8080/array.do?age=17&age=18，前台显示17 18

简单对象、多层级对象、同属性对象

一、简单对象（User类：name, age）

@Controller
public class TestController{
    @RequestMapping(value = "object.do")
    @ResponseBody
    public String object(User user){
        return user.toString();
    }
}

此时访问localhost:8080/object.do?name=Tom&age=18，前台显示User{name='Tom'，age=18}

二、多层级对象（User类：name, age, contactInfo、ContactInfo类：phone, adress）

@Controller
public class TestController{
    @RequestMapping(value = "object.do")
    @ResponseBody
    public String object(User user){
        return user.toString();
    }
}

此时访问localhost:8080/object.do?name=Tom&age=18&contactInfo.phone=10000

前台显示User{name='Tom'，age=18，contactInfo={phone='10000'，address='null'}}

三、同属性对象（User类：name, age、Admin类：name, age）

@Controller
public class TestController{
    @RequestMapping(value = "object.do")
    @ResponseBody
    public String object(User user, Admin admin){
        return user.toString() + " " + admin.toString();
    }
}

此时访问localhost:8080/object.do?name=Tom&age=18，前台显示User{name='Tom'，age=18} Admin{name='Tom'，age=18}

@Controller
public class TestController{
    @RequestMapping(value = "object.do")
    @ResponseBody
    public String object(User user, Admin admin){
        return user.toString() + " " + admin.toString();
    }
}
 
@InitBinder("user")    //绑定前缀
public void initUser(WebDataBinder binder){
    binder.setFieldDefaultPrefix("user.");
}
 
@InitBinder("admin")    //绑定前缀
public void initUser(WebDataBinder binder){
    binder.setFieldDefaultPrefix("admin.");
}

此时访问localhost:8080/object.do?user.name=Tom&admin.name=Lucy&age=18

前台显示User{name='Tom'，age=18} Admin{name='Lucy'，age=18}

如果没有@InitBinder注解的辅助方法，这个方法如果传递user.name，admin.name结果会怎么样呢？

如果没有@InitBinder注解的辅助方法，Spring MVC会认为是User类和Admin类里面的user字段的name，所以前台显示null

List、Set、Map

一、List

@Controller
public class TestController{
    @RequestMapping(value = "list.do")
    @ResponseBody
    public String list(UserList userList){
        return userList.toString();
    }
}

Spring MVC关于集合绑定需要一个data收集的对象，单纯的绑定是无效的。 

建一个UserList类：

public class UserList{
    private List<User> users;
    
    public List<User> getUsers(){
        return users;
    }
 
    public void setUsers(List<User> users){
        this.users = users;
    }
 
    @Override
    public String toString(){
        return "UserList{" +
                "users=" + users +
                '}';
    }
}

此时访问localhost:8080/list.do?users[0].name=Tom&users[1].name=Lucy

前台显示UserList{users=[User{name='Tom', age=null, contactInfo=null}, User{name='Lucy', age=null, contactInfo=null}]}

注意：如果访问传值的时候，users[0]直接跨到users[10]，即访问

localhost:8080/list.do?users[0].name=Tom&users[10].name=Lucy

则前台显示users[1]到users[9]以及users[11]为空对象，所以请求索引的时候一定要是连续的，否则会浪费资源

二、Set

Set相对List来说有一定的局限性，它需要先初始化Set，而List是不需要的

Set在实际应用场景当中，大部分是做对象的重复判断或排除重复

例如一个Student对象（姓名和Email），如果姓名和Email相同，则认为这个对象是重复的，此时需要重写hashcode方法和equals方法，然后在方法里写重复判断的逻辑（绑定到一个对象上）

@Controller
public class TestController{
    @RequestMapping(value = "set.do")
    @ResponseBody
    public String set(UserSet userSet){
        return userSet.toString();
    }
}

Set和List一样，也需要一个data收集的对象

public class UserSet{
    private Set<User> users;
    
    //Set和List有一些区别，就是对它本身的初始化有一些要求
    private UserSet(){
        users = new LinkedHashSet<User>();
        users.add(new User());
        users.add(new User());
    }
 
    public Set<User> getUsers(){
        return users;
    }
 
    public void setUsers(Set<User> users){
        this.users = users;
    }
 
    @Override
    public String toString(){
        return "UserSet{" +
                "users=" + users +
                '}';
    }
}

此时访问localhost:8080/set.do?users[0].name=Tom&users[1].name=Lucy

前台显示UserSet{users=[User{name='Tom', age=null, contactInfo=null}, User{name='Lucy', age=null, contactInfo=null}]}

如果跨界访问，即访问localhost:8080/set.do?users[0].name=Tom&users[10].name=Lucy

则会报错，因为已经定义了Set的size为2

注意：如果没有重写hashcode方法和equals方法进行排重，则传两个相同对象的时候前台还会显示两个对象

可是如果定义了Set的size为2，而又重写了hashcode方法和equals方法进行排重，那么当我们传两个相同对象的时候则会抛异常，因为初始化Set的时候定义的是两个空对象，可是经过hashcode方法和equals方法判

断完之后会认为是重复的对象，所以初始化的Set的size则为1，此时传两个对象就会报错，所以Spring MVC对Set的支持并不友好

三、Map

@Controller
public class TestController{
    @RequestMapping(value = "map.do")
    @ResponseBody
    public String map(UserMap userMap){
        return userMap.toString();
    }
}

Map和List一样，也需要一个data收集的对象

public class UserMap{
    private Map<String,User> users;
    
    public Map<User> getUsers(){
        return users;
    }
 
    public void setUsers(Map<String,User> users){
        this.users = users;
    }
 
    @Override
    public String toString(){
        return "UserMap{" +
                "users=" + users +
                '}';
    }
}

此时访问localhost:8080/map.do?users["X"].name=Tom&users["X"].age=10&users["Y"].name=Lucy

前台显示UserMap{users={X=User[name='Tom', age=10, contactInfo=null}, Y=User{name='Lucy', age=null, contactInfo=null}}}

JSON、XML

RequestBody注解用于读取Request请求的Body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上；再把HttpMessageConverter返回的对象数据绑定到Controller中方法的参数上。

RequestBody注解常用来处理Content-Type不是默认的application/x-www-form-urlcoded编码的内容，比如说：application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。

一、JSON

@Controller
public class TestController{
    @RequestMapping(value = "json.do")
    @ResponseBody
    public String json(@RequestBody User user){
        return user.toString();
    }
}

利用PostMan等工具传值：

{
    "name":"Jim",
    "age":16,
    "contactInfo":{
    "address":"beijing",
    "phone":"10010"
    }
}

返回值：

User{name='Jim', age=16,
contactInfo=ContactInfo{phone='10010',
address='beijing'}}

二、XML

这个功能需要spring-oxm依赖包提供支持以及在实体类中添加一些注解

@XmlRootElement(name="admin")
public class Admin{
    private String name;
    
    private String age;
    
    @XmlElement(name="name")
    public String getName() { return name; }
    
    public void setName(String name) { this.name = name; }
 
    @XmlElement(name="age")
    public Integer getAge() { return age; }
    
    public void setAge(String age) { this.age = age; }
 
    @Override
    public String toString(){
        return "Admin{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

@Controller
public class TestController{
    @RequestMapping(value = "xml.do")
    @ResponseBody
    public String xml(@RequestBody User user){
        return user.toString();
    }
}

利用PostMan等工具传值：

<?xml version="1.0" encoding="UTF-8" ?>
<admin>
    <name>Jim</name>
    <age>16</age>
</admin>

返回值：

Admin{name='Jim', age=16}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持自由互联。