基于@JsonProperty的使用说明
作者:不坠青云之志
这篇文章主要介绍了基于@JsonProperty的使用说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
一、背景
在熟悉代码的过程中,看到了@JsonProperty注解的使用,查了下使用的方法,但是总觉得欠缺了点什么东西,所以自己实践了下这个注解的作用,由于时间原因没有熟悉究竟底层是怎么实现的.
所以这里只是对使用和注意事项做下分析,底层实现的话这里先mark下.
二、使用方式
@JsonProperty注解主要用于实体类的属性上,作用可以简单的理解为在反序列化的时候给属性重命名(多一个名字来识别)
这里以springboot的小demo来验证下这个注解的作用
Test.java实体类:
import com.fasterxml.jackson.annotation.JsonProperty; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; /** * @date: 2020/8/17 */ @Data @NoArgsConstructor @AllArgsConstructor public class Test { @JsonProperty(value = "fake_name", required = true) private String fakeName; @JsonProperty(value = "fake_old", required = true) private Integer fakeOld; @Override public String toString() { return "Test{" + "fakeName='" + fakeName + '\'' + ", fakeOld=" + fakeOld + '}'; } }
Test.controller类:
import com.alibaba.fastjson.JSON; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import java.util.List; import javax.annotation.Resource; /** * @date: 2020/7/30 */ @Api(tags = "测试接口") @RestController public class TestController { @ApiOperation(value="测试") @PostMapping("/test") public SingleResponse<String> getCodesByMenuCode(@RequestBody Test test) { Test param = test; System.err.println(JSON.toJSONString(param)); System.err.println(param.toString()); Test o1 = JSON.parseObject("{\"fakeName\":\"test\",\"fakeOld\":1}", Test.class); Test o2 = JSON.parseObject("{\"fake_name\":\"test\",\"fake_old\":1}", Test.class); return SingleResponse.buildSuccessRes("success"); } }
swagger测试:
可以看到接到了swagger下划线命名的变量
在Json.toJsonString时候打印的是原本属性的名称
两种方式都可以反序列化成Test对象.
交换使用也是可以反序列化成Test对象.
三、注意事项
1 使用JSON.toJsonString的时候实体类需要有getter方法,否则会输出{}
2 @requestBody注解需要在post请求下才能正常使用.
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。