Fastjson使用

最新推荐文章于 2024-08-23 14:25:00 发布

jsxllht

最新推荐文章于 2024-08-23 14:25:00 发布

阅读量336

点赞数 1

文章标签： java json spring

本文链接：https://blog.csdn.net/weixin_56219549/article/details/121793100

版权

Fastjson 简介

Fastjson 是一个 Java 库，可以将 Java 对象转换为 JSON 格式，当然它也可以将 JSON 字符串转换为 Java 对象。

Fastjson 可以操作任何 Java 对象，即使是一些预先存在的没有源码的对象。

Fastjson 源码地址：https://github.com/alibaba/fastjson.

Fastjson 中文 Wiki：https://github.com/alibaba/fastjson/wiki/Quick-Start-CN.

Fastjson 特性

提供服务器端、安卓客户端两种解析工具，性能表现较好。
提供了 toJSONString() 和 parseObject() 方法来将 Java 对象与 JSON 相互转换。调用toJSONString方法即可将对象转换成 JSON 字符串，parseObject 方法则反过来将 JSON 字符串转换成对象。
允许转换预先存在的无法修改的对象（只有class、无源代码）。
Java泛型的广泛支持。
允许对象的自定义表示、允许自定义序列化类。
支持任意复杂对象（具有深厚的继承层次和广泛使用的泛型类型）。

使用

pom依赖

    <dependencies>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.49</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.16</version>
            <scope>compile</scope>
        </dependency>

实体类

@Data
@AllArgsConstructor
public class Person {
    // @JSONField 注解，以便实现自定义转换：
    @JSONField(name="AGE", serialize=false)//默认情况下， FastJson 库可以序列化 Java bean 实体， 但我们可以使用 serialize 指定字段不序列化。
    private int age;

    @JSONField(name="LAST NAME", ordinal = 2)
    private String lastName;

    @JSONField(name="FIRST NAME", ordinal = 1)//使用 ordinal 参数指定字段的顺序
    private String firstName;

    @JSONField(name="DATE OF BIRTH", format="dd/MM/yyyy", ordinal = 3)//format 参数用于格式化 date 属性。
    private Date dateOfBirth;
}

测试

public class TestFastJson {
    private List<Person> listOfPersons = new ArrayList<Person>();

    @Before
    public void setUp() {
        listOfPersons.add(new Person(15, "John" ,"Doe", new Date()));
        listOfPersons.add(new Person(20, "Janette","Doe", new Date()));
    }

    @Test
    public void whenJavaList_thanConvertToJsonCorrect() {
//        String jsonOutput= JSON.toJSONString(listOfPersons);
//FastJson 还支持 BeanToArray 序列化功能：
        String jsonOutput= JSON.toJSONString(listOfPersons, SerializerFeature.BeanToArray);
        System.out.println(jsonOutput);
    }
}

@JSONField

@JSONField 的作用对象:

Field
Setter 和 Getter 方法
注意：FastJson 在进行操作时，是根据 getter 和 setter 的方法进行的，并不是依据 Field 进行。

注意：若属性是私有的，必须有 set 方法。否则无法反序列化。

public @interface JSONField {
    // 配置序列化和反序列化的顺序，1.1.42版本之后才支持
    int ordinal() default 0;

     // 指定字段的名称
    String name() default "";

    // 指定字段的格式，对日期格式有用
    String format() default "";

    // 是否序列化
    boolean serialize() default true;

    // 是否反序列化
    boolean deserialize() default true;
}

FieldInfo 可以配置在 getter/setter 方法或者字段上。例如：

public class A {
      private int id;
 
      @JSONField(name="ID")
      public int getId() {return id;}
      @JSONField(name="ID")
      public void setId(int value) {this.id = id;}
}

创建 JSON 对象

创建 JSON 对象非常简单，只需使用 JSONObject（fastJson提供的json对象）和 JSONArray（fastJson提供json数组对象）对象即可。

我们可以把JSONObject 当成一个 Map<String,Object> 来看，只是 JSONObject 提供了更为丰富便捷的方法，方便我们对于对象属性的操作。我们看一下源码。
JSONObject implements Map<String, Object>

public class JSONObject extends JSON implements Map<String, Object>, Cloneable, Serializable, InvocationHandler {
    private static final long serialVersionUID = 1L;
    private static final int DEFAULT_INITIAL_CAPACITY = 16;
    private final Map<String, Object> map;

JSONArray implements List<Object>

public class JSONArray extends JSON implements List<Object>, Cloneable, RandomAccess, Serializable {
    private static final long serialVersionUID = 1L;
    private final List<Object> list;
    protected transient Object relatedArray;
    protected transient Type componentType;

此外，由于 JSONObject 和 JSONArray 继承了 JSON，所以说也可以直接使用两者对 JSON 格式字符串与 JSON 对象及 javaBean 之间做转换，不过为了避免混淆我们还是使用 JSON。

