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

相关推荐
PetterHillWater4 分钟前
AI编程之CodeBuddy的小试
后端·aigc
天河归来14 分钟前
springboot框架redis开启管道批量写入数据
java·spring boot·redis
合作小小程序员小小店19 分钟前
web网页,在线%食谱推荐系统%分析系统demo,基于vscode,uniapp,vue,java,jdk,springboot,mysql数据库
vue.js·spring boot·vscode·spring·uni-app
张先shen22 分钟前
Elasticsearch RESTful API入门:全文搜索实战
java·大数据·elasticsearch·搜索引擎·全文检索·restful
codervibe23 分钟前
如何用 Spring Security 构建无状态权限控制系统(含角色菜单控制)
java·后端
codervibe26 分钟前
项目中如何用策略模式实现多角色登录解耦?(附实战代码)
java·后端
TCChzp28 分钟前
synchronized全链路解析:从字节码到JVM内核的锁实现与升级策略
java·jvm
大葱白菜29 分钟前
🧩 Java 枚举详解:从基础到实战,掌握类型安全与优雅设计
java·程序员
expect7g31 分钟前
Flink-Checkpoint-2.OperatorChain
后端·flink
笑衬人心。32 分钟前
在 Mac 上安装 Java 和 IntelliJ IDEA(完整笔记)
java·macos·intellij-idea