Json常用注解_jsonignore注解-程序员宅基地

技术标签: java  json  数据库  

1、@JsonIgnoreProperties
类别:类注解
作用:json序列化时将bean中的一些属性忽略掉,序列化和反序列化都受影响
内部可以写多个属性

@JsonIgnoreProperties({
    "name"},{
    "age"})

allowGetters,allowSetters一起用用来控制字段忽视是在序列化还是反序列化
allowGetters=true:字段允许序列化,反序列的时候忽略该字段
allowSetters=true:字段允许反序列化,序列化的时候忽略该字段
ignoreUnknown=true:反序列化的时候忽视未知的字段,解决字段无法对应实体类会报错json解析异常

2、@JsonIgnore
类别:属性或方法上的注解(最好是属性上)
作用:用来完全忽略被注解的字段和方法对应的属性,序列化和反序列化都受影响

@JsonIgnore
private int age;
标记注释,指示基于内省的序列化和反序列化功能将忽略带注解的方法或字段。也就是说,它不应该被认为是“getter”、“setter”或“creator”(it should not be consider a "getter", "setter" or "creator".)

如果一个“getter”方法表示要序列化的属性(比如说,“getValue”表示要序列化的属性“value”),则该方法将被忽略,除非另一个注释定义了要使用的替代方法,否则不会输出此类属性。

此注释仅在方法对方法(或字段对字段)的基础上工作;一个方法或字段上的注释并不意味着忽略其他方法或字段。具体地说,标记“setter”候选者不会改变匹配“getter”方法的处理(反之亦然)。

没有显式定义“value”参数(默认为true):但参数可以显式定义。可以通过使用“false”参数明确定义一个JsonIgnore来覆盖现有JsonIgnore。
注释类似于javax.xml.bind.Annotation.XmlTransient

3、@JsonFormat
类别:用于属性或方法上(最好是属性上)
在需要查询出来的时间的数据库字段对应的实体类的属性上添加

@JsonFormat(pattern="yyyy-MM-dd",timezone = "GMT+8")

pattern: 需要转换的时间日期的格式
timezone:将时间设置为东八区,避免时间在转换中有误差

可以在属性对应的get方法上,两种方式没有区别

4、@JsonSerialize
用于属性或getter方法,在序列化时嵌入自定义代码

需要使用 using 属性指定处理参数的类,该类需要继承 JsonSerializer 类,并重写 serialize()。
若使用了 Lombok 需要自己定义相应的 get 方法。

以将日期格式化为yy-mm-dd为例。

@JsonSerialize(using = CustomDateSerialize.class)
public Date getDate() {
    return date;
}
/**
 * @author orchid
 * @date 2021-08-03 14:14
 * @description 日期序列化工具, 直接将时间类型的转为yyyy-MM-dd类型的数据
 */
public class CustomDateSerialize extends JsonSerializer<Date> {
    

    // 定义日期格式
    private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");

    @Override
    public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
    
        jsonGenerator.writeString(simpleDateFormat.format(date));
    }
}

5、@JsonDeserialize

用于属性或者setter方法上,用于在反序列化时可以嵌入我们自定义的代码,类似于上面的@JsonSerialize

需要使用 using 属性指定处理参数的类,该类需要继承 JsonSerializer 类,并重写 serialize()。
若使用了 Lombok 需要自己定义相应的 get 方法。

在前端性别显示“男 / 女”;数据库中存储的是“1 / 0”,对应的 Pojo 也是使用的 Integer 类型

@Data
public class Person implements Serializable {
    
    private static final long serialVersionUID = 4346092911489022673L;
    
    /**
     * 1 男,0 女
     */
    private Integer gender;

    @JsonDeserialize(using = GenderJsonDeserializer.class)
    public void setGender(Integer gender) {
    
        this.gender = gender;
    }

    @JsonSerialize(using = GenderJsonSerializer.class)
    public Integer getGender() {
    
        return gender;
    }
}

