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

已于 2022-06-03 19:46:39 修改
阅读量1.5w 收藏 20
点赞数 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 在排除指定字段时，无论是注解、调用方式，更简洁些。

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

狂龙骄子
关注
  • 5
    点赞
  • 踩
  • 20
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
fastjson使用toJSONString序列化过滤属性字段详解
stay hungry,stay foolish!
03-06 1033
在Redis的使用过程中，我们经常会遇到BigKey（下文将其称为“大key”）及HotKey（下文将其称为“热key”）。大Key与热Key如果未能及时发现并进行处理，很可能会使服务性能下降、用户体验变差，甚至引发大面积故障。
json忽略空字段
AnnotationZZ的博客
06-12 2786
json忽略空字段 @JsonInclude(JsonInclude.Include.NON_NULL) private String name; private String color; public String getName() { return name; } public void setName(String...
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(
根据fields过滤json字段
最新发布
u014267951的博客
04-11 462
根据接口传的fields过滤json字段
Java 中 JSON 去除指定字段(对象中，数组中，List中)
LitongZero的博客
09-02 1万+
Java 中 JSON 去除指定字段(对象中，数组中，List中)
Jackson @JsonIgnore、@JsonIgnoreProperties 和@JsonIgnoreType将对象序列化为 JSON 时忽略某些字段
allway2的博客
03-21 8516
本教程将展示如何在使用 Jackson 将对象序列化为 JSON 时忽略某些字段。 当 Jackson 的默认值不够并且我们需要准确控制序列化为 JSON 的内容时，这非常有用。有几种方法可以忽略属性。 忽略类级别的字段 忽略字段级别的字段 按类型忽略所有字段 依赖项 我们首先在 pom.xml 中添加以下依赖项： <dependency> <groupId>com.fasterxml.jackson.core</groupId> &lt
json去掉指定字段
yanhhuan的博客
05-25 4182
<dependency> <groupId>org.json</groupId> <artifactId>json</artifactId> <version>20160810</version> </dependency> 使用Gson可以去除Json的某个字段，具体如下 需求：contentBean是个pojo对象，需要去掉id字段。 操作： Gson gson=new...
对象转JSON是忽略某个字段
m0_52321099的博客
11-13 1427
实体类转换JSON时，使用@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)忽略某个字段
django自带serializers序列化返回指定字段的方法
12-31
django orm 有个defer方法，指定模型排除的字段。 如下返回的Queryset, 排除‘username’, ‘id’。 users=models.UserInfo.objects.defer('username','id') 或users=models.UserInfo.objects.filter(...).defer('...
json-unmarshaller
05-26
该库引入了一个字段注释@JsonPath，可用于在Java类中指定JsonPath解组指令。 @JsonPath批注可以单独使用，也可以与Jackson的字段匹配和@JsonProperty批注结合使用。 JsonPath批注不是强制性的，现有的Jackson批注的...
详解Struts2中json 相互引用死循环解决办法
10-20
在这个例子中，`@JSON(serialize=false)`注解告诉插件不要序列化`getUser`方法的返回值，而`@JSON(format="yyyy-MM-dd")`则用于指定日期字段`startDate`的格式。 总结来说，解决Struts2中JSON相互引用死循环的问题...
Json库的使用总结
11-26
1、 如何将List变成Json字符串 2 2、 如何将一个对象变成Json字符串 2 3、 如何将一个对象的Json字符串变成该对象实例 2 4、 如何将一个List字符...7、 排除指定的字段 3 同进提供所使用的json-lib-2.2.1-jdk15.jar
如何利用Jackson序列化忽略指定类型的属性详解
08-26
一种解决方案是使用 @JsonIgnore 注解在要忽略的字段上，但这种方法有限制，不能在要忽略的字段上添加 @JsonIgnore 注解，因为手工修改的 avsc 生成的 Java 文件随时会因为重新编译而还原。 另一种解决方案是通过...
java接口数据json过滤字段方法整理
zone_four的博客
10-26 1万+
由于项目是RESTful风格设计，前后端采用接口访问的形式，进行数据交流。 所以会涉及到json转换的问题。转换情景有四种：1、转换前过滤即在序列化实体的时候，就已经通过注释，取消了需要过滤的字段的序列化步骤。 简单点说，就是生成实体的时候，就过滤掉需要过滤的字段。 下面两个都是Jackson的注解。@JsonIgnoreProperties注解在类上//生成json时将name和age属性
json 相关
qq_40813329的博客
08-17 1342
1 在上添加2。
Jackson 解析json数据之忽略解析字段注解@JsonIgnoreProperties
热门推荐
每天进步一点就够了
04-17 7万+
以前解析json用的惯的就是Google的gson了，用惯了基本就用它了，一直也没发现什么大问题，因为都是解析简单的json数据。但是最近学习springboot，要解析一个比较复杂的json数据。就照之前的用gsonformat自动生成实体类，让gson直接解析，本想着一切ok了，可是确报错了，刚开始以为gsonformat生成的类有错误，因为毕竟json数据较为复杂，于是多生成几次，可是还是不
[全面总结Fastjson过滤字段、排除字段的5种方法（含示例）
咸鱼想睡觉
03-06 2822
[全面总结Fastjson过滤字段、排除字段的5种方法（含示例）
java jsonobject 清空,JSONObject删除某些字段并排序输出
weixin_39743824的博客
03-19 1393
import com.alibaba.fastjson.JSONObject;import java.util.Arrays;import java.util.Set;import java.util.TreeSet;/*** Created with IntelliJ IDEA.* Description:* User: zhaomingli* Date: 2017-06-21* Time: 9...
js实现删除Json中不想要的字段和值
weixin_45680024的博客
01-03 4741
问题场景：最近项目中有需要导出Excel的功能，并且需要下载页面所展示的栏位，由于API对接了三个相似的模块，所以返回的值比自己想要的多，并且API未写成Filter的格式，前端无法通过参数拼接（后端基于LoopBack），所以前端实现筛选对应栏位 解决办法：使用delete 删除不想要的字段和值 代码示例： const data=[ { name:"Steven", age:"21", address:"上海", sex:"男", }, { name:"Jack", a
JSONObject.toJSONString
08-06
JSONObject.toJSONString是一个 Java 中的方法，用于将一个 JSON 对象转换为字符串表示形式。它接受一个 JSONObject 对象作为参数，并返回该对象的字符串表示形式。 例如，假设有一个 JSON 对象如下： ``` JSONObject jsonObject = new JSONObject(); jsonObject.put("name", "John"); jsonObject.put("age", 25); ``` 可以使用JSONObject.toJSONString方法将其转换为字符串： ``` String jsonString = JSONObject.toJSONString(jsonObject); System.out.println(jsonString); ``` 输出结果将会是： ``` {"name":"John","age":25} ``` 这样就将 JSON 对象转换为了字符串表示形式。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

狂龙骄子

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

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

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

打赏作者

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

抵扣说明：

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

余额充值