Jackson 各种注解使用示例

参考资料

  1. Jackson使い方メモ

目录

  • 一. @JsonIgnore
  • 二. @JsonIgnoreProperties
  • 三. @JsonProperty
    • 3.1 作用于entity属性上,指定json对象属性名
    • 3.2 作用于entity方法上,指定json对象属性名
  • 四. @JsonFormat
    • 4.1 日期格式化
    • 4.2 数字格式化
    • 4.3 枚举类返回code
  • 五. @JsonCreator注解 枚举类接收前台提交数据
    • 5.1 枚举类和接收数据entity的定义
    • 5.2 后台枚举类接收前台的数据
    • 5.3 后台枚举类型的数据返回给前台
  • 六. @JsonAlias
  • 七. @JsonInclude


一. @JsonIgnore

  • 在序列化和反序列化 JSON 数据时,忽略指定的属性。
import com.fasterxml.jackson.annotation.*;
import lombok.Data;

@Data
public class Test34Entity {

    @JsonIgnore
    private String id;

    private String name;

    private String content;
}
  • 返回数据给前台
@PostMapping("/get_data")
public ResponseEntity<Test34Entity> getData(@RequestBody Test34Entity data) {

    Test34Entity entity  = new Test34Entity();
	
	// 在此处设定了id属性
    entity.setId("1355930");
    entity.setName("贾飞天");
    entity.setContent("内容");

    return ResponseEntity.ok(entity);
}

⏹由于给id属性添加了@JsonIgnore注解,所以id并没有返回给前台。

在这里插入图片描述


二. @JsonIgnoreProperties

  • 同时指定多个需要忽略的属性
import com.fasterxml.jackson.annotation.*;
import lombok.Data;

@Data
@JsonIgnoreProperties({"id", "content"})
public class Test34Entity {

    private String id;

    private String name;

    private String content;
}

⏹可以看到,因为id和content属性被忽略,所以只有name属性被返回到了前台。

在这里插入图片描述


三. @JsonProperty

3.1 作用于entity属性上,指定json对象属性名

⏹由下图可知,当前台json的属性值和后台实体类属性值不匹配时,可使用@JsonProperty指定

在这里插入图片描述

3.2 作用于entity方法上,指定json对象属性名

⏹部分属性值,后台需要根据既存的属性经过业务判断处理后返回前台,且该属性值最终只有前台需要,后台的业务逻辑中并不需要,此时可以将@JsonProperty注解作用于方法上,用来指定该属性

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;

import java.util.Optional;

@Data
public class Test34Entity {

    private String firstName;

    private String lastName;
	
	// 后台不需要该属性,只有前台才需要此属性
	// private String fullName;
	
	// 指定该方法的返回值作为json的属性,属性名为fullname
    @JsonProperty("fullName")
    private String getFullName() {
        return Optional.ofNullable(this.firstName).orElse("") + Optional.ofNullable(this.lastName).orElse("");
    }
}

⏹如下图所示,在返回给前台的时候,fullName也被返回。

在这里插入图片描述


四. @JsonFormat

4.1 日期格式化

  • 在Date和YearMonth属性上指定日期字符串的格式
import com.fasterxml.jackson.annotation.*;
import lombok.Data;

import java.time.YearMonth;
import java.util.Date;

@Data
public class Test34Entity {

    @JsonFormat(pattern = "yyyy/MM/dd")
    private Date birthday;

    @JsonFormat(pattern = "yyyy/MM")
    private YearMonth yearMonth;
}

⏹由下图可知,日期字符串转换为java实体类中的日期属性类型

在这里插入图片描述

4.2 数字格式化

  • 指定序列化时的数据类型(返回前台的数据类型)
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;

import java.math.BigDecimal;

@Data
public class Test34Entity {
    
    // 指定序列化时的数据类型是字符串
    @JsonFormat(shape = JsonFormat.Shape.STRING)
    private BigDecimal num1;

