Java实体和JSON之间的相互转换

太过爱你忘了你带给我的痛 2024-03-22 10:36 92阅读 0赞

#### Java实体和JSON之间的相互转换 ####

*  一、先写一个测试用的Java实体
 *  二、将Java实体转化为Json
 *   *  1、基于com.alibaba.fastjson.JSON
     *   *  （1）、JSON.toJSONString(user)，会丢掉值为空的字段。
         *  （2）、JSON.toJSONString(user, SerializerFeature.WriteMapNullValue)，保留值为空的字段，并初始化为null。
         *  （3）、JSON.toJSONString(user, SerializerFeature.WriteNonStringValueAsString)，会将非空的字段值加上""，并丢掉没有初始化的字段。
         *  （4）、JSON.toJSONString(user, SerializerFeature.WriteNullStringAsEmpty)，会将String类型的字段加上""，没有显示初始化的String类型参数保留，保留默认初始化为null的字段，同时丢掉其他未初始化的、非String类型的字段。
         *  （5）、JSON.toJSONString(user, SerializerFeature.WriteNullListAsEmpty)，会非空、String类型的字段加上""，保留默认初始化为null的字段，同时丢掉其他未初始化的、非String类型的字段。
         *  （6）、JSON.toJSONString(user, SerializerFeature.QuoteFieldNames)，转化之后的字段名会加上""，和默认一样。
         *  （7）、JSON.toJSONString(user, SerializerFeature.WriteDateUseDateFormat)，转化之后Date类型为传入格式，默认是时间戳。
         *  （8）、JSON.toJSONString(user, SerializerFeature.WriteNullNumberAsZero)，转化之后会将没有初始化的数字类型（BigDecimal、Float、Double）字段初始化为0，保留初始化为null的字段，丢掉其他类型未显示初始化的字段。
         *  （9）、JSON.toJSONString(user, SerializerFeature.WriteNullBooleanAsFalse)，转化之后会将没有初始化的Boolean类型字段初始化为false，保留初始化为null的字段，丢掉其他类型未显示初始化的字段。
         *  （10）、JSON.toJSONString(user, SerializerFeature.PrettyFormat)，格式化Json，丢掉其他未显示初始化的字段。
     *  2、基于com.alibaba.fastjson.JSONObject
     *  3、基于com.fasterxml.jackson.databind.ObjectMapper的writeValueAsString方法
     *  4、基于com.google.gson.Gson的toJson方法。
     *   *  （1）、直接实例化一个Gson，将Java实体传入实例中的toJson，会丢掉没有初始化的字段。
         *  （2）、在转化为json的同时，保留没有显示初始化的字段。
         *  （3）、设置时间格式。
         *  （4）、格式化输出。
 *  三、将Json转换为Java实体
 *   *  1、先拿到测试Json
     *  2、基于com.alibaba.fastjson.JSON
     *  3、基于com.alibaba.fastjson.JSONObject
     *  4、基于com.fasterxml.jackson.databind.ObjectMapper的readValue方法
     *  5、基于com.google.gson.Gson

## 一、先写一个测试用的Java实体 ##

代码如下：

import cn.hutool.core.date.DateUtil;
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import com.alibaba.fastjson.serializer.SerializerFeature;
    import lombok.Data;
    
    import java.math.BigDecimal;
    import java.util.Date;
    
    /**
     * 测试用户类
     *
     * @author：gan
     * @date: 2023-04-28 15:33
     */
    @Data
    public class User {
        
        private String name;
    
        private Integer age;
    
        private Date birthday;
    
        private char sex;
    
        private Float height;
    
        private Double weight;
    
        private BigDecimal money;
    
        private Boolean adult;
    
    	//下面这些初始化为空，用于后面测试效果时用
    
        private String nameDesc;
    
        private Integer ageDesc;
    
        private Date birthdayDesc;
    
        private char sexDesc;
    
        private Float heightDesc;
    
        private Double weightDesc;
    
        private BigDecimal moneyDesc;
    
        private Boolean adultDesc;
    
        public User() {
        
        }
    
        public User(String name, Integer age, Date birthday, char sex, Float height, Double weight, BigDecimal money, Boolean adult) {
        
            this.name = name;
            this.age = age;
            this.birthday = birthday;
            this.sex = sex;
            this.height = height;
            this.weight = weight;
            this.money = money;
            this.adult = adult;
        }
    }

