Unity5.3 JSON的序列化

http://kou-yeung.hatenablog.com/entry/2015/12/31/014611

Unity5.3 から JsonUtility 追加された。

が、List と Dictionary はシリアライズできません！

シリアライズ対象になるには以下の条件がある

1.クラスに [Serializable] 属性
2.privateメンバー変数に[SerializeField] の属性
3.publicメンバー変数にする

もちろんですが、List と Dictionary は以上の条件に満たしていない

例として以下のクラスを使用します

using UnityEngine;
using System;
using System.Collections.Generic;

[Serializable]
public class Enemy
{
[SerializeField]
string name;
[SerializeField]
List<string> skills;

public Enemy(string name, List<string> skills)
{
this.name = name;
this.skills = skills;
}
}

実際にシリアライズしてみる

var enemies = new List<Enemy>();
enemies.Add(new Enemy("スライム", new List<string>() { "攻撃" }));
enemies.Add(new Enemy("キングスライム", new List<string>() { "攻撃", "回復" }));
Debug.Log(JsonUtility.ToJson(enemies));
// 出力 : {}

何もないJson文字列に出力された。

Unityの公式サイトでは ISerializationCallbackReceiver を継承する方法を提示されたが、

もう少し抽象化したいので・・・

書いてみた

// Serialization.cs
using UnityEngine;
using System.Collections;
using System.Collections.Generic;
using System;

// List<T>
[Serializable]
public class Serialization<T>
{
[SerializeField]
List<T> target;
public List<T> ToList() { return target; }

public Serialization(List<T> target)
{
this.target = target;
}
}

// Dictionary<TKey, TValue>
[Serializable]
public class Serialization<TKey, TValue> : ISerializationCallbackReceiver
{
[SerializeField]
List<TKey> keys;
[SerializeField]
List<TValue> values;

Dictionary<TKey, TValue> target;
public Dictionary<TKey, TValue> ToDictionary() { return target; }

public Serialization(Dictionary<TKey, TValue> target)
{
this.target = target;
}

public void OnBeforeSerialize()
{
keys = new List<TKey>(target.Keys);
values = new List<TValue>(target.Values);
}

public void OnAfterDeserialize()
{
var count = Math.Min(keys.Count, values.Count);
target = new Dictionary<TKey, TValue>(count);
for (var i = 0; i < count; ++i)
{
target.Add(keys[i], values[i]);
}
}
}

使い方

// List<T> -> Json文字列 ( 例 : List<Enemy> )
string str = JsonUtility.ToJson(new Serialization<Enemy>(enemies)); // 出力例 : {"target":[{"name":"スライム","skills":["攻撃"]},{"name":"キングスライム","skills":["攻撃","回復"]}]}
// Json文字列 -> List<T>
List<Enemy> enemies = JsonUtility.FromJson<Serialization<Enemy>>(str).ToList();

// Dictionary<TKey,TValue> -> Json文字列 ( 例 : Dictionary<int, Enemy> )
string str = JsonUtility.ToJson(new Serialization<int, Enemy>(enemies)); // 出力例 : {"keys":[1000,2000],"values":[{"name":"スライム","skills":["攻撃"]},{"name":"キングスライム","skills":["攻撃","回復"]}]}
// Json文字列 -> Dictionary<TKey,TValue>
Dictionary<int, Enemy> enemies = JsonUtility.FromJson<Serialization<int, Enemy>>(str).ToDictionary();

おまけに BitArrayも書いてみることにした

// BitArray
[Serializable]
public class SerializationBitArray : ISerializationCallbackReceiver
{
[SerializeField]
string flags;

BitArray target;
public BitArray ToBitArray() { return target; }

public SerializationBitArray(BitArray target)
{
this.target = target;
}

public void OnBeforeSerialize()
{
var ss = new System.Text.StringBuilder(target.Length);
for(var i = 0 ; i < target.Length ; ++i)
{
ss.Insert(0, target[i]?'1':'0');
}
flags = ss.ToString();
}

public void OnAfterDeserialize()
{
target = new BitArray(flags.Length);
for (var i = 0; i < flags.Length; ++i)
{
target.Set(flags.Length - i - 1, flags[i] == '1');
}
}
}

使い方

BitArray bits = new BitArray(4);
bits.Set(1, true);

// BitArray -> Json文字列
var str = JsonUtility.ToJson(new SerializationBitArray(bits)); // 出力例 : {"flags":"0010"}
// Json文字列 -> BitArray
BitArray bits = JsonUtility.FromJson<SerializationBitArray>(s).ToBitArray();

ソースコード