 @Test
    public void whenGenerateJson_thanGenerationCorrect() throws ParseException {
        JSONArray jsonArray = new JSONArray();
        for (int i = 0; i < 2; i++) {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("AGE", 10);
            jsonObject.put("FULL NAME", "Doe " + i);
            jsonObject.put("DATE OF BIRTH", "2016/12/12 12:12:12");
            jsonArray.add(jsonObject);
            System.out.println(jsonObject);
            System.out.println(jsonArray);
        }
        String jsonOutput = jsonArray.toJSONString();
        System.out.println(jsonOutput);
    }

结果

{"DATE OF BIRTH":"2016/12/12 12:12:12","FULL NAME":"Doe 0","AGE":10}
[{"DATE OF BIRTH":"2016/12/12 12:12:12","FULL NAME":"Doe 0","AGE":10}]
{"DATE OF BIRTH":"2016/12/12 12:12:12","FULL NAME":"Doe 1","AGE":10}
[{"DATE OF BIRTH":"2016/12/12 12:12:12","FULL NAME":"Doe 0","AGE":10},{"DATE OF BIRTH":"2016/12/12 12:12:12","FULL NAME":"Doe 1","AGE":10}]
[{"DATE OF BIRTH":"2016/12/12 12:12:12","FULL NAME":"Doe 0","AGE":10},{"DATE OF BIRTH":"2016/12/12 12:12:12","FULL NAME":"Doe 1","AGE":10}]

JSON 字符串转换为 Java 对象

实体类加

@AllArgsConstructor//加无参构造

    public long getFullName() {
        return lastName.length()+firstName.length();
    }

    @Test
    public void whenJson_thanConvertToObjectCorrect() {
        Person person = new Person(20, "John", "Doe", new Date());
        String jsonObject = JSON.toJSONString(person);
        System.out.println(jsonObject);
        Person newPerson = JSON.parseObject(jsonObject, Person.class);//必须要有无参构造，否则异常
        System.out.println(newPerson);
        assertEquals(newPerson.getAge(), 0); // 如果我们设置序列化为 false
        assertEquals(newPerson.getFullName(), listOfPersons.get(0).getFullName());
    }

@JSONField deserialize 可选项可以指定字段不反序列化。

@JSONField(name = "DATE OF BIRTH", deserialize=false)
private Date dateOfBirth;

结果

{"DATE OF BIRTH":1638951068991,"fullName":7,"FIRST NAME":"Doe","LAST NAME":"John"}
Person(age=0, lastName=John, firstName=Doe, dateOfBirth=null)

使用 ContextValueFilter 配置 JSON 转换

在某些场景下，对Value做过滤，需要获得所属JavaBean的信息，包括类型、字段、方法等。在fastjson-1.2.9中，提供了ContextValueFilter，类似于之前版本提供的ValueFilter，只是多了BeanContext参数可用。

    @Test
    public void givenContextFilter_whenJavaObject_thanJsonCorrect() {
        ContextValueFilter valueFilter = new ContextValueFilter () {
            @Override
            public Object process(
                    BeanContext context, Object object, String name, Object value) {
                if (name.equals("DATE OF BIRTH")) {
                    return "NOT TO DISCLOSE";
                }
                if (value.equals("John")) {
                    return ((String) value).toUpperCase();
                } else {
                    return null;
                }
            }
        };
        String jsonOutput = JSON.toJSONString(listOfPersons, valueFilter);
        System.out.println(jsonOutput);//[{"DATE OF BIRTH":"NOT TO DISCLOSE","LAST NAME":"JOHN"},{"DATE OF BIRTH":"NOT TO DISCLOSE"}]
    }

使用 NameFilter 和 SerializeConfig

NameFilter: 序列化时修改 Key。

SerializeConfig：内部是个map容器主要功能是配置并记录每种Java类型对应的序列化类。

    @Test
    public void givenSerializeConfig_whenJavaObject_thanJsonCorrect() {
        NameFilter formatName = new NameFilter() {
            public String process(Object object, String name, Object value) {
                return name.toLowerCase().replace(" ", "_");
            }
        };

        SerializeConfig.getGlobalInstance().addFilter(Person.class,  formatName);
        String jsonOutput =
                JSON.toJSONStringWithDateFormat(listOfPersons, "yyyy-MM-dd");
        System.out.println(listOfPersons);
        System.out.println(jsonOutput);
    }

实例中我们声明了 formatName 过滤器使用 NameFilter 匿名类来处理字段名称。新创建的过滤器与 Person 类相关联，然后添加到全局实例，它是 SerializeConfig 类中的静态属性。

现在我们可以轻松地将对象转换为JSON格式。

注意我们使用的是 toJSONStringWithDateFormat() 而不是 toJSONString() ，它可以更快速的格式化日期。
输出结果：

[Person(age=15, lastName=John, firstName=Doe, dateOfBirth=Wed Dec 08 16:19:36 CST 2021), Person(age=20, lastName=Janette, firstName=Doe, dateOfBirth=Wed Dec 08 16:19:36 CST 2021)]
[{"date_of_birth":"2021-12-08","fullname":7,"first_name":"Doe","last_name":"John"},{"date_of_birth":"2021-12-08","fullname":10,"first_name":"Doe","last_name":"Janette"}]