初始化并输出一下：

public static void main(String[] args) {
        
            User user = new User("王宇", 25, DateUtil.parse("1998-10-12 13:25:22"), '男', 180.0f, 71.55, new BigDecimal("2104.5"), true);
            System.out.println("toString方法：" + user);
        }

![在这里插入图片描述][9db0894033fe424caed7de28cd26eddb.png]  
**注意，如果没有使用“@Data”注解，一定要加上get和set方法，不然转化之后的Json是空的！**

## 二、将Java实体转化为Json ##

### 1、基于com.alibaba.fastjson.JSON ###

主要是对SerializerFeature枚举类的使用，详细的可以看这个博客：

> https://blog.csdn.net/xiang\_\_liu/article/details/81570923

或者看这里：

> https://www.javadoc.io/static/com.alibaba/fastjson/1.2.2/com/alibaba/fastjson/serializer/SerializerFeature.html\#BeanToArray

下面是对SerializerFeature的使用演示：

#### （1）、JSON.toJSONString(user)，会丢掉值为空的字段。 ####

运行结果如下：

![在这里插入图片描述][3ef9330294fe42f7afe97f3627b74222.png]  
可以看到，直接使用toJSONString将Java实体转化为Json，会把没有显示初始化的字段丢掉。

> “\\u0000”是char类型的默认值，相对于null。

#### （2）、JSON.toJSONString(user, SerializerFeature.WriteMapNullValue)，保留值为空的字段，并初始化为null。 ####

加上“SerializerFeature.WriteMapNullValue”，会输出值为空的字段。

运行结果如下：

![在这里插入图片描述][2d9064feb065494887cf8576d5977705.png]

#### （3）、JSON.toJSONString(user, SerializerFeature.WriteNonStringValueAsString)，会将非空的字段值加上""，并丢掉没有初始化的字段。 ####

运行结果如下：

![在这里插入图片描述][86bfbc5c236a4eb6b8d5af97c95a0ca4.png]

#### （4）、JSON.toJSONString(user, SerializerFeature.WriteNullStringAsEmpty)，会将String类型的字段加上""，没有显示初始化的String类型参数保留，保留默认初始化为null的字段，同时丢掉其他未初始化的、非String类型的字段。 ####

运行结果如下：

![在这里插入图片描述][9695e66e9aea49df8e8948ad2bd21267.png]

#### （5）、JSON.toJSONString(user, SerializerFeature.WriteNullListAsEmpty)，会非空、String类型的字段加上""，保留默认初始化为null的字段，同时丢掉其他未初始化的、非String类型的字段。 ####

运行结果如下：  
![在这里插入图片描述][c143fbdf9e534d86a9e47c1306c8de71.png]

#### （6）、JSON.toJSONString(user, SerializerFeature.QuoteFieldNames)，转化之后的字段名会加上""，和默认一样。 ####

运行结果如下：

![在这里插入图片描述][96d55f340467403da15c73f764ebe83c.png]

#### （7）、JSON.toJSONString(user, SerializerFeature.WriteDateUseDateFormat)，转化之后Date类型为传入格式，默认是时间戳。 ####

运行结果如下：

![在这里插入图片描述][5bcad8e2b3a547af8c3505338de9e0e3.png]

#### （8）、JSON.toJSONString(user, SerializerFeature.WriteNullNumberAsZero)，转化之后会将没有初始化的数字类型（BigDecimal、Float、Double）字段初始化为0，保留初始化为null的字段，丢掉其他类型未显示初始化的字段。 ####

