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数据时,十分高效,通过合理利用这些注解,我们可以更专注于业务逻辑的实现,提升开发效率。

相关推荐
岁忧11 分钟前
(LeetCode 面试经典 150 题 ) 11. 盛最多水的容器 (贪心+双指针)
java·c++·算法·leetcode·面试·go
CJi0NG15 分钟前
【自用】JavaSE--算法、正则表达式、异常
java
Nejosi_念旧39 分钟前
解读 Go 中的 constraints包
后端·golang·go
风无雨42 分钟前
GO 启动 简单服务
开发语言·后端·golang
Hellyc42 分钟前
用户查询优惠券之缓存击穿
java·redis·缓存
小明的小名叫小明43 分钟前
Go从入门到精通(19)-协程(goroutine)与通道(channel)
后端·golang
斯普信专业组1 小时前
Go语言包管理完全指南:从基础到最佳实践
开发语言·后端·golang
今天又在摸鱼1 小时前
Maven
java·maven
老马啸西风1 小时前
maven 发布到中央仓库常用脚本-02
java·maven
代码的余温1 小时前
MyBatis集成Logback日志全攻略
java·tomcat·mybatis·logback