JsonDeserializer 作用是:处理参数,按照规则封装到指定的属性中
通过 jsonParser.getText() 获取参数

/**
 * @author orchid
 * @date 2021-08-03 14:43
 * @description
 */
public class GenderJsonDeserializer extends JsonDeserializer {
    
    @Override
    public Object deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
    
        if (ObjectUtils.isEmpty(jsonParser)) {
    
            return null;
        }
        int gender = 0;
        switch (jsonParser.getText()) {
     // 通过getText获取参数
            case "男":
                gender = 1;
                break;
            case "女":
                break;
            default:
                throw new RuntimeException("传入的性别为非法字符");
        }

        return gender;
    }
}

JsonSerializer 作用是:处理属性,按照规则封装到指定的参数中,通过value获取属性
通过 jsonGenerator.writeXxx() 写出参数

/**
 * @author orchid
 * @date 2021-08-03 14:43
 * @description
 */
public class GenderJsonSerializer extends JsonSerializer {
    
    @Override
    public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
    
        if (o.equals(1)) {
    
            jsonGenerator.writeString("男"); // 写出参数
        } else if (o.equals(0)) {
    
            jsonGenerator.writeString("女"); // 写出参数
        }
    }
}

6、@Transient
属性不与数据库表的字段映射——该字段在数据库中不存在,而需要使用。标示为@Transient
该属性不存储到数据库,不修改已存在数据库中数据的数据结构

//表示该字段在数据库表中不存在
@Transient
public int getAge() {
 return 1+1;
}

7、@JsonIgnoreType
类别:类注解
作用:类在序列化和反序列化的时候被忽略

8、@JsonProperty
作用:指定某个属性和json映射的名称

1.前端传过来的参数,想用其他属性名接收,可以在属性上加此注解
2.后端返回给前端数据时,前端要求指定key,可在属性上加此注解,就会以注解中的value返回
@JsonProperty是@JsonGetter与@JsonSetter的合体版

public class User {
    
    @JsonProperty("user_name")
    private String userName;
}

返回的json

{
    “user_name”:”xxx”}

只在序列化情况下生效的注解

1、@JsonPropertyOrder

在将 java pojo 对象序列化成为 json 字符串时,使用 @JsonPropertyOrder 可以指定属性在 json 字符串中的顺序。

2、@JsonInclude

在将 java pojo 对象序列化成为 json 字符串时,使用 @JsonInclude 注解可以控制在哪些情况下才将被注解的属性转换成 json

ALWAYS :默认策略,任何情况下都序列化该字段
NON_NULL:注解的字段为null不序列化
NON_ABSENT:注解的字段为null的时候不序列化

This option is mostly used to work with "Optional"s (Java 8, Guava)

NON_EMPTY :注解的字段为null或为空不序列化
NON_DEFAULT:字段是默认值的话就不序列化
CUSTOM:自定义排除序列化规则

过滤器对象的 equals() 方法被调用并带有要序列化的值;  如果返回真值则排除(即过滤掉);

USE_DEFAULTS:

伪值用于指示更高级别的默认值是有意义的,以避免覆盖包含值。  例如,如果返回一个属性,这将使用包含属性的类的默认值,如果有的话;  如果没有为此定义,则全局序列化包含详细信息。

4、@JsonGetter

反序列化时指定字段名

@JsonGetter("username")
public String getName() {
    
	return name;
}

@JsonAnySetter

反序列化时实体对象不存在对应的属性时加上该 注解,不存在的属性都会放到Map中去

@Data
public class People {
    

    private String username;
    private Map<String, String> properties;

    @JsonAnyGetter
    public Map<String, String> getProperties() {
    
        return properties;
    }
}


在反序列化情况下生效的注解

1、@JsonSetter

@JsonSetter 标注于 setter 方法上,类似 @JsonProperty ,也可以解决 json 键名称和 java pojo 字段名称不匹配的问题。

