SpringBoot定制JSON响应数据的实现

更新时间：2025年02月10日 10:14:43 作者：小杰不秃头

本文主要介绍了SpringBoot定制JSON响应数据的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

前言

最近在学习过程中发现了Jackson库的@JsonView也可以改变JSON的输出结构，并且可以更加精细的控制，我平时一般都会定义一些DTO去封装响应数据，使用这种方法可以不用创建DTO，更加优雅且高效的方式来实现。🌈

一、如何使用@JsonView这个注解？

我们可以创建多个视图，每个视图代表了一组特定的字段。然后，在控制器的方法上，我们可以通过应用这些视图来指定应该使用哪些字段来序列化返回的实体对象。这种灵活性使得我们能够轻松应对各种复杂的业务需求。

二、应用场景

数据暴露级别的控制：

假设你有一个用户实体（User），包含了一些基本信息（如姓名、年龄）和一些敏感信息（如密码、邮箱、身份证）。当你需要提供一个 API 来获取用户的基本信息时，你可能不希望暴露敏感信息。通过使用 @JsonView，你可以定义两个视图：一个包含基本信息，另一个包含所有信息。然后，在对应的 API 方法上，你可以使用相应的视图来控制输出的数据。

根据用户角色定制数据：

在某些情况下，不同的用户角色可能需要看到不同级别的数据。例如，管理员可能需要看到用户的所有信息，而普通用户只能看到基本信息。通过使用 @JsonView 和 Spring Security，你可以根据用户的角色来动态地决定应该暴露哪些数据。

API 版本控制：

当你的 API 随时间发展并引入新功能时，可能会有多个版本的 API。在某些情况下，旧版本的 API 可能不需要包含新引入的字段。通过 @JsonView，你可以为每个 API 版本定义一个视图，并在需要时切换到相应的视图。

数据聚合和拆分：

在某些情况下，你可能需要将多个实体的数据聚合到一个 JSON 响应中，或者将一个大实体的数据拆分成多个小实体。通过使用 @JsonView，你可以更轻松地实现这种数据的聚合和拆分。

三、实战案例

定义视图规则：

public interface UserView {
    // 展示基本信息
     interface Basic {}
    // 没有密码
     interface WithoutPassword extends Basic {}
    // 展示所有的信息
     interface Full extends Basic {}
}

定义一个User，在属性上面添加@JSsonView注解，并指定视图

@Data
@AllArgsConstructor
public class User {
    @JsonView(UserView.Basic.class)
    private Long id;
    @JsonView(UserView.Basic.class)
    private String username;
    @JsonView(UserView.Full.class)
    private String password;
    @JsonView(UserView.Basic.class)
    private String nickName;
    @JsonView(UserView.Basic.class)
    private String email;
    @JsonView({UserView.Basic.class,UserView.WithoutPassword.class})
    private String phone;
}

在控制器方法上指定视图，一共有两种方式：注解方式和编程方式。

注解方式

@RestController
public class testController {
    @GetMapping("/user/basic")
    @JsonView(UserView.Basic.class)
    public User userBasic(){
        User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");
        return user;
    }
    @GetMapping("/user/noPassword")
    @JsonView(UserView.WithoutPassword.class)
    public User userNoPassword(){
        User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");
        return user;
    }
    @GetMapping("/user/full")
    @JsonView(UserView.Full.class)
    public User userFull(){
        User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");
        return user;
    }
}

注意：@JsonView允许一个视图类的数组，但你只能为每个控制器方法指定一个。如果需要激活多个视图，可以使用复合接口。

对上面三个接口测试：

//   user/basic
{
  "id": 1,
  "username": "admin",
  "nickName": "小杰不秃头",
  "email": "123456@xx.com",
  "phone": "188xxxxxxxx"
}

//   user/noPassword
{
  "id": 1,
  "username": "admin",
  "nickName": "小杰不秃头",
  "email": "123456@xx.com",
  "phone": "188xxxxxxxx"
}