运行结果如下：

![在这里插入图片描述][f047abb91dc44ac1b0ee22ce47795b2d.png]

#### （9）、JSON.toJSONString(user, SerializerFeature.WriteNullBooleanAsFalse)，转化之后会将没有初始化的Boolean类型字段初始化为false，保留初始化为null的字段，丢掉其他类型未显示初始化的字段。 ####

User user = new User("王宇", 25, DateUtil.parse("1998-10-12 13:25:22"), '男', 180.0f, 71.55, new BigDecimal("2104.5"), true);
    System.out.println("toString方法：" + user);
    
    System.out.println("=================================JSON.toJSONString start================================");
    
    String jsonStr1 = JSON.toJSONString(user);
    System.out.println("jsonStr1：" + jsonStr1);
    
    String jsonStr2 = JSON.toJSONString(user, SerializerFeature.WriteMapNullValue);
    System.out.println("jsonStr2：" + jsonStr2);
    
    String jsonStr3 = JSON.toJSONString(user, SerializerFeature.WriteNonStringValueAsString);
    System.out.println("jsonStr3：" + jsonStr3);
    
    String jsonStr4 = JSON.toJSONString(user, SerializerFeature.WriteNullStringAsEmpty);
    System.out.println("jsonStr4：" + jsonStr4);
    
    String jsonStr5 = JSON.toJSONString(user, SerializerFeature.WriteNullListAsEmpty);
    System.out.println("jsonStr5：" + jsonStr5);
    
    String jsonStr6 = JSON.toJSONString(user, SerializerFeature.QuoteFieldNames);
    System.out.println("jsonStr6：" + jsonStr6);
    
    String jsonStr7 = JSON.toJSONString(user, SerializerFeature.WriteDateUseDateFormat);
    System.out.println("jsonStr7：" + jsonStr7);
    
    String jsonStr8 = JSON.toJSONString(user, SerializerFeature.WriteNullNumberAsZero);
    System.out.println("jsonStr8：" + jsonStr8);
    
    String jsonStr9 = JSON.toJSONString(user, SerializerFeature.WriteNullBooleanAsFalse);
    System.out.println("jsonStr9：" + jsonStr9);

运行结果如下：

![在这里插入图片描述][604fb92c6d1d4db297da3858eba615b6.png]

#### （10）、JSON.toJSONString(user, SerializerFeature.PrettyFormat)，格式化Json，丢掉其他未显示初始化的字段。 ####

运行结果如下：

![在这里插入图片描述][6262fc311fe64475a3a7aacbc94f9037.png]

### 2、基于com.alibaba.fastjson.JSONObject ###

JSONObject是JSON的子类，并且没有重写“toJSONString”方法，所以效果是一样的。  
![在这里插入图片描述][40a0796045144ef4afbabf57f9e568ce.png]

代码如下：

