EchoDemo's Blogs

RequestBody注解

1、@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)。

2、GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交。

3、在后端的同一个接收方法里,@RequestBody 与@RequestParam()可以同时使用,@RequestBody最多只能有一个,而@RequestParam()可以有多个。

4、当同时使用@RequestParam()和@RequestBody时,@RequestParam()指定的参数可以是普通元素、数组、集合、对象等等(即:当@RequestBody 与@RequestParam()可以同时使用时,原SpringMVC接收参数的机制不变,只不过RequestBody 接收的是请求体里面的数据;而RequestParam接收的是key-value里面的参数,所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。

5、如果参数前写了@RequestParam(xxx),那么前端必须有对应的xxx名字才行(不管其是否有值),如果没有xxx名的话,那么请求会出错,报400。如果参数前不写@RequestParam(xxx)的话,那么前端可以有也可以没有对应的xxx名字,如果有xxx名的话,那么就会自动匹配;没有的话,请求也能正确发送。

6、如果后端参数是一个对象,且该参数前是以@RequestBody修饰的,那么前端传递json参数时,必须满足以下要求:

(1)后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即:@RequestBody后面的类)时,会根据json字符串中的key来匹配对应实体类的属性,如果匹配一致且json中的该key对应的值符合(或可转换为)实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性,这一条会在本节末尾详细分析。

(2)json字符串中,如果value为””的话,后端对应属性如果是String类型的,那么接受到的就是””,如果是后端属性的类型是Integer、Double等类型,那么接收到的就是null。json字符串中,如果value为null的话,后端对应收到的就是null。

(3)如果某个参数没有value的话,在传json字符串给后端时,要么干脆就不把该字段写到json字符串中;要么写value时,必须有值,null 或””都行。千万不能有类似”stature”:,这样的写法。

7、举例说明

(1)创建User类:

package com.aspire.entity;

/**
 * 用户实体类模型
 *
 * @author JustryDeng
 * @date 2018年7月6日 上午1:55:59
 */
@Data
public class User {

    private String name;

    private Integer age;

    private String gender;

    private String motto;

    @Override
    public String toString() {

        return age + "岁" + gender + "人[" + name + "]的座右铭居然是: " + motto + "!!!";
    }
}

注:@Data注解请见Lombok

(2)创建Team类:

package com.aspire.entity;

import java.util.List;

/**
 * 小组测试实体类模型
 *
 * @author JustryDeng
 * @date 2018年7月8日 下午11:23:51
 */
@Data
public class Team {

    private Integer id;

    private String teamName;

    private List<String> honors;

    private List<User> teamMembers;

    /**
     * 重写toString
     * 
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        // 遍历出小组所获荣耀
        StringBuffer sbHonors = new StringBuffer("荣耀start----\n");
        for (String honor : honors) {
            sbHonors.append(honor);
            sbHonors.append("\n");
        }
        sbHonors.append("荣耀end----\n");

        // 遍历出小组成员
        StringBuffer sbMembers = new StringBuffer("成员start----\n");
        for (User user : teamMembers) {
            sbMembers.append(user.toString());
            sbMembers.append("\n");
        }
        sbMembers.append("成员end----\n");

        return "小组id:" + id + "\n" + "小组名字:" + teamName + "\n" + "小组所获荣誉:" 
                   + sbHonors + "\n" + "小组成员:" + sbMembers;
    }
}

(3)@RequestBody直接以String接收前端传过来的json数据:

@RequestMapping("mytest0")
public String myTestController0(@RequestBody String jsonString) {
    System.out.println(jsonString);
    return jsonString;
}

(4)@RequestBody以简单对象接收前端传过来的json数据(SpringMVC会智能的将符合要求的数据装配进该User对象中):

@RequestMapping("mytest1")
public String myTestController1(@RequestBody User user) {
    System.out.println(user.toString());
    return user.toString();
}

(5)以较复杂的Team对象接收前端传过来的json数据 (SpringMVC会智能的将符合要求的数据装配进该Teamr对象中):

@RequestMapping("mytest2")
public String myTestController2(@RequestBody Team team) {
    System.out.println(team.toString());
    return team.toString();
}

(6)@RequestBody与简单的@RequestParam()同时使用:

@RequestMapping("mytest3")
public String myTestController3(@RequestBody User user, @RequestParam("token") String token) {
    System.out.println(user.toString());
    System.out.println(token);
    return token + ">>>" + user.toString();
}

(7)@RequestBody与复杂的@RequestParam()同时使用:

@RequestMapping("mytest5")
public String myTestController5(@RequestBody User user, @RequestParam("arrays") List<String> arrays) {
    System.out.println(user.toString());
    StringBuffer sb = new StringBuffer();
    for (String array : arrays) {
        sb.append(array);
        sb.append("  ");
        System.out.println(array);
    }
    return sb.toString() + user.toString();
}

(8)@RequestBody接收请求体中的json数据;不加注解接收URL中的数据并组装为对象:

@RequestMapping("mytest4")
public String myTestController4(@RequestBody User user1,  User user2) {
    System.out.println(user1.toString());
    System.out.println(user2.toString());
    return user2.toString() + "\n" + user1.toString();
}

注:该文章转载自@RequestBody的使用

🐶 您的支持将鼓励我继续创作 🐶
-------------本文结束感谢您的阅读-------------