Руководство по FastJson

1. Обзор

FastJson — это легкая библиотека Java, используемая для эффективного преобразования строк JSON в объекты Java и наоборот.

В этой статье мы рассмотрим несколько конкретных и практических применений библиотеки FastJson.

2. Конфигурация Maven

Чтобы начать работать с FastJson, нам сначала нужно добавить это в наш pom.xml :

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.13</version>
</dependency>

И в качестве примечания — вот самая обновленная версия библиотеки на Maven Central.

3. Преобразование объектов Java в формат JSON

Давайте определим следующий Java-бин Person :

public class Person {
    
    @JSONField(name = "AGE")
    private int age;

    @JSONField(name = "FULL NAME")
    private String fullName;

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

    public Person(int age, String fullName, Date dateOfBirth) {
        super();
        this.age = age;
        this.fullName= fullName;
        this.dateOfBirth = dateOfBirth;
    }

    // standard getters & setters
}

Мы можем использовать JSON.toJSONString() для преобразования объекта Java в строку JSON:

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);
}

И вот результат:

[  
    {  
        "AGE":15,
        "DATE OF BIRTH":1468962431394,
        "FULL NAME":"John Doe"
    },
    {  
        "AGE":20,
        "DATE OF BIRTH":1468962431394,
        "FULL NAME":"Janette Doe"
    }
]

Мы также можем пойти дальше и начать настраивать вывод и управлять такими вещами, как порядок , форматирование даты или флаги сериализации .

Например — обновим бин и добавим еще пару полей:

@JSONField(name="AGE", serialize=false)
private int age;

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

@JSONField(name="FIRST NAME", ordinal = 1)
private String firstName;

@JSONField(name="DATE OF BIRTH", format="dd/MM/yyyy", ordinal = 3)
private Date dateOfBirth;

Вот список самых основных параметров, которые мы можем использовать вместе с аннотацией @JSONField для настройки процесса преобразования:

• Формат параметра используется для правильного форматирования атрибута даты .
• По умолчанию библиотека FastJson полностью сериализует Java-бин, но мы можем использовать параметр сериализации , чтобы игнорировать сериализацию для определенных полей .
• Порядковый номер параметра используется для указания порядка полей

И вот новый вывод:

[
    {
        "FIRST NAME":"Doe",
        "LAST NAME":"Jhon",
        "DATE OF BIRTH":"19/07/2016"
    },
    {
        "FIRST NAME":"Doe",
        "LAST NAME":"Janette",
        "DATE OF BIRTH":"19/07/2016"
    }
]

FastJson также поддерживает очень интересную функцию сериализации BeanToArray :

String jsonOutput= JSON.toJSONString(listOfPersons, SerializerFeature.BeanToArray);

Вот как будет выглядеть вывод в этом случае:

[
    [
        15,
        1469003271063,
        "John Doe"
    ],
    [
        20,
        1469003271063,
        "Janette Doe"
    ]
]

4. Создайте объекты JSON

Как и другие библиотеки JSON , создать объект JSON с нуля довольно просто, это всего лишь вопрос объединения объектов JSONObject и JSONArray :

@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);
    }
    String jsonOutput = jsonArray.toJSONString();
}

И вот как будет выглядеть вывод здесь:

[
   {
      "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"
   }
]

5. Разберите строки JSON в объекты Java

Теперь, когда мы знаем, как создать объект JSON с нуля и как преобразовать объекты Java в их представления JSON, давайте сосредоточимся на том, как анализировать представление JSON:

@Test
public void whenJson_thanConvertToObjectCorrect() {
    Person person = new Person(20, "John", "Doe", new Date());
    String jsonObject = JSON.toJSONString(person);
    Person newPerson = JSON.parseObject(jsonObject, Person.class);
    
    assertEquals(newPerson.getAge(), 0); // if we set serialize to false
    assertEquals(newPerson.getFullName(), listOfPersons.get(0).getFullName());
}

Мы можем использовать JSON.parseObject() для получения объекта Java из строки JSON.

Обратите внимание, что вы должны определить конструктор без аргументов или конструктор по умолчанию , если вы уже объявили свой собственный параметризованный, иначе будет выдано исключение com.alibaba.fastjson.JSONException .

Вот результат этого простого теста:

Person [age=20, fullName=John Doe, dateOfBirth=Wed Jul 20 08:51:12 WEST 2016]

Используя параметр десериализации внутри аннотации @JSONField , мы можем игнорировать десериализацию для определенного поля, в этом случае значение по умолчанию будет автоматически применяться к игнорируемому полю:

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

И вот только что созданный объект:

Person [age=20, fullName=John Doe, dateOfBirth=null]

6. Настройте преобразование JSON с помощью ContextValueFilter

В некоторых сценариях нам может потребоваться больше контроля над процессом преобразования объектов Java в формат JSON.

В этом случае мы можем использовать объект ContextValueFilter , чтобы применить дополнительную фильтрацию и пользовательскую обработку к потоку конверсии:

@Test
public void givenContextFilter_whenJavaObject_thanJsonCorrect() {
    ContextValueFilter valueFilter = new ContextValueFilter () {
        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);
}

В этом примере мы скрыли поле ДАТА РОЖДЕНИЯ , задав постоянное значение, мы также проигнорировали все поля, которые не являются John или Doe:

[
    {
        "FULL NAME":"JOHN DOE",
        "DATE OF BIRTH":"NOT TO DISCLOSE"
    }
]

Как видите, это довольно простой пример, но вы, конечно, можете использовать те же концепции и для более сложных сценариев, комбинируя этот мощный и легкий набор инструментов, предлагаемых FastJson, в реальном проекте.

7. Использование NameFilter и SerializeConfig

FastJson предлагает набор инструментов для настройки операций JSON при работе с произвольным объектом — объектами, исходного кода которых у нас нет.

Давайте представим, что у нас есть скомпилированная версия Java- бина Person , первоначально объявленная в этой статье, и нам нужно сделать некоторые улучшения в именовании полей и базовом форматировании:

@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");
}

Мы объявили фильтр formatName , используя анонимный класс NameFilter для обработки имен полей. Вновь созданный фильтр связывается с классом Person , а затем добавляется к глобальному экземпляру, который по сути является статическим атрибутом в классе SerializeConfig .

Теперь мы можем легко преобразовать наш объект в формат JSON, как показано ранее в этой статье.

Обратите внимание, что мы использовали toJSONStringWithDateFormat() вместо toJSONString() , чтобы быстро применить то же правило форматирования к полям даты.

И вот результат:

[  
    {  
        "full_name":"John Doe",
        "date_of_birth":"2016-07-21"
    },
    {  
        "full_name":"Janette Doe",
        "date_of_birth":"2016-07-21"
    }
]

Как видите , имена полей изменились , а значение даты отформатировано правильно.

Сочетание SerializeFilter с ContextValueFilter может дать полный контроль над процессом преобразования для произвольных и сложных объектов Java.

8. Заключение

В этой статье мы показали, как использовать FastJson для преобразования Java-бинов в строки JSON и как сделать наоборот. Мы также показали, как использовать некоторые основные функции FastJson для настройки вывода JSON.

Как вы видете, the library offers a relatively simple to use but still very powerful API. JSON.toJSONString and JSON.parseObject are all you need to use in order to meet most of your needs – if not all.

Вы можете ознакомиться с примерами, представленными в этой статье, в связанном проекте GitHub .