Spring Boot 注解探秘:JSON 处理的魔法世界

在 Spring Boot 应用开发中,高效处理 JSON 数据同样至关重要。Spring Boot 不仅在 Bean 管理方面表现出色,提供强大的注解系统以助力开发者轻松管理 Bean 的生命周期和依赖注入,在 JSON 数据处理上也毫不逊色。本文将深入探讨 Spring Boot 中与 JSON 处理相关的注解及其应用场景。

一、@RequestBody和@ResponseBody

@RequestBody和@ResponseBody用于controller的方法。
@RequestBody在请求的时候会自动将JSON字符串反序列化成指定对象 。@ResponseBody会在响应客户端请求时,自动将返回值对象序列化成JSON格式并返回

。如,

在SpringBoot项目中,@ResponseBody和@Controller一般不单独使用,而是使用@RestController,更多细节见Spring Boot 注解探秘:HTTP 请求的魅力之旅。

java 复制代码
@RestController
@RequestMapping("/employee")
public class UserController{
	@PostMapping("/page-employee")
	Response<PageResult<Employee>> pageEmployee(@RequestBody PageParam<UserReq> pageParam)
}

二、@JsonIgnore和@JsonIgnorePropeties

@JsonIgnore和@JsonIgnorePropeties都用于在序列化和反序列化时忽略指定的字段。

@JsonIgnorePropeties可以指定多个属性,作用于类或方法上,@JsonIgnore只能指定具体的单个属性,作用于方法或者字段上。如,

java 复制代码
@JsonPropeties(ignoreUnknown = true)
public class Employee{
	private String employeId;
	private String employeeName;
	private Integer employeeNo;
	private String phone;
}

该示例中,无论使用ObjectMapper.readValue(jsonStr, Employee.class)方法反序列化还是使用ObjectMapper.writeValueAsString(employee)序列化时,都会忽略未知的属性。

java 复制代码
// 方式1
@JsonPropeties({'phone'})
public class Employee{
	private String employeId;
	private String employeeName;
	private Integer employeeNo;
	// 方式2
	@JsonIgnore
	private String phone;
}

该示例中,方式1和方式2是等价的,在序列化Employee对象成JSON时,phone字段会被忽略。

三、@JsonPropeties和@JsonAlias

@JsonPropeties用于在序列化时,指定一个字段在JSON中的名称。

@JsonAlias刚好相反,用于在发序列化JSON时,指定一个对象的属性。

如,

java 复制代码
public class Employee{
	private String employeId;
	private String employeeName;
	private Integer employeeNo;
	@JsonPropeties("mobile_phone")
	private String phone;
}

该示例中,当Employee对象被序列化成JSON时,phone字段将被命名为mobile_phone。

java 复制代码
public class Employee{
	private String employeId;
	private String employeeName;
	private Integer employeeNo;
	@JsonAlias("mobile_phone", "iphone")
	private String phone;
}

该示例中,当从JSON反序列化Employee时,JSON中包含的iphone或mobile_phone字段,将被映射到为phone字段。

四、@JsonFormat

用于在 JSON 序列化和反序列化过程中,指定日期和时间字段的格式,确保日期和时间字段按照指定的格式进行转换。如,

java 复制代码
public class Employee{
	private String employeId;
	private String employeeName;
	private Integer employeeNo;
	private String phone;
	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
	private OffsetDateTime createTime;
}

该示例中,当Employee对象被序列化为JSON时,createTime字段将按照yyyy-MM-dd HH:mm:ss的格式输出。同样,在反序列化过程中,也会按照此格式将JSON中的字符串转换为OffsetDateTime对象。

五、总结

在SpringBoot项目中,上述注解在处理JSON数据时,十分高效,通过合理利用这些注解,我们可以更专注于业务逻辑的实现,提升开发效率。

相关推荐
跳跳的小古风1 分钟前
前端转全栈:一条接口从前端请求到 SQL 完整流程
java·前端
天多高_风不晓得28 分钟前
Comparable 与 Comparator
后端
程序员鱼皮32 分钟前
这 3 年 AI Agent 到底进化了啥?万字大白话,一次讲透!
前端·后端·aigc
一条Go32 分钟前
SSH 命令审核流:为什么「能执行」必须先「被批准」
后端·架构·github
__underline__42 分钟前
冷门Python知识点007篇:list[int]不是类,为什么能当基类?
后端·python
用户6152183299643 分钟前
为什么 String 是不可变的?看懂字符串常量池和底层实现
后端
brilliance1 小时前
HashMap 底层原理详解,从数组、链表到红黑树
后端
jianqiang.xue1 小时前
把Agent塞进MCU:工具次数和上下文长度怎么卡
java·前端·网络·单片机·esp32·ai编程
未秃头的程序猿1 小时前
RedisTemplate 序列化用错,线上多了 3 个 G 的隐形 key
redis·后端
掘金者阿豪1 小时前
MySQL兼容性实践:从SQL语法适配到业务系统平滑迁移
后端