一、Gson:JSON分析库Google开源
1.添加依赖
<!--gson--><dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId></dependency><!--lombok--><dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId></dependency>
toJson:用于序列化,序列化为Json数据。
fromJson:用于反序列化,将Json数据转反序列号为对象。
示例代码如下:
import lombok.*; /** * @author qinxun * @date 2023-05-30 * @Descripion: 学生实体类 */@Getter@Setter@AllArgsConstructor@NoArgsConstructor@ToStringpublic class Student { private Long termId; private Long classId; private Long studentId; private String name; }
import com.example.quartzdemo.entity.Student;import com.google.gson.Gson;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; /** * @author qinxun * @date 2023-06-09 * @Descripion: Gson测试 */@SpringBootTestpublic class GsonTest { @Test void test1() { Student student = new Student(1L, 2L, 2L, "张三"); Gson gson = new Gson(); // 输出{"termId":1,"classId":2,"studentId":2,"name":"张三"} System.out.println(gson.toJson(student)); String data = "{\"termId\":2,\"classId\":2,\"studentId\":2,\"name\":"""""""; Student studentData = gson.fromJson(data, Student.class); // 输出Student(termId=2, classId=2, studentId=2, name=李四) System.out.println(studentData); }}
二、fastjson:阿里巴巴开源JSON分析库1.添加依赖
<!--fastjson--><dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.83</version></dependency>
JSON.toJSONString(obj):将对象转换为json数据进行序列化。
JSON.parseObject(obj,class): 用于反序列化对象,转换为数据对象。
JSON.parseArray():把 JSON 字符串转成集合
示例代码如下:
mport com.alibaba.fastjson.JSON;import com.example.quartzdemo.entity.Student;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; import java.util.List; /** * @author qinxun * @date 2023-06-09 * @Descripion: fastjson测试 */@SpringBootTestpublic class FastJsonTest { @Test void test1() { Student student = new Student(1L, 2L, 2L, "张三"); String json = JSON.toJSONString(student); // 输出{"classId":2,"name":"张三","studentId":2,"termId":1} System.out.println(json); String data = "{\"termId\":2,\"classId\":2,\"studentId\":2,\"name\":"""""""; Student student1 = JSON.parseObject(data, Student.class); // 输出Student(termId=2, classId=2, studentId=2, name=李四) System.out.println(student1); String arrStr = "[{\"termId\":2,\"classId\":2,\"studentId\":2,\"name\":「李四\」termId\":1,\"classId\":2,\"studentId\":2,\"name\":"""""""""; List<Student> studentList = JSON.parseArray(arrStr, Student.class); // 输出[Student(termId=2, classId=2, studentId=2, name=李四), Student(termId=1, classId=2, studentId=2, name=张三)] System.out.println(studentList); }}
2.使用注解
有时候,你的 JSON 字符串中的 key 可能与 Java 对象中的字段不匹配,如大小写;有时,您需要指定一些字段序列化,但不反序列化;有时,您需要将日期字段显示为指定格式。我们只需要添加相应的字段 @JSONField 注释就够了。name 用于指定字段的名称,format 用于指定日期格式,serialize 和 deserialize 用于指定序列化和反序列化。
public @interface JSONField { String name() default ""; String format() default ""; boolean serialize() default true; boolean deserialize() default true;}
示例代码如下:
import com.alibaba.fastjson.annotation.JSONField;import lombok.*; import java.util.Date; /** * @author qinxun * @date 2023-05-30 * @Descripion: 学生实体类 */@Getter@Setter@AllArgsConstructor@NoArgsConstructor@ToStringpublic class Student { private Long termId; private Long classId; @JSONField(serialize = false, deserialize = true) private Long studentId; private String name; @JSONField(format = "yyyyy年MM月dd日" private Date birthday; }
我们设置studentid不支持序列化,但支持反序列化。
import com.alibaba.fastjson.JSON;import com.example.quartzdemo.entity.Student;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; import java.util.Date;import java.util.List; /** * @author qinxun * @date 2023-06-09 * @Descripion: fastjson测试 */@SpringBootTestpublic class FastJsonTest { @Test void test1() { Student student = new Student(1L, 2L, 2L, "张三", new Date()); String json = JSON.toJSONString(student); // 输出{"birthday":"2023年06月9日"classId":2,"name":"张三","termId":1} System.out.println(json); String data = "{\"termId\":2,\"classId\":2,\"studentId\":2,\"name\":"""""""; Student student1 = JSON.parseObject(data, Student.class); // 输出Student(termId=2, classId=2, studentId=2, name=李四, birthday=null) System.out.println(student1); String arrStr = "[{\"termId\":2,\"classId\":2,\"studentId\":2,\"name\":\{\"termId\":1,\"classId\":2,\"studentId\":2,\"name\":"""""""""; List<Student> studentList = JSON.parseArray(arrStr, Student.class); // 输出[Student(termId=2, classId=2, studentId=2, name=李四, birthday=null), Student(termId=1, classId=2, studentId=2, name=张三, birthday=null)] System.out.println(studentList); }}
执行结果:
{"birthday":"2023年06月9日"classId":2,"name":"张三","termId":1}Student(termId=2, classId=2, studentId=2, name=李四, birthday=null)[Student(termId=2, classId=2, studentId=2, name=李四, birthday=null), Student(termId=1, classId=2, studentId=2, name=张三, birthday=null)]
我们发现studentid并没有被序列化为json数据,而是在反序列化时成功地将反序列化为对象。birthday生成了自定义的日期数据格式。
三、Jackson:JSON分析工具SpringBoot默认1.添加依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency>
加入默认web依赖后,自动加入Jackson依赖。
2.序列化
writeValueAsString(Object value) 该方法将对象存储在字符串中。
writeValueAsBytes(Object value) 该方法将对象存储在字节数组中。
writeValue(File resultFile, Object value) 将对象存储成文件的方法。
示例代码如下:
import lombok.*; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@Getter@Setter@AllArgsConstructor@NoArgsConstructor@ToStringpublic class Writer { private String name; private int age; }
import com.example.quartzdemo.bean.Writer;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@SpringBootTestpublic class JacksonTest { @Test void test1() throws JsonProcessingException { Writer writer = new Writer("qx", 25); ObjectMapper mapper = new ObjectMapper(); String jsonStr = mapper.writerWithDefaultPrettyPrinter() .writeValueAsString(writer); System.out.println(jsonStr); }}
执行结果:
{ "name" : "qx", "age" : 25}
3.反序列化
readValue(String content, Class<T> valueType) 该方法将字符串反序列化为 Java 对象
readValue(byte[] src, Class<T> valueType) 该方法将字节数组反序列化为 Java 对象
readValue(File src, Class<T> valueType) 该方法将文件反序列化为 Java 对象
示例代码如下:
import com.example.quartzdemo.bean.Writer;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@SpringBootTestpublic class JacksonTest { @Test void test1() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); String jsonString = "{\n" + " \"name\" : \"qx\",\n" + " \"age\" : 18\n" + "}"; Writer writer = mapper.readValue(jsonString, Writer.class); // 输出Writer(name=qx, age=18) System.out.println(writer); }}
借助 TypeReference 可以将 JSON 字符串数组转化为泛型 List
示例代码如下:
import com.example.quartzdemo.bean.Writer;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.core.type.TypeReference;import com.fasterxml.jackson.databind.ObjectMapper;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; import java.util.List; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@SpringBootTestpublic class JacksonTest { @Test void test1() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); String json = "[{ \"name\" : "张三\" \"age\" : 18 }, { \"name\" : "李四\" \"age\" : 19 }]"; List<Writer> writerList = mapper.readValue(json, new TypeReference<List<Writer>>() { }); // 输出[Writer(name=张三, age=18), Writer(name=李四, age=19)] System.out.println(writerList); }}
注:并非所有字段都支持序列化和反序列化,需要符合以下规则:
假如字段的修饰符是 public,可序列化和反序列化字段(不是标准写法)。
如果字段的修饰符不是 public,但是它的 getter 方法和 setter 方法是 public,可序列化和反序列化的字段。getter 该方法用于序列化,setter 方法用于反序列化。
假如只有字段 public 的 setter 方法,而无 public 的 getter 方 法则,该字段只能用于反序列化。
4.日期格式
我们使用@JsonFormat注释来实现自定义的日期格式
示例代码如下:
import com.fasterxml.jackson.annotation.JsonFormat;import lombok.*; import java.util.Date; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@Getter@Setter@AllArgsConstructor@NoArgsConstructor@ToStringpublic class Writer { private String name; private int age; @JsonFormat(pattern = "yyyyy年MM月dd日" private Date birthday; }
import com.example.quartzdemo.bean.Writer;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; import java.util.Date; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@SpringBootTestpublic class JacksonTest { @Test void test1() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); Writer writer = new Writer(张三), 25, new Date()); String json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(writer); System.out.println(json); }}
程序执行结果:
{ "name" : "张三", "age" : 25, "birthday" : 2023年6月9日}
5.字段过滤
在将 Java 对象序列化为 JSON 有些字段可能需要过滤而不显示 JSON 中,我们用@JsonIgnore 用于过滤单个字段。
示例代码如下:
import com.fasterxml.jackson.annotation.JsonFormat;import com.fasterxml.jackson.annotation.JsonIgnore;import lombok.*; import java.util.Date; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@Getter@Setter@AllArgsConstructor@NoArgsConstructor@ToStringpublic class Writer { private String name; @JsonIgnore private int age; @JsonFormat(pattern = "yyyyy年MM月dd日" private Date birthday; }
import com.example.quartzdemo.bean.Writer;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import org.junit.jupiter.api.Test;import org.springframework.boot.test.context.SpringBootTest; import java.util.Date; /** * @author qinxun * @date 2023-06-09 * @Descripion: */@SpringBootTestpublic class JacksonTest { @Test void test1() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); Writer writer = new Writer(张三), 25, new Date()); String json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(writer); System.out.println(json); }}
程序执行结果:
{ "name" : "张三", "birthday" : 2023年6月9日}
age字段没有在返回的Json数据中找到,成功过滤掉了这个字段。