文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

@RequestBody注解的原理及使用技巧分享

2022-11-13 19:06

关注

本文是基于SpringBoot,进行的演示说明。

基础知识介绍

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的);GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交。

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

如果后端参数是一个对象,且该参数前是以@RequestBody修饰的,那么前端传递json参数时

必须满足以下要求:

                                                                     

示例详细说明

先给出两个等下要用到的实体类

User实体类:

public class User{
    private String name;    //姓名
    private Integer age;    //年龄
    private String gender;  //性别
    private String motto;   //座右铭
    //geter 和  seter  方法
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getGender() {
        return gender;
    }
    public void setGender(String gender) {
        this.gender = gender;
    }
    public String getMotto() {
        return motto;
    }
    public void setMotto(String motto) {
        this.motto = motto;
    }
    //重写toString 方法
    @Override
    public String toString(){
        return age + "岁" +gender+ "人["+name+"]的座右铭是:"+motto;
    }
}

Team实体类:

class Team{
    private Integer id;//id
    private String teamName;//小组名
    private List<String> honors;//所获称号
    private List<User> teamMembers;//小组成员
    //geter 和 seter 方法
 
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getTeamName() {
        return teamName;
    }
    public void setTeamName(String teamName) {
        this.teamName = teamName;
    }
    public List<String> getHonors() {
        return honors;
    }
    public void setHonors(List<String> honors) {
        this.honors = honors;
    }
    public List<User> getTeamMembers() {
        return teamMembers;
    }
    public void setTeamMembers(List<User> teamMembers) {
        this.teamMembers = teamMembers;
    }
    //重写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 sbMenbers = new StringBuffer("成员start---\n");
        for (User user:teamMembers){
            sbMenbers.append(user.toString());
            sbMenbers.append("\n");
        }
        sbMenbers.append("成员end---\n");
        return "小组id:"+ id+"\n"+"小组名字:"+teamName+"\n"+"小组所获荣耀:"
                +sbHonors+"\n"+"小组成员:"+sbMenbers;
    }
}

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

后端对应的Controller:

使用PostMan测试:

@RequestBody以简单对象接收前端传过来的json数据:

后端对应的Controller:

使用PostMan测试:

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

后端对应的Controller:

使用PostMan测试:

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

后端对应的Controller

使用PostMan测试:

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

后端对应的Controller:

使用PostMan测试:

注:如果在后端方法参数前,指定了@RequestParam()的话,那么前端必须要有对应字段才行(当然可以通过设置该注解的required属性来调节是否必须传),否者会报错;如果参数前没有任何该注解,那么前端可以传,也可以不传,如:

上图中,如果我们传参中没有指定token,那么请求能正常进去,但是token为null;如果在String token前指定了@RequestParam(“token”),那么前端必须要有token这个键时,请求才能正常进去,否者报400错误。

@RequestBody与前端传过来的json数据的匹配规则

声明:根据不同的Content-Type等情况,Spring-MVC会采取不同的HttpMessageConverter实现来进行信息转换解析。

下面介绍的是最常用的:前端以Content-Type 为application/json,传递json字符串数据;后端以@RequestBody模型接收数据的情况。

解析json数据大体流程概述

Http传递请求体信息,最终会被封装进com.fasterxml.jackson.core.json.UTF8StreamJsonParser中(提示:Spring采用CharacterEncodingFilter设置了默认编码为UTF-8),然后在public class BeanDeserializer extends BeanDeserializerBase implements java.io.Serializable中,通过 public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws IOException方法进行解析。

核心逻辑分析示例

假设前端传的json串是这样的: {"name1":"邓沙利文","age":123,"mot":"我是一只小小小小鸟~"} 后端的模型只有name和age属性,以及对应的setter/getter方法;给出一般用到的deserializeFromObject(JsonParser p, DeserializationContext ctxt)方法的核心逻辑:

小技巧之指定模型中的属性对应什么key

这里简单介绍,更多的可参考:

public class BeanPropertyMap implements Iterable<SettableBeanProperty>,java.io.Serializable

给出Controller中的测试类:

给出模型中的属性(setter/getter方法没截出来):

使用postman测试一下,示例:

上图简单测试了一下,但是测得并不全面,这里就不带大家一起测试了,直接给出。

全面的结论

结论①

@JsonAlias注解,实现:json转模型时,使json中的特定key能转化为特定的模型属性;但是模型转json时,对应的转换后的key仍然与属性名一致,见:上图示例中的name字段的请求与响应。

以下图进一步说明:

此时,json字符串转换为模型时,json中key为Name或为name123或为name的都能识别。

结论②

@JsonProperty注解,实现:json转模型时,使json中的特定key能转化为指定的模型属性;同样的,模型转json时,对应的转换后的key为指定的key,见:示例中的motto字段的请求与响应。

以下图进一步说明:

此时,json字符串转换为模型时,key为MOTTO的能识别,但key为motto的不能识别。

结论③

@JsonAlias注解需要依赖于setter、getter,而@JsonProperty注解不需要。

结论④

在不考虑上述两个注解的一般情况下,key与属性匹配时,默认大小写敏感。

结论⑤

有多个相同的key的json字符串中,转换为模型时,会以相同的几个key中,排在最后的那个key的值给模型属性复制,因为setter会覆盖原来的值。见示例中的gender属性。

结论⑥

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     807人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     351人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     314人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     433人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     221人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