User user = new User("王宇", 25, DateUtil.parse("1998-10-12 13:25:22"), '男', 180.0f, 71.55, new BigDecimal("2104.5"), true);
    System.out.println("toString方法：" + user);
    
    System.out.println("=================================JSONObject.toJSONString start================================");
    
    String jsonObjectStr1 = JSONObject.toJSONString(user);
    System.out.println("jsonObjectStr1：" + jsonObjectStr1);
    
    String jsonObjectStr2 = JSONObject.toJSONString(user, SerializerFeature.WriteMapNullValue);
    System.out.println("jsonObjectStr2：" + jsonObjectStr2);
    
    String jsonObjectStr3 = JSONObject.toJSONString(user, SerializerFeature.WriteNonStringValueAsString);
    System.out.println("jsonObjectStr3：" + jsonObjectStr3);
    
    String jsonObjectStr4 = JSONObject.toJSONString(user, SerializerFeature.WriteNullStringAsEmpty);
    System.out.println("jsonObjectStr4：" + jsonObjectStr4);
    
    String jsonObjectStr5 = JSONObject.toJSONString(user, SerializerFeature.WriteNullListAsEmpty);
    System.out.println("jsonObjectStr5：" + jsonObjectStr5);
    
    String jsonObjectStr6 = JSONObject.toJSONString(user, SerializerFeature.QuoteFieldNames);
    System.out.println("jsonObjectStr6：" + jsonObjectStr6);
    
    String jsonObjectStr7 = JSONObject.toJSONString(user, SerializerFeature.WriteDateUseDateFormat);
    System.out.println("jsonObjectStr7：" + jsonObjectStr7);
    
    String jsonObjectStr8 = JSONObject.toJSONString(user, SerializerFeature.WriteNullNumberAsZero);
    System.out.println("jsonObjectStr8：" + jsonObjectStr8);
    
    String jsonObjectStr9 = JSONObject.toJSONString(user, SerializerFeature.WriteNullBooleanAsFalse);
    System.out.println("jsonObjectStr9：" + jsonObjectStr9);
    
    String jsonObjectStr10 = JSONObject.toJSONString(user, SerializerFeature.PrettyFormat);
    System.out.println("jsonObjectStr10：" + jsonObjectStr10);
    
    System.out.println("=================================JSONObject.toJSONString end================================");

![在这里插入图片描述][aab84f19c605418484549e2a7a4edff0.png]

### 3、基于com.fasterxml.jackson.databind.ObjectMapper的writeValueAsString方法 ###

代码如下：

User user = new User("王宇", 25, DateUtil.parse("1998-10-12 13:25:22"), '男', 180.0f, 71.55, new BigDecimal("2104.5"), true);
    System.out.println("toString方法：" + user);
    
    ObjectMapper objectMapper = new ObjectMapper();
    try {
        
        String objectMapperStr = objectMapper.writeValueAsString(user);
        System.out.println("objectMapperStr：" + objectMapperStr);
    } catch (JsonProcessingException e) {
        
        e.printStackTrace();
    }

运行结果如下：

![在这里插入图片描述][fd11757687424ebba125b89052512b63.png]  
writeValueAsString方法会保留没有显示初始化的的字段，除了char类型初始化值为“\\u0000”，其他都为“null”。

### 4、基于com.google.gson.Gson的toJson方法。 ###

#### （1）、直接实例化一个Gson，将Java实体传入实例中的toJson，会丢掉没有初始化的字段。 ####

运行结果如下：

![在这里插入图片描述][33a38c3ba90b4d2898eaf82cdc075596.png]  
char类型还是保留下来了。

#### （2）、在转化为json的同时，保留没有显示初始化的字段。 ####

“Gson gson = new Gson();”只能简单地将Java实体转为json，要保留没有显示初始化的字段，需要用到“GsonBuilder”初始化“Gson”，代码如下：

User user = new User("王宇", 25, DateUtil.parse("1998-10-12 13:25:22"), '男', 180.0f, 71.55, new BigDecimal("2104.5"), true);
    System.out.println("toString方法：" + user);
    
    Gson gson = new GsonBuilder()
        .serializeNulls()
        .create();
    
    String gsonStr1 = gson.toJson(user);
    System.out.println("gsonStr1：" + gsonStr1);

运行结果如下：

![在这里插入图片描述][df5d21db81334b77af872425f3b31773.png]  
可以看到没有显示初始化的字段都保留下来了，并且值都为“null”。

#### （3）、设置时间格式。 ####

上面可以看到时间格式默认是国际化格式，想要转换为“yyyy年MM月dd日 时:分:秒”怎么办？可以使用“setDateFormat”格式化时间，代码如下：

