1. 前言
在上一期《SpringBoot之Jackson配置全局时间日期格式》文中提到Jackson,了解到有很多小伙伴对它很感兴趣;顾这一期,我就重点带着大家以最基础的教学方式领大家入门,废话不多说,咱们这就开始。
这将又会是干货满满的一期,全程无尿点不废话只抓重点教,具有非常好的学习效果,拿好小板凳准备就坐!希望学习的过程中大家认真听好好学,学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信,bug菌将第一时间给予解惑,那么废话不多说,直接开整!Fighting!!
2. 环境说明
本地的开发环境:
开发工具:IDEA 2021.3 JDK版本: JDK 1.8 Spring Boot版本:2.3.1 RELEASE Maven版本:3.8.2
3.正文
3.1 概述
在日常开发过程中,用于处理json和xml格式化的类库中,用的比较广泛的就属Jackson了,而且Spring MVC 框架默认的json解析器也是Jackson。
在当前,除了jackson外,常见的解析器还有:Jsonlib,Gson,fastjson等;对比这些解析器,jackson的优势立马就体现出来了,比如解析大的json文件jackson处理速度快,运行时占用内存低,性能好,而且jackson附带灵活的API,便于扩展和定制;
而对于Jackson 的 1.x 版本的包名为 org.codehaus.jackson ,当版本升级到 2.x 以上时,包名变为 com.fasterxml.jackson,本文教学的内容也是基于最新的 Jackson 2.9.1 版本。
总之Jackson是一款非常强悍的处理json和xml格式化的开源类库了,安利给大家。
3.2 引入jackson依赖
xml复制代码<!--jackson依赖--> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.1</version> </dependency>
注意:如果你是springboot项目,并且有引入spring-boot-starter-web这个starter,你就不需要引入上方jackson的依赖包了,因为引入web这个starter自带就带有jackson依赖包,所以大家不要重复导包啦,特此提醒!!以上导入jackson依赖是针对没有导入web-starter的小伙伴而设立的,大家看清楚,别重复了。
3.3 求证spring-boot-starter-web自带jackson依赖
如下,我给大家举证一遍,为何导入了web-starter就不需要导入jackson依赖了。
对于导入了web starter,深究进去,可以看到在spring-boot-starter-web这个starter包中有涉及json相关的依赖。
我们选择spring-boot-starter-json继续深入,进入了里头,可以发现,jackson是有被直接集成到该web-starter中的,大家请看如下截图:
所以,非springboot项目的小伙伴,那就得自行引包啦。
3.4 Jackson核心模块介绍
引入Jackson包,我们可以看到,在依赖中分别有如下三类包,大家请看:
那对于这三类宝,到底分别有何作用呢?有的小伙伴肯定不得而知,没关系,接下来我就具体给大家逐一介绍一下,这三类包分别是干嘛用的,具体如下:
- jackson-core:
核心包,它提供基于"流模式"解析的相关 API,它包括JsonPaser和JsonGenerator。Jackson 内部实现正是通过高性能的流模式 API 的 JsonGenerator 和 JsonParser 来生成和解析 json。
- jackson-annotations:
注解包,提供标准注解功能。
- jackson-databind:
数据绑定包, 提供基于"对象绑定" 解析的相关 API ( ObjectMapper ) 和"树模型" 解析的相关 API (JsonNode);基于"对象绑定" 解析的 API 和"树模型"解析的 API 依赖基于"流模式"解析的 API。
4. jackson使用
4.1 导入Jar包
老样子,使用前先导依赖,具体依赖配置信息如下,你们直接vc大法即可。
xml复制代码<!--jackson依赖--> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.1</version> </dependency>
注意:如果你是springboot项目,并且有引入spring-boot-starter-web这个starter,你就不需要引入上方jackson的依赖包了。至于原因我上篇已经详细解释过了,新来的小伙伴想知道可以去翻我上篇,这里就不再赘述啦。
4.2 Jackson注解
我们先来学习一下jackson提供的常用注解,大家可根据实际需求,灵活调用,还是非常简单好使的。常用注解及用法如下:
@JsonProperty
用法:此注解用于属性上;作用是把该属性名称序列化为另外一个名称,如把userName属性序列化为name,
示例:
kotlin复制代码@JsonProperty("name") private String userName;
@JsonFormat
用法:此注解用于属性或方法;作用是把属性的格式序列化成指定的格式。
示例1:
kotlin复制代码@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm") private Date createTime;
示例2:
typescript复制代码@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm") public Date getCreateTime(){}
@JsonPropertyOrder
用法:此注解用于用于类;作用是指定属性在序列化时 json 中的顺序 ,
示例:
kotlin复制代码@JsonPropertyOrder({ "id", "name","age",""sex }) public class Person{}
@JsonCreator
用法:此注解用于构造方法,和 @JsonProperty 配合使用,适用有参数的构造方法。
示例:
less复制代码@JsonCreator public LogInfo(@JsonProperty("id") int id) { this.id = id; }
@JsonAnySetter
用法:此注解用于属性或者方法,作用是设置未反序列化的属性名和值作为键值存储到 map 中
示例:
typescript复制代码public class User { @JsonProperty("name") private String name; @JsonProperty("age") private String age; private Map<String, Object> others; @JsonAnyGetter public Map<String, Object>anySetter() { return others } @JsonAnySetter public void anySetter(String key, Object value) { if (others == null) { others = new HashMap<>(); } others .put(key, value); } }
@JsonAnyGetter
用法:此注解用于方法 ,作用是获取所有未序列化的属性 。
示例:
typescript复制代码@JsonAnyGetter public Map<String, Object>anySetter() { return others }
@JsonIgnore
用法:此注解用于属性上,作用是进行JSON操作时忽略该属性
示例:
typescript复制代码@JsonIgnore private String exception;
4.3 Json转为Java对象
提及json串转成对象,方式方法太多了。但是今天我要你要学会用jackson来处理,想不想学?很简单的,饭都递嘴边了,张口!
其实核心也就是该方法readValue(),学会使用即可。
案例演示如下:
scss复制代码/** * json字符串转对象 */ @Test void testReadValue() throws JsonProcessingException { //1.定义一个json串 String json = ""{"id":1,"name":"bug菌","age":18,"sex":"男","address":"上海市闵行区吴泾镇","describes":null,"image":"./template/cat.jpg"}"; //2.创建ObjectMapper类 ObjectMapper mapper = new ObjectMapper(); UserEntity user = mapper.readValue(json, UserEntity.class); //3.打印 System.out.println(user); }
4.4 Java对象转换Json
将java对象转成json字符串,用到了writeValueAsString()方法,学会使用即可。
接下来我给大家演示一下,如何使用?
scss复制代码/** * 对象转json字符串 */ @Test void testWriteValueAsString() throws Exception { //1.创建对象 UserEntity user = new UserEntity(); user.setId(1); user.setName("bug菌"); user.setSex("男"); user.setAge(18); user.setImage("./template/cat.jpg"); user.setAddress("上海市闵行区吴泾镇"); //2.创建ObjectMapper类 ObjectMapper mapper = new ObjectMapper(); String userJson = mapper.writeValueAsString(user); //3.打印 System.out.println(userJson); //4.写入txt文件中 mapper.writeValue(new File("./template/userJson.txt"), userJson); }
控制台输出结果如下:
成功将json串写入txt记事本中。
还有更多的复杂的玩法儿,这就不一一举例演示了,更多的是靠大家去钻研了。
... ...
作者:bug菌