JSON排除指定字段的4种方法

已于 2022-06-03 19:46:39 修改
阅读量1.8w 收藏 21
点赞数 5
分类专栏： Java 文章标签： java 序列化 排除指定字段 忽略指定字段 排除指定
于 2022-01-12 06:30:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Sn_Keys/article/details/122443407
版权

通常在 本地存储 / 微服务 / 分布式 通讯场景下，会用到对象序列化，Serializable只是一个接口类，需要具体的对象实现它。本文主要介绍序列化时(如Fastjson、Gson、Jackson)如何实现排除指定的字段。

准备工作

当使用Fastjson添加依赖

<!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.79</version>
</dependency>

当使用Gson添加依赖

<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.9</version>
</dependency>

当使用jackson添加依赖（注：Spring自带，可不用添加）

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.13.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.13.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.module/jackson-module-jaxb-annotations -->
<dependency>
    <groupId>com.fasterxml.jackson.module</groupId>
    <artifactId>jackson-module-jaxb-annotations</artifactId>
    <version>2.13.1</version>
</dependency>

排除指定的字段（如：name），常用方法有以下3种：

1、使用transient关键字

给需要排除的字段添加 transient 修饰符。

package com.example.demo.vo;

import java.io.Serializable;

/**
 * 用户信息VO类
 *
 * @author 狂龙骄子
 * @since 2022.01.11
 */
public class UserInfoVO implements Serializable {
    private static final long serialVersionUID = 1L;
    /** 用户ID */
    private String uid;
    /** 用户姓名 */
    private transient String name;

    public String getUid() {
        return uid;
    }