前端传过来json转换为java对象时,json的key与实体类的属性不一致 ,用@JsonSetter注解做转换

@JsonSetter("userId")
public void settId(String id) {
    
	this.id = id;
}

2、@JsonAnyGetter

序列化时Map加上该属性可以将map中的属性序列化为指定字符串

@Data
public class People {
    

    private String username;
    private Map<String, String> properties;
    
    @JsonAnySetter
    public void setProperties(Map<String, String> properties) {
    
        this.properties = properties;
    }
}

参考:
https://www.cnblogs.com/wdss/p/11832315.html
https://blog.csdn.net/weixin_44130081/article/details/89671016
https://blog.csdn.net/yage124/article/details/107321339/
https://www.cnblogs.com/mracale/p/9828346.html
https://blog.csdn.net/qq_29645505/article/details/89007323
https://blog.csdn.net/weixin_44130081/article/details/89678450
https://blog.csdn.net/reee112/article/details/83345629
https://blog.csdn.net/yaomingyang/article/details/106069715

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/m0_58803607/article/details/119343120

智能推荐

稀疏编码的数学基础与理论分析-程序员宅基地

文章浏览阅读290次,点赞8次,收藏10次。1.背景介绍稀疏编码是一种用于处理稀疏数据的编码技术,其主要应用于信息传输、存储和处理等领域。稀疏数据是指数据中大部分元素为零或近似于零的数据,例如文本、图像、音频、视频等。稀疏编码的核心思想是将稀疏数据表示为非零元素和它们对应的位置信息,从而减少存储空间和计算复杂度。稀疏编码的研究起源于1990年代,随着大数据时代的到来,稀疏编码技术的应用范围和影响力不断扩大。目前,稀疏编码已经成为计算...

EasyGBS国标流媒体服务器GB28181国标方案安装使用文档-程序员宅基地

文章浏览阅读217次。EasyGBS - GB28181 国标方案安装使用文档下载安装包下载,正式使用需商业授权, 功能一致在线演示在线API架构图EasySIPCMSSIP 中心信令服务, 单节点, 自带一个 Redis Server, 随 EasySIPCMS 自启动, 不需要手动运行EasySIPSMSSIP 流媒体服务, 根..._easygbs-windows-2.6.0-23042316使用文档

【Web】记录巅峰极客2023 BabyURL题目复现——Jackson原生链_原生jackson 反序列化链子-程序员宅基地

文章浏览阅读1.2k次,点赞27次,收藏7次。2023巅峰极客 BabyURL之前AliyunCTF Bypassit I这题考查了这样一条链子:其实就是Jackson的原生反序列化利用今天复现的这题也是大同小异,一起来整一下。_原生jackson 反序列化链子

一文搞懂SpringCloud,详解干货,做好笔记_spring cloud-程序员宅基地

文章浏览阅读734次,点赞9次,收藏7次。微服务架构简单的说就是将单体应用进一步拆分,拆分成更小的服务,每个服务都是一个可以独立运行的项目。这么多小服务,如何管理他们?(服务治理 注册中心[服务注册 发现 剔除])这么多小服务,他们之间如何通讯?这么多小服务,客户端怎么访问他们?(网关)这么多小服务,一旦出现问题了,应该如何自处理?(容错)这么多小服务,一旦出现问题了,应该如何排错?(链路追踪)对于上面的问题,是任何一个微服务设计者都不能绕过去的,因此大部分的微服务产品都针对每一个问题提供了相应的组件来解决它们。_spring cloud

Js实现图片点击切换与轮播-程序员宅基地

文章浏览阅读5.9k次,点赞6次,收藏20次。Js实现图片点击切换与轮播图片点击切换<!DOCTYPE html><html> <head> <meta charset="UTF-8"> <title></title> <script type="text/ja..._点击图片进行轮播图切换