    @JsonFormat(shape = JsonFormat.Shape.STRING)
    private Integer num2;
    
    // 未指定序列化时的数据类型
    private BigDecimal num3;

    private Integer num4;
}

⏹可以看到,指定了 @JsonFormat(shape = JsonFormat.Shape.STRING)注解的属性,返回前台时的数据类型变为字符串类型。

在这里插入图片描述

4.3 枚举类返回code

详情请参考 5.3 后台枚举类型的数据返回给前台

五. @JsonCreator注解 枚举类接收前台提交数据

5.1 枚举类和接收数据entity的定义

⏹定义一个枚举类

  • Jackson根据@JsonCreator注解所作用的枚举类中的方法,将前台提交的数据转换为枚举类对象
  • fromName方法只是为了根据枚举类的name获取枚举类对象,和枚举类序列化反序列化没有关系
import com.fasterxml.jackson.annotation.JsonCreator;
import java.util.Arrays;

public enum SexTypes {
    男性("1"),
    女性("2"),
    保密("3");
    
    private String code;

    SexTypes(String code) {
        this.code = code;
    }

    public String getCode() {
        return code;
    }

    /*
    	根据code获取枚举类对象
    	SpringBoot在将前台数据封装的时候,通过@JsonCreator注解对应的方法
    	指定前台的性别code转换为对应的枚举类
	*/ 
    @JsonCreator
    public static SexTypes fromCode(String code) {
        return Arrays.stream(SexTypes.values())
                .filter(item -> item.code.equals(code)).findAny().orElse(null);

    }

    public static SexTypes fromName(String name) {
        return Arrays.stream(SexTypes.values())
                .filter(item -> item.name().equals(name)).findAny().orElse(null);
    }
}

⏹用来接收前台提交到后台数据的entity

import com.example.jmw.common.enums.SexTypes;
import lombok.Data;

@Data
public class Test34Entity {

    private String id;
	
	// 自定义的枚举类
    private SexTypes sexTypes;
}

5.2 后台枚举类接收前台的数据

在这里插入图片描述

5.3 后台枚举类型的数据返回给前台

⏹在不做任何配置的情况下,默认返回前台的数据是枚举类的名称

在这里插入图片描述
⏹在枚举类上配置@JsonFormat(shape = JsonFormat.Shape.OBJECT),返回给前台的是枚举类的code

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum SexTypes {
    男性("1"),
    女性("2"),
    保密("3");
	
	// ...以下代码省略...
	
	@JsonCreator
    public static SexTypes fromCode(String code) {
        return Arrays.stream(SexTypes.values())
                .filter(item -> item.code.equals(code)).findAny().orElse(null);
    }
}

⏹效果如下所示,返回的是枚举类的code

在这里插入图片描述


六. @JsonAlias

  • 作用于实体类的属性上
  • 被标记的属性可以同时接受多个指定的key
import com.fasterxml.jackson.annotation.JsonAlias;
import lombok.Data;

@Data
public class Test34Entity {
	
	// id 和 userId 都将被封装到此处
    @JsonAlias({"userId"})
    private String id;
    
    @JsonAlias({"userName"})
    private String name;
}

⏹效果如下所示,前台json中的key是userId,后台entity的属性值是id,但是通过@JsonAlias注解指定了别名userId,所以成功接受到数据。

在这里插入图片描述

七. @JsonInclude

  • JsonInclude.Include.NON_NULL:指定返回的数据中仅包含非null的数据
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Data;

@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Test34Entity {

    private String id;

    private String name;

    private String content;
}

⏹由下图可知,content属性为null,但是因为通过@JsonInclude(JsonInclude.Include.NON_NULL)的指定,所以值为null的属性压根就没有返回到前台。

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/525787.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

Cortex-M4架构