//   user/full
{
  "id": 1,
  "username": "admin",
  "password": "123456",
  "nickName": "小杰不秃头",
  "email": "123456@xx.com",
  "phone": "188xxxxxxxx"
}

编程方式

@RestController
public class testController {
    @GetMapping("/user/basic")
    //@JsonView(UserView.Basic.class)
    public MappingJacksonValue userBasic(){
        User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");
        MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(user);
        mappingJacksonValue.setSerializationView(UserView.Basic.class);
        return mappingJacksonValue;
    }
    @GetMapping("/user/noPassword")
    //@JsonView(UserView.WithoutPassword.class)
    public MappingJacksonValue userNoPassword(){
        User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");
        MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(user);
        mappingJacksonValue.setSerializationView(UserView.WithoutPassword.class);
        return mappingJacksonValue;
    }
    @GetMapping("/user/full")
    //@JsonView(UserView.Full.class)
    public MappingJacksonValue userFull(){
        User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");
        MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(user);
        mappingJacksonValue.setSerializationView(UserView.Full.class);
        return mappingJacksonValue;
    }
}

//测试结果跟上面一致

注意：接口返回值必须为MappingJacksonValue。

总结

@JsonView提供了一种灵活且强大的方式来控制序列化的 JSON 数据。通过定义视图和将它们应用到属性和控制器方法上，你可以根据需要暴露不同级别的数据，实现 API 的数据定制化。

@JsonView也可以结合其他的注解一起使用，可以更精细的控制，比如：@JsonInclude、@JsonIgnore等等。

到此这篇关于SpringBoot定制JSON响应数据的实现的文章就介绍到这了,更多相关SpringBoot定制响应JSON内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

浅谈Java序列化和反序列化为何要实现Serializable接口
这篇文章主要介绍了浅谈Java序列化和反序列化为何要实现Serializable接口,序列化最重要的作用是在传递和保存对象时.保证对象的完整性和可传递性,对象转换为有序字节流,以便在网络上传输或者保存在本地文件中,需要的朋友可以参考下
2023-12-12
Java自带注解、元注解、自定义注解的区别
本文主要介绍了Java自带注解、元注解、自定义注解的区别，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
SpringBoot超详细讲解@Enable*注解和@Import
这篇文章主要介绍了SpringBoot @Enable*注解和@Import，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-07-07
Mybatis中Mapper标签总结大全
这篇文章主要介绍了Mybatis中Mapper标签总结大全,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-06-06
Java对数组实现选择排序算法的实例详解
这篇文章主要介绍了Java对数组实现选择排序算法的实例,选择排序的比较次数为 O(N^2)而交换数为O(N),需要的朋友可以参考下
2016-04-04
Java 3种方法实现进制转换
这篇文章主要介绍了Java 3种方法实现进制转换，帮助大家利用Java处理数据，感兴趣的朋友可以了解下
2020-09-09
在SpringBoot中整合使用Netty框架的详细教程
这篇文章主要介绍了在SpringBoot中整合使用Netty框架的教程，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2020-06-06
Spring注解之@Value详解
这篇文章主要介绍了Spring注解之@Value详解,@Value可以修饰属性、方法、参数、注释类型,编译器会将 @Value注解的信息保留在 .class 文件中,并且能被虚拟机读取,需要的朋友可以参考下
2024-01-01
图解Java中归并排序算法的原理与实现
归并排序是建立在归并操作上的一种有效的排序算法。该算法是采用分治法（Divide and Conquer）的一个非常典型的应用。本文将通过图片详解插入排序的原理及实现，需要的可以参考一下
2022-08-08
浅析NIO系列之TCP
NIO即同步非阻塞式IO，它和传统的BIO比较最大的区别在于在执行accept、connect、read、write操作时是非阻塞的。很有利于实现用少量线程来处理多个客户端请求，可以随时让线程切换所处理的客户端，从而可以实现高并发服务器的开发
2021-06-06