Руководство по FastJson
1. обзор
FastJson - это легкая библиотека Java, используемая для эффективного преобразования строк JSON в объекты Java и наоборот.
В этой статье мы собираемся погрузиться в несколько конкретных и практических приложений библиотеки FastJson.
2. Конфигурация Maven
Чтобы начать работу с FastJson, нам сначала нужно добавить это в нашpom.xml:
com.alibaba
fastjson
1.2.13
И вкратце -here’s the most updated version библиотеки на 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 listOfPersons = new ArrayList();
@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"
}
]
Мы также можем пойти дальше и начать настраивать вывод и контролировать такие вещи, как флагиordering, dateformatting илиserialization.
Например, давайте обновим bean-компонент и добавим еще пару полей:
@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, чтобы настроить процесс преобразования:
-
Параметрformat используется для правильного форматирования атрибутаdate
-
По умолчанию библиотека FastJson полностью сериализует Java-компонент, но мы можем использовать параметрserialize, чтобы игнорировать сериализацию для определенных полей.
-
Параметрordinal используется для указания порядка полей
И вот новый результат:
[
{
"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 serialization:
String jsonOutput= JSON.toJSONString(listOfPersons, SerializerFeature.BeanToArray);
Вот как будет выглядеть результат в этом случае:
[
[
15,
1469003271063,
"John Doe"
],
[
20,
1469003271063,
"Janette Doe"
]
]
4. Создать объекты JSON
Как иother JSON libraries, создать объект 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.
Обратите внимание, что вы должны определитьno-args or default constructor, если вы уже объявили свой собственный параметризованный, в противном случае будет выброшенcom.alibaba.fastjson.JSONException.
Вот результат этого простого теста:
Person [age=20, fullName=John Doe, dateOfBirth=Wed Jul 20 08:51:12 WEST 2016]
Используя параметрdeserialize внутри аннотации@JSONField, мы можем игнорировать десериализацию для определенного поля, в этом случае значение по умолчанию будет автоматически применяться к игнорируемому полю:
@JSONField(name = "DATE OF BIRTH", deserialize=false)
private Date dateOfBirth;
А вот и вновь созданный объект:
Person [age=20, fullName=John Doe, dateOfBirth=null]
6. Настройте преобразование JSON с помощьюContextValueFilter
В некоторых сценариях нам может потребоватьсяmore control в процессе преобразования из объектов 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);
}
В этом примере мы скрыли полеDATE OF BIRTH, установив постоянное значение, мы также проигнорировали все поля, которые не являются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"
}
]
Как видите -the fields names got changed, и значение даты было правильно отформатировано.
КомбинированиеSerializeFilter сContextValueFilter может дать полный контроль над процессом преобразования для произвольных и сложных объектов Java.
8. Заключение
В этой статье мы показали, как использовать FastJson для преобразования Java-бинов в строки JSON и как наоборот. Мы также показали, как использовать некоторые изcore features of 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.
Вы можете ознакомиться с примерами, приведенными в этой статье, вlinked GitHub project.