Java开发中POJO和JSON互转时如何忽略隐藏字段
1. 前言
在Java开发中有时候某些敏感信息我们需要屏蔽掉,不能被消费这些数据的客户端知道。通常情况下我们会将其设置为null
或者空字符 ""
,其实还有其它办法,如果你使用了Jackson的话。接下来我将以一个实际场景来告诉你可以怎么做。
2. Jackson如何忽略字段
这里都以JSON序列化为例。假如我们在业务中需要返回用户信息,已有的POJO是这样的:
import lombok.Data;
/**
* @author felord.cn
*/
@Data
public class UserInfo {
/**
* userid
*/
private String userId;
/**
* 用户名
*/
private String username;
/**
* 密钥串
*/
private String secret;
/**
* 地址信息
*/
private String address;
}
业务场景:第三方通过用户的userId
来获取用户的信息,但是密钥串secret
显然不能让第三方知道,通常最容易想到的方法是将secret
字段设置为null
或者""
。如果业务需要批量提供用户信息,即List<UserInfo>
,我们总不能每次都要遍历一遍吧。Spring Boot内置的Jackson可以很方便的帮我们处理这个问题。
使用@JsonIgnore注解
Jackson提供了一个@JsonIgnore
注解,将它标记到需要被忽略的字段上或者对应的getter
方法或者setter
方法上就可以实现对该字段的屏蔽。就像下面这样标记:
@JsonIgnore
private String secret;
// 对应json 样例 {"userId":"100000","username":"felord.cn","address":"cn"}
无论是序列化(将POJO转为JSON)还是反序列化((将JSON转为POJO),secret
都会被忽略。
使用@JsonIgnoreProperties注解
这个注解比@JsonIgnore
更加强大一些,通常该注解标记到POJO之上,它有更多的能力:
- 忽略多个字段,配置
value
属性即可。 - 忽略未知的属性,配置
ignoreUnknown
为true
,默认不忽略。 - 允许忽略字段被序列化,配置
allowGetters
为true
,序列化的时候不会被忽略。 - 允许忽略字段被反序列化,配置
allowSetters
为true
,反序列化的时候不会被忽略。
例如我们要忽略UserInfo
中的secret
和address
,我们可以这样配置:
@JsonIgnoreProperties({"secret", "address"})
使用@JsonProperty注解
需要Jackson版本不低于2.6
这个注解出镜率还是非常高的,通常为了给JSON的字段起别名或者设置默认值使用。比如UserInfo
中的userId
想对应JSON中的user_id
,我们可以:
@JsonProperty(value = "user_id")
private String userId;
在2.6版本以后,这个注解也能实现忽略字段的作用。它有个access
属性,用来指定在序列化(“读取”)和反序列化(“写”)期间访问权限(这里的读写是以属性为视角)。它由枚举Access
定义:
public enum Access
{
/**
* 无论是序列化还是反序列化都会根据配置自动的处理,默认值。
*/
AUTO,
/**
* 意味着该属性只能在进行序列化时读取(通过“ getter”方法访问的值,或者从字段中读取),而在反序列化 * 期间不能写入(设置)。换句话说,这将反映“只读POJO”,其中包含的值可以读取但不能写入。
*/
READ_ONLY,
/**
* 意味着该属性只能作为反序列化的一部分写入(设置)(使用“ setter”方法,或分配给Field,或作为 * Creator参数传递),而不会被读取(获取)以进行序列化,即,该属性的值不包括在序列化中。
*/
WRITE_ONLY,
/**
* 可读可写,READ_ONLY与WRITE_ONLY的合并效果。
*/
READ_WRITE;
}
从这个注解中我们可以知道,如果你想在POJO转JSON时忽略secret
字段,就可以这么写:
@JsonProperty( access = JsonProperty.Access.WRITE_ONLY)
private String secret;
使用@JsonIgnoreType注解
这个注解是用来直接忽略类型的,如果上面的UserInfo
是另外一个POJO的属性,我们不希望它被序列化和反序列化,那么就可以:
@JsonIgnoreType
public class UserInfo {
// 省略
}
3. 总结
目前大概可知的Jackson有这么四种的忽略属性的方式,它们有各自的使用场景,你可以根据自己的情况选择使用。好了今天的分享就到这里,多多关注:码农小胖哥,获取更多的编程干货。
关注公众号:Felordcn 获取更多资讯
Java开发中POJO和JSON互转时如何忽略隐藏字段的更多相关文章
- paip.java 开发中web server的选择jboss resin tomcat比较..
paip.java 开发中web server的选择jboss resin tomcat比较.. 作者Attilax 艾龙, EMAIL:1466519819@qq.com 来源:attilax的专 ...
- Java开发中常见的危险信号(中)
本文来源于我在InfoQ中文站原创的文章,原文地址是:http://www.infoq.com/cn/news/2013/12/common-red-flags-in-java-1 Dustin Ma ...
- Java开发中文件读取方式总结
JAVA开发中,免不了要读文件操作,读取文件,首先就需要获取文件的路径. 路径分为绝对路径和相对路径. 在文件系统中,绝对路径都是以盘符开始的,例如C:\abc\1.txt. 什么是相对路径呢?相对路 ...
- java开发中遇到的问题及解决方法(持续更新)
摘自 http://blog.csdn.net/pony12/article/details/38456261 java开发中遇到的问题及解决方法(持续更新) 工作中,以C/C++开发为主,难免与其他 ...
- Java开发中常见的危险信号(上)
本文来源于我在InfoQ中文站原创的文章,原文地址是:http://www.infoq.com/cn/news/2013/12/common-red-flags-in-java-1 Dustin Ma ...
- 编写高质量代码:改善Java程序的151个建议(第一章:JAVA开发中通用的方法和准则)
编写高质量代码:改善Java程序的151个建议(第一章:JAVA开发中通用的方法和准则) 目录 建议1: 不要在常量和变量中出现易混淆的字母 建议2: 莫让常量蜕变成变量 建议3: 三元操作符的类型务 ...
- 完整java开发中JDBC连接数据库代码和步骤[申明:来源于网络]
完整java开发中JDBC连接数据库代码和步骤[申明:来源于网络] 地址:http://blog.csdn.net/qq_35101189/article/details/53729720?ref=m ...
- Java 开发中的对象拷贝
前言 在 Java 开发中,很多时候需要将两个属性基本相同的对象进行属性复制,比如 DO 转 VO等等. 本文主要介绍自己实现的简易拷贝工具类与 Spring 提供的属性拷贝的对比. Spring 提 ...
- [ 转载 ] Java开发中的23种设计模式详解(转)
Java开发中的23种设计模式详解(转) 设计模式(Design Patterns) ——可复用面向对象软件的基础 设计模式(Design pattern)是一套被反复使用.多数人知晓的.经过分类 ...
随机推荐
- 雅虎(ycsb)测试hbase(压测)
一.下载ycsb 0.10包 https://github.com/brianfrankcooper/YCSB/releases/download/0.10.0/ycsb-0.10.0.tar.gz ...
- idea中maven的安装与配置
说明:类似maven安装和配置的帖子在网上有很多,本人也有做过参照,但是有些帖子的步骤跳跃性比较大,故此,本人整理了一下,给大家做个参考. 一.下载安装 一般都是在官网进行下载 https://mav ...
- Java中常用修饰符浅谈
一.public.protected.default和private修饰符的作用域 public:在java程序中,如果将属性和方法定义为 public 类型,那么此属性和方法所在的类和及其子类,同一 ...
- Maven项目编译之后xml文件不存在
如题: 问题请看图,target目录是编译之后的,发现并没有对应的mapper.xml文件 原因: maven项目默认不加载此类文件 解决办法有两个: 其一是将mybatis的xml映射文件放在mav ...
- 【MySQL 基础】MySQL必知必会
MySQL必知必会 简介 <MySQL必知必会>的学习笔记和总结. 书籍链接 了解SQL 数据库基础 什么是数据库 数据库(database):保存有组织的数据的容器(通常是一个文 件或一 ...
- Nginx 安装与配置教程
标签: Nginx Linux Windows 配置 描述: Ubuntu 下以及 Windows 下 Nginx 的配置:配置详解:有关 Nginx 如何配置 Nginx 在 Ubuntu 下的安装 ...
- 浅谈Go中的time.After
go的一条哲学是 不要通过共享来实现通信,而是通信来实现共享 多协程之间通过 channel 来实现通信,而普遍会遇到的问题是,如何进行超时控制,资料一查询,需要配置select和time.After ...
- java8 stream api流式编程
java8自带常用的函数式接口 Predicate boolean test(T t) 传入一个参数返回boolean值 Consumer void accept(T t) 传入一个参数,无返回值 F ...
- docker 常用的容器命令
容器命令 # --name 给容器起名 # -p 端口映射 # -d 后台启动 # -it 交互模式启动 # 交互模式启动 # docker run -it 镜像名/id /bin/bash # do ...
- 【Docker】在Linux系统中安装Docker虚拟机、启动停止重启查看Docker命令
安装Docker 文章目录 安装Docker Docker虚拟机架构 在Linux系统中安装Docker虚拟机 管理Docker虚拟机 参考资料 Docker虚拟机架构 Docker创建的所有虚拟实例 ...