第一章 嵌入式系统概论 1.1 嵌入式系统概念 用于控制、监视或者辅助操作机器和设备的装置&#xff0c;是一种专用计算机系统。 更宽泛的定义&#xff1a;是在产品内部&#xff0c;具有特定功能的计算机系统。 1.2 嵌入式系统组成 硬件 ①处理器&#xff1a;CPU ②存储器…

JSBridge原理 - 前端H5与客户端Native交互

1. 概述&#xff1a; 在混合应用开发中&#xff0c;一种常见且成熟的技术方案是将原生应用与 WebView 结合&#xff0c;使得复杂的业务逻辑可以通过网页技术实现。实现这种类型的混合应用时&#xff0c;就需要解决H5与Native之间的双向通信。JSBridge 是一种在混合应用中实现 …

【r-tree算法】一篇文章讲透~

目录 一、引言 二、R-tree算法的基本原理 1 数据结构 2 插入操作 3 删除操作 4 查询操作 5 代码事例 三、R-tree算法的性能分析 1 时间复杂度 2 空间复杂度 3 影响因素 四、R-tree算法的变体和改进 1 R*-tree算法 2 X-tree算法 3 QR-tree算法 五、R-tree算法的…

前端| 富文本显示不全的解决方法

背景 前置条件&#xff1a;编辑器wangEditor vue项目 在pc端进行了富文本操作&#xff0c; 将word内容复制到编辑器中&#xff0c; 进行发布&#xff0c; pc端正常&#xff0c; 在手机端展示的时候 显示不全 分析 根据h5端编辑器内容的数据展示&#xff0c; 看到有一些样式造…

【任推邦新悟空网盘拉新】八款地推网推新项目,周期稳定,受众广!

现在地推网推新项目打得火热&#xff0c;尤其是夸克网盘&#xff0c;地推网推新流程其实很简单&#xff0c;简单来说就是就是给项目增加新用户&#xff0c;每邀请一个新用户注册&#xff0c;你就能得到收益&#xff0c;下面小推给大家整理了一份好推的项目&#xff0c;希望能够…

C++:类与对象(一)

hello&#xff0c;各位小伙伴&#xff0c;本篇文章跟大家一起学习《C&#xff1a;类与对象&#xff08;一&#xff09;》&#xff0c;感谢大家对我上一篇的支持&#xff0c;如有什么问题&#xff0c;还请多多指教 &#xff01; 文章目录 面向对象和面向过程的区别1.类的引入2.…

【java面试题-Redis篇-2024】

##java面试题大全 详细面试题-持续更新中-点击跳转 点赞、收藏、加关注 java基础面试题 ##java面试题大全1、什么是 Redis2、Redis 的数据结构类型3、Redis 为什么快4、什么是跳跃表5、什么是 I/O 多路复用6、什么是缓存击穿、缓存穿透、缓存雪崩7、什么是布隆过滤器8、热…

webpack5如何关闭全屏错误

1、找到vue.config.js 2、在上面的devServer里面添加如下&#xff1a; client: {overlay: false, // 禁用全局错误提示},

写出好代码的底层逻辑

写出好代码的底层逻辑 程序员安身立命的手艺就是写代码&#xff0c;可多少人知道如何才能写出好的代码呢&#xff1f;这几年也做过很多次的代码 CR&#xff0c;可好代码的标准在哪里呢&#xff1f;我们在做 CR 的时候&#xff0c;其实只是停留在代码的表面&#xff0c;主要是跟…

Godot插值、贝塞尔曲线和Astar寻路

一、插值 线性插值是采用一次多项式上进行的插值计算&#xff0c;任意给定两个值A和B&#xff0c;那么在A和B之间的任意值可以定义为&#xff1a;P(t) A * (1 - t) B * t&#xff0c;0 < t < 1。 数学中用于线性拟合&#xff0c;游戏应用可以做出跟随效果&#xff08;…

keycloak - 鉴权VUE

