FastJson中JSONString与各个对象的的转换关系及API示例

冷不防 2023-06-19 02:59 6阅读 0赞

# 前言 #

`JSON`作为一种轻量级的数据交换格式，在我们日常的开发中使用十分广泛，就Java后端的开发工作中，JSON字符串与Java对象之间相互转换是常常遇到的操作。

虽然平时用到的挺多的，但是因为用于JSON处理的包有很多种，每种工具集的功能和使用方式也都不同，很容易在使用时造成混乱。

> 本文就结合`FastJson`部分源码，简单整理了下`常用的API及其使用示例`

本文FastJson版本：[1.2.54][]

# 转换图 #

根据FastJson源码大致整理出了这么一张转换图：

![format_png][]

可以看到参与转换的对象主要有图中五种：

1.  **JSONString**：`json字符串`
2.  **JSONObject**：`json对象`
3.  **JSONArray**：`json对象数组`
4.  **JavaBean**：`java对象`
5.  **List**：`java对象集合`

转化中用到的方法的方法名有如下几种：

*  **parse**: `JSONString ==> JSONObject/JSONArray`
 *  **parseObject**: `JSONString ==> JSONObject/JavaBean`
 *  **pareseArray**: `JSONString ==> JSONObject/List`
 *  **toJSONString**: `JavaBean/JSONObject ==> JSONString`
 *  **toJSON**: `JavaBean ==> JSONObject`
 *  **toJavaObject**:`JSONObject ==> JavaBean`

# 常用API #

> 本文种仅列举`平常使用频率较高`的API，其他的重载方法可参考`源码`，大都是对序列化/反序列化过程进行定制化。

## toJSONString ##

> 实现了json对象(`JSONObject`)==>json字符串(`JSONString`)，和Java对象(`JavaBean`)==>json字符串(`JSONString`)的转化

![format_png 1][]

从源码中可以看到这一方法被重载了多个，我们日常会用到的有如下几个：

<table> 
 <tbody> 
  <tr> 
   <th>方法 : 返回值</th> 
   <th>参数说明</th> 
   <th>功能</th> 
  </tr> 
  <tr> 
   <td>toJSONString(Object object):String</td> 
   <td><code>object</code>: 需要进行序列化的对象javaBean或者JSONObject</td> 
   <td>将对象序列化为json字符串</td> 
  </tr> 
  <tr> 
   <td>toJSONString(Object object, boolean prettyFormat):String</td> 
   <td><code>prettyFormat</code>：是否格式化输出json字符串</td> 
   <td>格式化输出json字符串</td> 
  </tr> 
  <tr> 
   <td>toJSONString(Object object, SerializerFeature... features):String</td> 
   <td><code>features</code>：序列化额外属性配置，非必填</td> 
   <td>根据指定属性进行序列化</td> 
  </tr> 
  <tr> 
   <td>toJSONStringWithDateFormat(Object object, String dateFormat, SerializerFeature... features):String</td> 
   <td><code>dateFormat</code>：日期格式(<code>yyyy-MM-dd</code>)</td> 
   <td>序列化时格式化日期</td> 
  </tr> 
 </tbody> 
</table>

这些方法中最常用的即为：`toJSONString(Object object)`

## parse ##

> 实现了json字符串(`JSONString`)==>json对象(`JSONObject`)，和json字符串(`JSONString`)==>json对象数组(`JSONArray`)的转化

![format_png 2][]

<table> 
 <tbody> 
  <tr> 
   <th>方法 : 返回值</th> 
   <th>参数说明</th> 
   <th>功能</th> 
  </tr> 
  <tr> 
   <td>parse(String text):Object</td> 
   <td><code>text</code>：json字符串</td> 
   <td>反序列化json字符串</td> 
  </tr> 
 </tbody> 
</table>

## parseObject ##

> 实现了json字符串(`JSONString`)==>json对象(`JSONObject`)，和json字符串(`JSONString`)==>Java对象(`JavaBean`)的转化

![format_png 3][]

<table> 
 <tbody> 
  <tr> 
   <th>方法 : 返回值</th> 
   <th>参数说明</th> 
   <th>功能</th> 
  </tr> 
  <tr> 
   <td>parseObject(String text):JSONObject</td> 
   <td><code>text</code>:json字符串</td> 
   <td>反序列化json字符串为Json对象</td> 
  </tr> 
  <tr> 
   <td>parseObject(String text, Class&nbsp;clazz):T</td> 
   <td><code>clazz</code>:指定反序列化后的类</td> 
   <td>json字符串转java对象</td> 
  </tr> 
  <tr> 
   <td>parseObject(String text, TypeReference&nbsp;type, Feature... features):T</td> 
   <td><code>type</code>:构造转化类型，<code>features</code>:反序列化额外属性</td> 
   <td>json字符串转java对象</td> 
  </tr> 
 </tbody> 