User user = new User("王宇", 25, DateUtil.parse("1998-10-12 13:25:22"), '男', 180.0f, 71.55, new BigDecimal("2104.5"), true);
    System.out.println("toString方法：" + user);
    
    Gson gson = new GsonBuilder()
        .serializeNulls()
        .setDateFormat("yyyy年MM月dd日 HH:mm:ss")
        .create();
    
    String gsonStr1 = gson.toJson(user);
    System.out.println("gsonStr1：" + gsonStr1);

运行结果如下：

![在这里插入图片描述][ee134064a17849a186c4c32aa18c88da.png]  
可以看到时间已经转换为目标格式。

#### （4）、格式化输出。 ####

如果觉得转换之后的json只有一行不好看，可以使用“setPrettyPrinting”格式化json的格式，代码如下：

User user = new User("王宇", 25, DateUtil.parse("1998-10-12 13:25:22"), '男', 180.0f, 71.55, new BigDecimal("2104.5"), true);
    System.out.println("toString方法：" + user);
    
    Gson gson = new GsonBuilder()
        .serializeNulls()
        .setDateFormat("yyyy年MM月dd日 HH:mm:ss")
        .setPrettyPrinting()
        .create();
    
    String gsonStr1 = gson.toJson(user);
    System.out.println("gsonStr1：" + gsonStr1);

运行结果如下：

![在这里插入图片描述][dff29a9a47bf44838a2a1acaa5dbff3e.png]

## 三、将Json转换为Java实体 ##

### 1、先拿到测试Json ###

拿到测试用的Java实体转化为Json，格式化后如下：

{
        
    	"adult": true,
    	"adultDesc": null,
    	"age": 25,
    	"ageDesc": null,
    	"birthday": 908169922000,
    	"birthdayDesc": null,
    	"height": 180.0,
    	"heightDesc": null,
    	"money": 2104.5,
    	"moneyDesc": null,
    	"name": "王宇",
    	"nameDesc": null,
    	"sex": "男",
    	"sexDesc": "\u0000",
    	"weight": 71.55,
    	"weightDesc": null
    }

### 2、基于com.alibaba.fastjson.JSON ###

使用JSON的parseObject(String text, Class clazz)方法可以直接将Json字符转化为对应clazz的Java实体，代码如下：

运行结果如下：

![在这里插入图片描述][3b07f55bda124344b7a8d9eec2abbcb9.png]

### 3、基于com.alibaba.fastjson.JSONObject ###

JSONObject中转化Java实体的方法parseObject也是来自JSON，并且没有重写，效果是一样的，代码如下：

运行结果如下：

![在这里插入图片描述][1926ae6079fa4297b3929a17117a75e4.png]

### 4、基于com.fasterxml.jackson.databind.ObjectMapper的readValue方法 ###

需要先实例化ObjectMapper，再调用readValue方法，代码如下：

String userJson = "{\"adult\":true,\"adultDesc\":null,\"age\":25,\"ageDesc\":null,\"birthday\":908169922000,\"birthdayDesc\":null,\"height\":180.0,\"heightDesc\":null,\"money\":2104.5,\"moneyDesc\":null,\"name\":\"王宇\",\"nameDesc\":null,\"sex\":\"男\",\"sexDesc\":\"\\u0000\",\"weight\":71.55,\"weightDesc\":null}";
    System.out.println("userJson：" + userJson);
    
    ObjectMapper objectMapper = new ObjectMapper();
    try {
        
        User user = objectMapper.readValue(userJson, User.class);
        System.out.println("user：" + user);
    } catch (JsonProcessingException e) {
        
        e.printStackTrace();
    }

运行结果如下：

![在这里插入图片描述][3cb4694d78d240408b6aa6e1ad7c6c1d.png]

### 5、基于com.google.gson.Gson ###

Gson实例化后，使用fromJson方法将Json转化为Java实体，代码如下：

运行结果如下：  
![在这里插入图片描述][8e6c4d86684a4b6280d1aa86de1aca03.png]  
可以看到时间戳转Date类型报错了。