tensorflow-gpu版本安装教程(过程详细)_tensorflow gpu版本安装-程序员宅基地

文章浏览阅读10w+次,点赞245次,收藏1.5k次。在开始安装前,如果你的电脑装过tensorflow,请先把他们卸载干净,包括依赖的包(tensorflow-estimator、tensorboard、tensorflow、keras-applications、keras-preprocessing),不然后续安装了tensorflow-gpu可能会出现找不到cuda的问题。cuda、cudnn。..._tensorflow gpu版本安装

随便推点

物联网时代 权限滥用漏洞的攻击及防御-程序员宅基地

文章浏览阅读243次。0x00 简介权限滥用漏洞一般归类于逻辑问题,是指服务端功能开放过多或权限限制不严格,导致攻击者可以通过直接或间接调用的方式达到攻击效果。随着物联网时代的到来,这种漏洞已经屡见不鲜,各种漏洞组合利用也是千奇百怪、五花八门,这里总结漏洞是为了更好地应对和预防,如有不妥之处还请业内人士多多指教。0x01 背景2014年4月,在比特币飞涨的时代某网站曾经..._使用物联网漏洞的使用者

Visual Odometry and Depth Calculation--Epipolar Geometry--Direct Method--PnP_normalized plane coordinates-程序员宅基地

文章浏览阅读786次。A. Epipolar geometry and triangulationThe epipolar geometry mainly adopts the feature point method, such as SIFT, SURF and ORB, etc. to obtain the feature points corresponding to two frames of images. As shown in Figure 1, let the first image be ​ and th_normalized plane coordinates

开放信息抽取(OIE)系统(三)-- 第二代开放信息抽取系统(人工规则, rule-based, 先抽取关系)_语义角色增强的关系抽取-程序员宅基地

文章浏览阅读708次,点赞2次,收藏3次。开放信息抽取(OIE)系统(三)-- 第二代开放信息抽取系统(人工规则, rule-based, 先关系再实体)一.第二代开放信息抽取系统背景​ 第一代开放信息抽取系统(Open Information Extraction, OIE, learning-based, 自学习, 先抽取实体)通常抽取大量冗余信息,为了消除这些冗余信息,诞生了第二代开放信息抽取系统。二.第二代开放信息抽取系统历史第二代开放信息抽取系统着眼于解决第一代系统的三大问题: 大量非信息性提取(即省略关键信息的提取)、_语义角色增强的关系抽取

10个顶尖响应式HTML5网页_html欢迎页面-程序员宅基地

文章浏览阅读1.1w次,点赞6次,收藏51次。快速完成网页设计,10个顶尖响应式HTML5网页模板助你一臂之力为了寻找一个优质的网页模板,网页设计师和开发者往往可能会花上大半天的时间。不过幸运的是,现在的网页设计师和开发人员已经开始共享HTML5,Bootstrap和CSS3中的免费网页模板资源。鉴于网站模板的灵活性和强大的功能,现在广大设计师和开发者对html5网站的实际需求日益增长。为了造福大众,Mockplus的小伙伴整理了2018年最..._html欢迎页面

计算机二级 考试科目,2018全国计算机等级考试调整,一、二级都增加了考试科目...-程序员宅基地

文章浏览阅读282次。原标题:2018全国计算机等级考试调整,一、二级都增加了考试科目全国计算机等级考试将于9月15-17日举行。在备考的最后冲刺阶段,小编为大家整理了今年新公布的全国计算机等级考试调整方案,希望对备考的小伙伴有所帮助,快随小编往下看吧!从2018年3月开始,全国计算机等级考试实施2018版考试大纲,并按新体系开考各个考试级别。具体调整内容如下:一、考试级别及科目1.一级新增“网络安全素质教育”科目(代..._计算机二级增报科目什么意思

conan简单使用_apt install conan-程序员宅基地

文章浏览阅读240次。conan简单使用。_apt install conan