目录 一、前言 1、背景 2、实验版本 二、开始干活 1、keycloak配置 a、创建领域(realms) b、创建客户端 c、创建用户、角色 2、vue代码 a、依赖 b、main.js 三、未解决的问题 目录 一、前言 1、背景 2、实验版本 二、开始干活 1、keycloak配置 a、创建领域(r…

VMware Esxi安装群辉系统

群晖的网络存储产品具有强大的操作系统&#xff0c;提供了各种应用程序和服务&#xff0c;包括文件共享、数据备份、多媒体管理、远程访问等。用户可以通过简单直观的界面来管理他们的存储设备&#xff0c;并且可以根据自己的需求扩展设备的功能。总的来说&#xff0c;群晖的产…

概念科普|大模型它到底是什么?

一、引言 ChatGPT、Open AI、大模型、提示词工程、Token、幻觉等人工智能的黑话&#xff0c;在2023年这个普通却又神奇的年份里&#xff0c;反复的冲刷着大家的认知。让一部分人彻底躺平的同时&#xff0c;让另外一部分人开始焦虑起来&#xff0c;生怕在这个人工智能的奇迹之年…

鸡乐盒网页版

前端时间鸡乐盒比较火&#xff0c;当时跟着做了一款鸡乐盒&#xff0c;同时拥有聊天以及音乐播放器功能 链接&#xff1a; 鸡乐盒https://www.jaron.top/app/xiana/pages/musicBox/musicBox

C语言---浮点数在内存中的存储

前面跟大家介绍了整数在内存中的存储&#xff0c;这次再向大家介绍下浮点数在内存中的存储。 我们常见的浮点数有3.14&#xff0c;1E10 等等&#xff0c;浮点数家族包括float&#xff0c;double&#xff0c;long double类型。 浮点数的表示范围在头文件 float.h 定义。 1.浮…

代码随想录算法训练营第二十九天(回溯5)|491. 非递减子序列、46. 全排列、47. 全排列 II(JAVA)

文章目录 491. 非递减子序列解题思路源码 46. 全排列解题思路源码 47. 全排列 II解题思路源码 总结 491. 非递减子序列 给你一个整数数组 nums &#xff0c;找出并返回所有该数组中不同的递增子序列&#xff0c;递增子序列中 至少有两个元素 。你可以按 任意顺序 返回答案。 …

探索未来游戏:生成式人工智能AI如何重塑你的游戏世界?

生成式人工智能&#xff08;Generative AI&#xff09;正以前所未有的速度改变着各行各业的运作模式。其中&#xff0c;游戏产业作为科技应用的前沿阵地&#xff0c;正经历着前所未有的变革。本文将探讨生成式人工智能如何重塑游戏产业&#xff0c;以及这一变革背后的深远影响。…

博士推荐 | 拥有超过10年的数据解决方案经验,数据驱动的决策者

编辑 / 木子 审核 / 朝阳 伟骅英才 伟骅英才致力于以大数据、区块链、AI人工智能等前沿技术打造开放的人力资本生态&#xff0c;用科技解决职业领域问题&#xff0c;提升行业数字化服务水平&#xff0c;提供创新型的产业与人才一体化服务的人力资源解决方案和示范平台&#x…

评估精益管理培训的有效性需要收集哪些数据?

近年来&#xff0c;企业纷纷寻求通过精益管理培训来提升效率和竞争力。然而&#xff0c;精益管理培训是否真正有效&#xff0c;能否为企业带来实实在在的改变&#xff0c;这是许多管理者和决策者关心的问题。为了回答这个问题&#xff0c;我们需要收集一系列关键数据来评估精益…

基于 OpenHarmony PrecentPositionLayout 开发指南

1. PrecentPositionLayout 功能介绍 1.1. 组件介绍&#xff1a; 鸿蒙 SDK 提供了不同布局规范的组件容器&#xff0c;例如以单一方向排列的 DirectionalLayout、以相对位置排列的DependentLayout、以确切位置排列的 PositionLayout 等。 但是 PositionLayout 中组件的位置是…