说明:fastjson2是一个性能极致并且简单易用的Java JSON库(官方语),本文介绍在Spring Boot项目中如何使用fastjson2。
创建项目
首先,创建一个Maven项目,引入fastjson2依赖,如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.12</version><relativePath/></parent><groupId>com.hezy</groupId><artifactId>fastjson2_demo</artifactId><version>1.0-SNAPSHOT</version><name>Archetype - fastjson2_demo</name><url>http://maven.apache.org</url><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency><!--fastjson2依赖--><dependency><groupId>com.alibaba.fastjson2</groupId><artifactId>fastjson2</artifactId><version>2.0.50</version></dependency></dependencies>
</project>
创建一个实体类对象,User
import lombok.*;
import java.io.Serializable;@Data
public class User implements Serializable {/*** id*/private String id;/*** 证件号*/private String cardNo;/*** 手机号*/private String phone;/*** 姓名*/private String name;/*** 用户名*/private String username;/*** 密码*/private String password;
}
这里需要注意对象需要实现Serializable
接口,表示该对象实例能被序列化,另外对象需要有全参构造、无参构造(@Data注解自动生成),在分布式项目中,服务之间传输对象(如Dubbo、MQ)底层实现依赖于对象的全参构造,如果对象没有全参构造方法会报错的。
还有,严格来说,对象需要设置一个序列化版本ID,不设置Java虚拟机会自动为其设置。但如果在序列化之后,改动过对象的属性,那么自动设置的序列化版本ID会发生改变,这时候再去反序列化原来生成过的JavaBean数据(如文本、xml文件、缓存中的)就会报错。
private static final long serialVersionUID = 1L
这里只是一个Demo,就不讲究了。
使用
先创建一些变量,如下:
static User user;static String userJson = "{\"id\":\"10001\",\"cardNo\":\"123456194910014896\",\"phone\":\"12345678901\",\"name\":\"hezy\",\"username\":\"hezy\",\"password\":\"123456\"}";static byte[] userJsonBytes = userJson.getBytes();static String userJsonArray = "[{\"id\":\"10001\",\"cardNo\":\"123456194910014896\",\"phone\":\"12345678901\",\"name\":\"hezy\",\"username\":\"hezy\",\"password\":\"123456\"}]";static {user = new User();user.setId("10001");user.setCardNo("123456194910014896");user.setPhone("12345678901");user.setName("hezy");user.setUsername("hezy");user.setPassword("123456");}
2.1将JSON解析为JSONObject
/*** 2.1将JSON解析为JSONObject*/@Testpublic void jsonToJSONObject() {JSONObject jsonObject1 = JSON.parseObject(userJson);System.out.println(jsonObject1);JSONObject jsonObject2 = JSON.parseObject(userJsonBytes);System.out.println(jsonObject2);}
2.2 将JSON解析为JSONArray
/*** 2.2将JSON解析为JSONArray*/@Testpublic void jsonToJSONArray() {JSONArray jsonArray = JSON.parseArray(userJsonArray);System.out.println(jsonArray.get(0));}
2.3 将JSON解析为Java对象
/*** 2.3 将JSON解析为Java对象*/@Testpublic void jsonToJavaBean() {User userBean = JSON.parseObject(userJson, User.class);System.out.println(userBean);}
2.4 将Java对象序列化为JSON
/*** 2.4 将Java对象序列化为JSON*/@Testpublic void javaBeanToJson() {String jsonString = JSON.toJSONString(user);System.out.println(jsonString);byte[] jsonBytes = JSON.toJSONBytes(userJsonBytes);System.out.println(jsonBytes);}
2.5 使用JSONObject、JSONArray
2.5.1 获取简单属性
/*** 2.5.1 使用JSONObject、JSONArray* 获取简单属性*/@Testpublic void getValue() {JSONObject jsonObject = JSON.parseObject(userJson);String username = jsonObject.getString("username");System.out.println(username);}
2.5.2 读取JavaBean
/*** 2.5.2 使用JSONObject、JSONArray* 读取JavaBean*/@Testpublic void getJavaBean() {JSONArray jsonArray = JSON.parseArray(userJsonArray);JSONObject jsonObject = JSON.parseObject(userJson);User userBean = jsonArray.getObject(0, User.class);System.out.println(userBean);// 这里也可以换成自定义对象,就是说支持读取对象中的对象String username = jsonObject.getObject("username", String.class);System.out.println(username);}
2.5.3 转为JavaBean
/*** 2.5.3 使用JSONObject、JSONArray* 转为JavaBean*/@Testpublic void toJavaBean() {JSONArray jsonArray = JSON.parseArray(userJsonArray);JSONObject jsonObject = JSON.parseObject(userJson);User user = jsonObject.toJavaObject(User.class);System.out.println(user);List<User> users = jsonArray.toJavaList(User.class);System.out.println(users);}
2.6 将JavaBean对象序列化为JSON
/*** 2.6 将JavaBean对象序列化为JSON*/@Testpublic void javaBeanObjectToJson() {String jsonString = JSON.toJSONString(user);System.out.println(jsonString);byte[] jsonBytes = JSON.toJSONBytes(user);System.out.println(jsonBytes);}
相关注解
-
@JsonIgnore:序列化时排除该属性,详情参考:排除对象属性序列化的三种方式
-
@JSONType(orders = {}):定义序列化时的属性顺序;
@Data
@JSONType(orders = {"id", "cardNo", "phone", "name", "username", "password"})
public class User implements Serializable {……
}
如上面2.6方法,加上上面的注解后重新启动,结果如下,序列化后属性顺序改变了:
- @JSONField(name = “”):指定该属性序列化时的名称;
/*** 姓名*/@JSONField(name = "realName")private String name;
如上面2.6方法,加上注解后重新启动,结果如下,序列化后的name
变为realName
- @JsonFormat(pattern = “yyyy-MM-dd”, timezone = “GMT+8”):日期格式化成
yyyy-MM-dd
,时区为东八区;
创建一个日期属性,如下:
/*** 生日*/@JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")private Date birthday;
赋值,当前日期
user.setBirthday(new Date());
打印序列化前后的内容
/*** 2.6 将JavaBean对象序列化为JSON*/@Testpublic void javaBeanObjectToJson() {System.out.println(user);String jsonString = JSON.toJSONString(user);System.out.println(jsonString);}
可以看到日期格式发生了改变
总结
集中去看API毫无意义,因为看了、敲了,用的时候也会忘,而且这些API名称看起来都差不多,不好区分。用的时候再去查(源码、百度、GPT)也都来得及,后面的注解值得一看。