FastJsonのガイド
1. 概要
FastJsonは、JSON文字列をJavaオブジェクトに、またはその逆に効果的に変換するために使用される軽量のJavaライブラリです。
この記事では、FastJsonライブラリのいくつかの具体的で実用的なアプリケーションについて詳しく説明します。
2. Mavenの構成
FastJsonの使用を開始するには、まずそれをpom.xmlに追加する必要があります。
com.alibaba
fastjson
1.2.13
簡単に言うと、Maven Centralのライブラリのhere’s the most updated versionです。
3. JavaオブジェクトをJSON形式に変換する
次のPerson JavaBeanを定義しましょう。
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、日付formatting、または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 Beanを完全にシリアル化しますが、パラメータ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()を使用して、JSON文字列からJavaオブジェクトを取得できます。
独自のパラメーター化されたものを既に宣言している場合は、no-args or default constructorを定義する必要があることに注意してください。そうしないと、com.alibaba.fastjson.JSONExceptionがスローされます。
この簡単なテストの出力は次のとおりです。
Person [age=20, fullName=John Doe, dateOfBirth=Wed Jul 20 08:51:12 WEST 2016]
@JSONFieldアノテーション内でオプションdeserializeを使用することにより、特定のフィールドの逆シリアル化を無視できます。この場合、デフォルト値が無視されたフィールドに自動的に適用されます。
@JSONField(name = "DATE OF BIRTH", deserialize=false)
private Date dateOfBirth;
そして、これが新しく作成されたオブジェクトです。
Person [age=20, fullName=John Doe, dateOfBirth=null]
6. ContextValueFilterを使用してJSON変換を構成する
シナリオによっては、JavaオブジェクトからJSON形式への変換プロセスでmore controlが必要になる場合があります。
この場合、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操作をカスタマイズするための一連のツールを提供します。
この記事で最初に宣言されたPerson Java Beanのコンパイル済みバージョンがあり、フィールドの命名と基本的なフォーマットを強化する必要があると想像してみてください。
@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");
}
NameFilter匿名クラスを使用してフィールド名を処理するformatNameフィルターを宣言しました。 新しく作成されたフィルターはPersonクラスに関連付けられてから、グローバルインスタンスに追加されます。これは基本的にSerializeConfigクラスの静的属性です。
この記事の前半で示したように、オブジェクトを簡単にJSON形式に変換できます。
日付フィールドに同じフォーマットルールをすばやく適用するために、toJSONString()の代わりにtoJSONStringWithDateFormat()を使用していることに注意してください。
出力は次のとおりです。
[
{
"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 BeanをJSON文字列に変換する方法と、その逆の方法を示しました。 また、JSON出力をカスタマイズするためにいくつかのcore features of FastJsonを使用する方法も示しました。
ご覧のとおり、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で確認できます。