需要使用GsonBuilder进行实例化，在适配一下Date类型的字段。代码如下：

String userJson = "{\"adult\":true,\"adultDesc\":null,\"age\":25,\"ageDesc\":null,\"birthday\":908169922000,\"birthdayDesc\":null,\"height\":180.0,\"heightDesc\":null,\"money\":2104.5,\"moneyDesc\":null,\"name\":\"王宇\",\"nameDesc\":null,\"sex\":\"男\",\"sexDesc\":\"\\u0000\",\"weight\":71.55,\"weightDesc\":null}";
    System.out.println("userJson：" + userJson);
    
    Gson gson = new GsonBuilder()
            .registerTypeAdapter(Date.class, new JsonDeserializer<Date>() {
        
                @Override
                public Date deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
        
                    return new Date(json.getAsJsonPrimitive().getAsLong());
                }
            })
            .create();
    User user = gson.fromJson(userJson, User.class);
    System.out.println("user：" + user);

再次运行：

![在这里插入图片描述][1de4bbd24a224b62a49f74431f35d644.png]

[9db0894033fe424caed7de28cd26eddb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/268dbf17637c4f1f945a8fa79c3193f9.png
[3ef9330294fe42f7afe97f3627b74222.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/ff7fca9f2e124428b4707be6932f6875.png
[2d9064feb065494887cf8576d5977705.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/712159f0155d429983b7a12e1a359a6c.png
[86bfbc5c236a4eb6b8d5af97c95a0ca4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/f14ae7511bd34d89a59b9db3c9f543ba.png
[9695e66e9aea49df8e8948ad2bd21267.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/3b1b369520c747f68d48e167e0dd887c.png
[c143fbdf9e534d86a9e47c1306c8de71.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/be514b5039f54a008463044bd855df8d.png
[96d55f340467403da15c73f764ebe83c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/5f760dd94a1147ff83a4cd5586babd6a.png
[5bcad8e2b3a547af8c3505338de9e0e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/590b9e6d6b5949ab8576477e3d2d8fd6.png
[f047abb91dc44ac1b0ee22ce47795b2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/6d2908b4e3da47459d94d4c94a393261.png
[604fb92c6d1d4db297da3858eba615b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/d68f5c4f411f4665af07579f8f8cb031.png
[6262fc311fe64475a3a7aacbc94f9037.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/965ff32a75f1462c8ee816803977015d.png
[40a0796045144ef4afbabf57f9e568ce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/5f07ec7c8a684bc38fecf8d4ee344b7b.png
[aab84f19c605418484549e2a7a4edff0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/81110c82e7bb47f8979a71e8a7a3b384.png
[fd11757687424ebba125b89052512b63.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/785fb4da3963444dbfbb11e4d5063dc9.png
[33a38c3ba90b4d2898eaf82cdc075596.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/f5833666d2f241ca992bfe7481d35c7a.png
[df5d21db81334b77af872425f3b31773.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/910c3688b821455793f3f4b1c72786f3.png
[ee134064a17849a186c4c32aa18c88da.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/4b6f67112f0148f1bbe82afc491b9ea1.png
[dff29a9a47bf44838a2a1acaa5dbff3e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/60c50a53769f4aba817e099ef76bacb0.png
[3b07f55bda124344b7a8d9eec2abbcb9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/226fb7bed0ed4e50b2aad1a3699c6932.png
[1926ae6079fa4297b3929a17117a75e4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/d6fbbbd850e845be9ad80c60fee3a473.png
[3cb4694d78d240408b6aa6e1ad7c6c1d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/ed867f8f434d4b07a2c567c2b1e8ec18.png
[8e6c4d86684a4b6280d1aa86de1aca03.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/824feffdc34a4f56b6b3983d4ac4d19c.png
[1de4bbd24a224b62a49f74431f35d644.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/8322db5c6d1142709e8c479342fdb9b2.png