</table>

## parseArray ##

> 实现了json字符串(`JSONString`)==>json对象数组(`JSONArray)，和json字符串(`JSONString`)==>Java对象集合(`List\`)的转化

![format_png 4][]

<table> 
 <tbody> 
  <tr> 
   <th>方法 : 返回值</th> 
   <th>参数说明</th> 
   <th>功能</th> 
  </tr> 
  <tr> 
   <td>parseArray(String text) :JSONArray</td> 
   <td><code>text</code>:json字符串</td> 
   <td>将json字符串反序列化为JSON数组对象</td> 
  </tr> 
  <tr> 
   <td>parseArray(String text, Class&nbsp;clazz):List</td> 
   <td><code>clazz</code>:指定转化后的类</td> 
   <td>将json字符串反序列化为java对象集合</td> 
  </tr> 
 </tbody> 
</table>

## toJSON/toJavaObject ##

![format_png 5][]

> toJSON()实现了Java对象(`JavaBean`)==>Json对象(`JSONObject`)的转换
> 
> toJavaObject()实现了Json对象(`JSONObject`)==>Java对象(`JavaBean`)的转换

<table> 
 <tbody> 
  <tr> 
   <th>方法 : 返回值</th> 
   <th>参数说明</th> 
   <th>功能</th> 
  </tr> 
  <tr> 
   <td>toJSON(Object javaObject):Object</td> 
   <td><code>javaObject</code>：java对象</td> 
   <td>java对象转化为Json对象</td> 
  </tr> 
  <tr> 
   <td>toJavaObject(JSON json, Class&nbsp;clazz):T</td> 
   <td><code>json</code>:json对象，<code>clazz</code>：要转化的类型</td> 
   <td>json对象转化为java对象</td> 
  </tr> 
 </tbody> 
</table>

# 代码示例 #

Student学生类

package com.larscheng.www.jsontest;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import java.util.Date;
    
    /**
     * 描述:
     * 学生类
     *
     * @author larscheng
     * @date 2019/11/19 19:33
     */
    @Data
    @AllArgsConstructor
    public class Student {
    
        private String name;
        private int age;
        private Date birthday;
    }

测试类FastJsonTest.java代码如下：

package com.larscheng.www.jsontest.fastJson;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONArray;
    import com.alibaba.fastjson.JSONObject;
    import com.alibaba.fastjson.TypeReference;
    import com.alibaba.fastjson.serializer.SerializerFeature;
    import com.larscheng.www.jsontest.Course;
    import com.larscheng.www.jsontest.Student;
    
    import java.util.Arrays;
    import java.util.Date;
    import java.util.List;
    
    /**
     * 描述:
     * fastJson的api示例
     *
     * @author larscheng
     * @date 2019/11/19 19:37
     */
    public class FastJsonTest {
    
        private final static Student LIMING = new Student("liming", 20, new Date());
        private final static String LIMING_STR = 
            "{'age':20,'birthday':1574163958480,'name':'liming'}";
        private final static Course MATH = new Course("数学课", "高等代数");
        private final static Course CHINESE = new Course("语文课", "大学语文");
        private final static List<Course> COURSES = Arrays.asList(MATH, CHINESE);
        private final static String COURSES_STR = 
            "[{'desc':'高等代数','name':'数学课'},{'desc':'大学语文','name':'语文课'}]";
        private final static JSONObject LIMING_MAP = new JSONObject();
            static {
                LIMING_MAP.put("name", "liming");
                LIMING_MAP.put("age", 20);
                LIMING_MAP.put("birthday", new Date());
            }
    
        public static void main(String[] args) {
            //############ toJSONString ###############
            /*JavaBean--->JSONString*/
            System.err.println("JavaBean--->JSONString(默认无格式):");
            System.out.println(JSON.toJSONString(LIMING));
            System.err.println("JavaBean--->JSONString(带格式):");
            System.out.println(JSON.toJSONString(LIMING, true));
            System.err.println("JavaBean--->JSONString(日期格式化):");
            System.out.println(JSON.toJSONStringWithDateFormat(LIMING, "yyyy-MM-dd")   "\n");
    
            /*JSONObject--->JSONString*/
            System.err.println("JSONObject--->JSONString(带格式):");
            System.out.println(JSON.toJSONString(LIMING_MAP, true)   "\n");
    
            /*List<JavaBean>--->JSONString*/
            System.err.println("List<JavaBean>--->JSONString(默认双引号):");
            System.out.println(JSON.toJSONString(COURSES));
            System.err.println("List<JavaBean>--->JSONString(单引号):");
            System.out.println(JSON.toJSONString(COURSES, SerializerFeature.UseSingleQuotes));
            System.err.println("List<JavaBean>--->JSONString(单引号 带格式):");
            System.out.println(JSON.toJSONString(COURSES, SerializerFeature.UseSingleQuotes,SerializerFeature.PrettyFormat)   "\n");
    
            //########## parse/parseObject ###################
            /*JSONString--->JSONObject*/
            System.err.println("JSONString--->JSONObject(parse):");
            JSONObject jsonObject1 = (JSONObject) JSON.parse(LIMING_STR);
            System.out.println(jsonObject1.toString());
            System.err.println("JSONString--->JSONObject(parseObject):");
            System.out.println(JSON.parseObject(LIMING_STR).toString()   "\n");
    
    
            System.err.println("JSONString--->JavaBean:");
            Student student1 = JSON.parseObject(LIMING_STR,Student.class);
            System.out.println(student1.hashCode() "\t" student1.toString());
            System.err.println("JSONString--->JavaBean:");
            Student student2 = JSON.parseObject(LIMING_STR,new TypeReference<Student>(){});
            System.out.println(student2.hashCode() "\t" student2.toString());
    
            //########### parse/parseArray ################
    
            /*JSONString--->JSONArray*/
            System.err.println("JSONString--->JSONArray(parse):");
            JSONArray jsonArray1 = (JSONArray) JSON.parse(COURSES_STR);
            System.out.println(jsonArray1.toString());
            System.err.println("JSONString--->JSONArray(parseArray):");
            System.out.println(JSON.parseArray(COURSES_STR).toString());
    
            System.err.println("JSONString--->List<JavaBean>:");
            List<Course> courses1 = JSON.parseArray(COURSES_STR,Course.class);
            System.out.println(courses1.hashCode() "\t" courses1.toString() "\n");
    
    
            //######### toJSON/toJavaObject ################
            System.err.println("JavaBean--->JSONObject:");
            System.out.println(JSON.toJSON(LIMING));
    
            System.err.println("JSONObject--->JavaBean:");
            System.out.println(JSON.toJavaObject(LIMING_MAP,Student.class));
            System.out.println(LIMING_MAP.toJavaObject(Student.class));
            System.out.println((Student)LIMING_MAP.toJavaObject(new TypeReference<Student>(){}));
            System.out.println(LIMING_MAP.toJavaObject(new TypeReference<Student>(){}.getType()) "\n");
        }
    
    }

# 总结 #

基本常用的方法都进行了代码测试，使用过程中可能会出现混淆的情况，但是只要记住了文中的转换图，相信应该会加深印象。

[1.2.54]: https://blog.csdn.net/qq_33619378/article/details/103200524
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4uanNkZWxpdnIubmV0L2doL2xhcnNjaGVuZy9teUltZy9ibG9nSW1nL2Zhc3RKc29uLzIwMTkxMTIwMTM1MjUwLnBuZw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4uanNkZWxpdnIubmV0L2doL2xhcnNjaGVuZy9teUltZy9ibG9nSW1nL2Zhc3RKc29uLzIwMTkxMTIwMTUxOTQ5LnBuZw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4uanNkZWxpdnIubmV0L2doL2xhcnNjaGVuZy9teUltZy9ibG9nSW1nL2Zhc3RKc29uLzIwMTkxMTIwMTUxMDMzLnBuZw?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4uanNkZWxpdnIubmV0L2doL2xhcnNjaGVuZy9teUltZy9ibG9nSW1nL2Zhc3RKc29uLzIwMTkxMTIwMTUyMTQzLnBuZw?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4uanNkZWxpdnIubmV0L2doL2xhcnNjaGVuZy9teUltZy9ibG9nSW1nL2Zhc3RKc29uLzIwMTkxMTIwMTYwMTAxLnBuZw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4uanNkZWxpdnIubmV0L2doL2xhcnNjaGVuZy9teUltZy9ibG9nSW1nL2Zhc3RKc29uLzIwMTkxMTIwMTcxNDUxLnBuZw?x-oss-process=image/format,png