    public void setUid(String uid) {
        this.uid = uid;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

 测试脚本如下：

package com.example.demo.utils;

import com.alibaba.fastjson.JSON;
import com.google.gson.Gson;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.Test;

import com.example.demo.vo.UserInfoVO;

/**
 * 对象序列化JSON
 *
 * @author 狂龙骄子
 * @since 2022-01-11
 */
public class test {
    @Test
    public void main() {
        // Fastjson
        UserInfoVO userInfoVO1 = new UserInfoVO();
        userInfoVO1.setUid("1");
        userInfoVO1.setName("admin");
        System.out.println("Fastjson: " + JSON.toJSONString(userInfoVO1));

        // Gson
        UserInfoVO userInfoVO2 = new UserInfoVO();
        userInfoVO2.setUid("1");
        userInfoVO2.setName("admin");
        Gson gson = new Gson();
        System.out.println("Gson: " + gson.toJson(userInfoVO2));

        // Jackson
        UserInfoVO userInfoVO3 = new UserInfoVO();
        userInfoVO3.setUid("1");
        userInfoVO3.setName("admin");
        try {
            ObjectMapper objectMapper = new ObjectMapper();
            System.out.println("jackson: " + objectMapper.writeValueAsString(userInfoVO3));
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
    }
}

/**
输出结果如下：

Fastjson: {"uid":"1"}
Gson: {"uid":"1"}
jackson: {"uid":"1","name":"admin"}
*/

注意：Fastjson转换后的json串，是以字段名的首字排序。

2、使用注解

  • Fastjson：给需要排除的字段添加 @JSONField(serialize = false) 注解
package com.example.demo.vo;

import java.io.Serializable;
import com.alibaba.fastjson.annotation.JSONField;

/**
 * 用户信息VO类
 *
 * @author 狂龙骄子
 * @since 2022.01.11
 */
public class UserInfoVO implements Serializable {
    private static final long serialVersionUID = 1L;
    /** 用户ID */
    private String uid;
    /** 用户姓名 */
    @JSONField(serialize = false)
    private String name;

    public String getUid() {
        return uid;
    }

    public void setUid(String uid) {
        this.uid = uid;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}
  • Gson：给需要序列化的字段添加@Expose注解，未添加的将被排除
package com.example.demo.vo;

import java.io.Serializable;
import com.google.gson.annotations.Expose;

/**
 * 用户信息VO类
 *
 * @author 狂龙骄子
 * @since 2022.01.11
 */
public class UserInfoVO implements Serializable {
    private static final long serialVersionUID = 1L;
    /** 用户ID */
    @Expose
    private String uid;
    /** 用户姓名 */
    private String name;

    public String getUid() {
        return uid;
    }

    public void setUid(String uid) {
        this.uid = uid;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}
  • jackson：给需要排除的字段添加 @JsonIgnore 注解
package com.example.demo.vo;

import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonIgnore;

/**
 * 用户信息VO类
 *
 * @author 狂龙骄子
 * @since 2022.01.11
 */
public class UserInfoVO implements Serializable {
    private static final long serialVersionUID = 1L;
    /** 用户ID */
    private String uid;
    /** 用户姓名 */
    @JsonIgnore
    private String name;

    public String getUid() {
        return uid;
    }

    public void setUid(String uid) {
        this.uid = uid;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

3、使用Filter动态排除

package com.example.demo.utils;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SimplePropertyPreFilter;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import org.junit.jupiter.api.Test;

import com.example.demo.vo.UserInfoVO;

/**
 * 对象序列化JSON
 *
 * @author 狂龙骄子
 * @since 2022-01-11
 */
public class test {
    @Test
    public void main() {
        // Fastjson
        UserInfoVO userInfoVO1 = new UserInfoVO();
        userInfoVO1.setUid("1");
        userInfoVO1.setName("admin");
        System.out.println("Fastjson: " + JSON.toJSONString(userInfoVO1));
        // Fastjson 动态排除字段
        SimplePropertyPreFilter excludeFilter = new SimplePropertyPreFilter();
        excludeFilter.getExcludes().add("name");    // 注意：如果类包含子对象，下级同字段名的也会被排除掉
        System.out.println("Fastjson(排除name): " + JSON.toJSONString(userInfoVO1, excludeFilter));

        // Gson
        UserInfoVO userInfoVO2 = new UserInfoVO();
        userInfoVO2.setUid("1");
        userInfoVO2.setName("admin");
        Gson gson = new Gson();
        System.out.println("Gson: " + gson.toJson(userInfoVO2));
        // Gson 动态排除字段
        GsonBuilder builder = new GsonBuilder();
        builder.setExclusionStrategies(new ExclusionStrategy() {
            @Override
            public boolean shouldSkipField(FieldAttributes field) {
                return field.getName().equals("name");
            }

            @Override
            public boolean shouldSkipClass(Class<?> aClass) {
                return false;
            }
        });
        gson = builder.create();
        System.out.println("Gson(排除name): " + gson.toJson(userInfoVO2));

        // Jackson
        UserInfoVO userInfoVO3 = new UserInfoVO();
        userInfoVO3.setUid("1");
        userInfoVO3.setName("admin");
        try {
            ObjectMapper objectMapper = new ObjectMapper();
            // 使用动态排除，必须先添加 FilterProvider()，否则直接转JSON串会抛调用异常
            //System.out.println("jackson: " + objectMapper.writeValueAsString(userInfoVO3));

            // Jackson 动态排除字段
            String[] beanProperties = new String[]{"name"};
            // TODO 需要在类上，额外添加 @JsonFilter() 注解
            String nonFilterName = "non-name";
            SimpleFilterProvider simpleFilterProvider = new SimpleFilterProvider()
                    .addFilter(nonFilterName, SimpleBeanPropertyFilter.serializeAllExcept(beanProperties));
            objectMapper.setFilterProvider(simpleFilterProvider);
            System.out.println("jackson(排除name): " + objectMapper.writeValueAsString(userInfoVO3));
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
    }
}

/**
 输出结果如下：

 Fastjson: {"name":"admin","uid":"1"}
 Fastjson(排除name): {"uid":"1"}
 Gson: {"uid":"1","name":"admin"}
 Gson(排除name): {"uid":"1"}
 jackson(排除name): {"uid":"1"}
 */

通过对比发现，Fastjson 在排除指定字段时，无论是注解、调用方式，更简洁些。

如果有未提及的技巧，欢迎留言讨论，谢谢……

fastjson使用toJSONString序列化过滤属性字段详解
stay hungry,stay foolish!
03-06 1666
在Redis的使用过程中，我们经常会遇到BigKey（下文将其称为“大key”）及HotKey（下文将其称为“热key”）。大Key与热Key如果未能及时发现并进行处理，很可能会使服务性能下降、用户体验变差，甚至引发大面积故障。
Newtonsoft.Json 序列化 排除指定字段或只序列化指定字段
altzlo7909的博客
12-06 1680
using Newtonsoft.Json; using Newtonsoft.Json.Serialization; using System; using System.Collections.Generic; using System.Linq; using System.Web; /// <summary> /// Summary descrip...
spring boot 下对JSON返回值去除null和空字段
热门推荐
Gogym的博客
12-18 2万+
在开发过程中，我们需要统一返回前端json格式的数据，但有些接口的返回值存在 null或者""这种没有意义的字段。不仅影响理解，还浪费带宽，这时我们可以统一做一下处理，不返回空字段，或者把NULL转成“”，spring 内置的json处理框架是Jackson。我们可以对它配置一下达到目的直接看代码，很简单./** * 〈返回json空值去掉null和""〉 〈功能详细描述〉 * * @au...
Json字段过滤器
11-25
通过自定义注解的方式，实现对response的拦截，并过滤字段，将bean自动封装为json
fastjson序列化时过滤字段的方法
最新发布
招风的黑耳CSDN
08-27 788
fastjson提供了多种灵活的方式来过滤序列化时的字段，包括使用注解、Java的transient关键字、属性名过滤器和自定义属性过滤器。根据实际需求选择最合适的方法，可以有效地控制序列化结果，保护敏感信息，减少数据传输量。
AI生成JSON.toJSONString排除某字段
qq_41661520的博客
09-13 900
在使用 JSON.toJSONString 方法将 Java 对象转换为 JSON 字符串时，如果想要排除某个字段，可以通过自定义一个实现了 PropertyFilter 接口的过滤器来实现。/
使用json处理返回值，过滤不需要的字段
weixin_43935720的博客
01-22 1268
一、引入依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.62</version> </dependency> `` 二、方法封装 ```java /** * * @
Java 中 JSON 去除指定字段(对象中，数组中，List中)
LitongZero的博客
09-02 1万+
Java 中 JSON 去除指定字段(对象中，数组中，List中)
django自带serializers序列化返回指定字段的方法
09-18
以下将详细介绍如何在Django中使用`serializers`序列化返回指定字段： 1. **基本使用**： Django的`serializers.serialize()`函数接受四个参数： - `format`：指定序列化格式，例如'json'、'xml'等。 - `...
高效灵活的JSON字段过滤器：json-filter
gitblog_00054的博客
04-03 283
高效灵活的JSON字段过滤器：json-filter json-filter golang json字段过滤，复用struct 随意选择你想要输出为json的结构体字段。 json filter Golang's JSON filter randomly selects the structure fields you ...
Json排除指定字段小工具
纸上得来终觉浅，绝知此事要躬行
11-08 281
json 时排除指定字段小工具1.0
Json去除某个字段
DeveloperHuguang的博客
02-23 1万+
使用Gson可以去除Json的某个字段，具体如下 需求：contentBean是个pojo对象，需要去掉id字段。 操作： Gson gson = new Gson(); String contentGSON = gson.toJson(contentBean); //去除id字段 try {     JSONObject jsonObject = new JSONObject(
fastjson使用手册-排除指定字段
qq_26462567的博客
12-13 1631
fastjson说明文档，排除字段。
API接口使用Jackson序列化JSON数据动态过滤字段
飞鸿先森的博客
01-05 3367
API接口使用Jackson序列化JSON数据动态过滤字段 背景 编写API接口过程中，不可避免的会遇到一个问题，对于不同的接口，需要的字段不一样，但大多数情况下，使用的Service层方法是相同的，也就是说，获取到的数据字段是一样的，但是往往不需要返回所有的字段。 解决方案 常用的解决思路有两种，一种是针对每个接口定义VO类，在数据返回时，将Service层查到的数据复制到VO类后再返回，这样的话就可以返回需要的字段，但这样也有缺点，不同的接口，需要定义专属的VO类，这样会使类的数量增多，后期如果需要添加
Jackson使用JsonFilter注解过滤字段
二进制之路
10-06 6189
通过《Jackson忽略字段不序列化字段的3种方法》一讲我们知道，JsonIgnore和JsonIgnoreProperties都可以用来忽略掉指定的字段。 这两个注解有个共同点，就是都在添加注解后就指明了需要过滤的字段。如果想要在序列化的时候，才指定需要过滤的字段，那么可以使用JsonFilter注解来实现。 本篇内容基于Jackson 2.11.2版本，马上开始学习吧。 过滤类的字段 为需要过滤字段的类添加JsonFilter注解。 @JsonFilter("myFilter") public clas
利用JSON.stringify 删除对象中的某个节点
changq_jeff的博客
11-18 489
利用JSON.stringify 删除对象中的某个节点 // An highlighted block export const removeNode = (obj, node) => { return JSON.parse(JSON.stringify(obj, function (key, value) { if (key == node) { return undefined; } else { return value; } })) }
根据fields过滤json字段
u014267951的博客
04-11 530
根据接口传的fields过滤json字段
hutool工具类json序列化忽略字段属性
tiger_Angle
01-05 4233
是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。文档中描述是字段上加注解，默认配置是开启@Transient注解。
java接口数据json过滤字段方法整理
zone_four的博客
10-26 1万+
由于项目是RESTful风格设计，前后端采用接口访问的形式，进行数据交流。 所以会涉及到json转换的问题。转换情景有四种：1、转换前过滤即在序列化实体的时候，就已经通过注释，取消了需要过滤的字段的序列化步骤。 简单点说，就是生成实体的时候，就过滤掉需要过滤的字段。 下面两个都是Jackson的注解。@JsonIgnoreProperties注解在类上//生成json时将name和age属性
ubuntu vscode配置github
09-21
在Ubuntu上配置VSCode与GitHub的步骤如下： 1. 首先，安装和初始化Git。打开终端，并输入以下命令： ``` $ sudo apt-get update $ sudo apt-get install git $ git --version ``` 确保Git安装成功。 2. 在VSCode中初始化仓库。在你的代码目录下，VSCode会生成一个名为".vscode"的文件夹。这个文件夹对代码阅读有影响，但对编译器没有影响。由于该文件夹产生的数据很大，超出了GitHub仓库允许的容量（100M），我们希望在仓库中忽略此文件夹。 3. 在VSCode中忽略特定文件。如果你希望忽略某个文件，可以按照以下步骤操作： - 在VSCode中打开你的仓库。 - 点击菜单"..."，选择"远程"，然后选择"添加远程存储库"。 - 在弹出的对话框中，将刚复制的SSH地址粘贴到"URL"字段中。 - 点击"添加存储库"，完成远程存储库的添加。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

狂龙骄子

独码乐，不如众码乐，乐享其中

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值