JsonUtility

유니티 5.3 이상부터 JsonUtility를 지원한다. 외부 JSON 라이브러리가 필요 없다.

< JsonUtility 멤버 함수 >
  1. FromJson : JSON을 오브젝트로 변환한다. 오브젝트를 생성한다.
  2. FromJsonOverwrite : JSON을 오브젝트로 변환한다. 오브젝트를 생성하지 않고 값을 변경한다.
  3. ToJson : 오브젝트의 public 필드를 JSON으로 변환한다.
< JsonUtility 직렬화 >
  1. 클래스 [Serializable] 속성
  2. private 멤버 변수에 [SerializeField]의 특성
  3. public 멤버 변수

1. 기본 사용법

Enemy에서는 public을 사용하지 않고 SerializeField를 이용했다.
코드가 복잡하지 않기 때문에 자세한 설명은 생략한다.

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

//Test
string jsonStr = JsonUtility.ToJson(new Enemy("오거", new List<string>() { "물리공격", "마법" }));
Debug.Log(jsonStr);

Enemy enemy0 = JsonUtility.FromJson<Enemy>(jsonStr);

Enemy enemy1 = new Enemy("empty", new List<string>() { });
JsonUtility.FromJsonOverwrite(jsonStr, enemy1);

결과)
jsonStr의 출력 결과는 다음과 같다.
 {"name":"오거","skills":["물리공격","마법"]}
enemy1 값이 오거, 물리공격, 마법으로 변경된다.

2. List 직렬화

다음과 같이 List를 Json으로 변환하면 빈 문자열만 변환한다.
        var enemies = new List<Enemy>();
        enemies.Add(new Enemy("오거", new List<string>() { "물리공격", "마법" }));
        enemies.Add(new Enemy("트롤", new List<string>() { "공격", "회복", "부활" }));

        string emptyStr = JsonUtility.ToJson(enemies);

List는 별도로 직렬화 시켜 주어야 한다.

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

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

//Test
var enemies = new List<Enemy>();
enemies.Add(new Enemy("오거", new List<string>() { "물리공격", "마법" }));
enemies.Add(new Enemy("트롤", new List<string>() { "공격", "회복", "부활" }));

string str = JsonUtility.ToJson(new Serialization<Enemy>(enemies));
Debug.Log(str);

List<Enemy> retEnemies = JsonUtility.FromJson<Serialization<Enemy>>(str).ToList();

결과)
str의 출력 결과는 다음과 같다.
{"target":[{"name":"오거","skills":["물리공격","마법"]},{"name":"트롤","skills":[" 공격","회복","부활"]}]}
retEnemies에 값을 넣는다.

3. Dictionary 직렬화

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

//Test
var enemies = new Dictionary<int, Enemy>();
enemies.Add(1000, new Enemy("오거", new List<string>() { "물리공격", "마법" }));
enemies.Add(1001, new Enemy("트롤", new List<string>() { "공격", "회복", "부활" }));

string str = JsonUtility.ToJson(new Serialization<int, Enemy>(enemies));
Debug.Log(str);

Dictionary<int, Enemy> retEemies = JsonUtility.FromJson<Serialization<int, Enemy>>(str).ToDictionary();

결과)
str의 출력 결과는 다음과 같다.
{"keys":[1000,1001],"values":[{"name":"오거","skills":["물리공격","마법"]}, {"name":"트롤","skills":["공격","회복","부활"]}]}

ISerializationCallbackReceiver로 직렬화 기능확장

Unity 5.3에서 "UnityEngine.ISerializationCallbackReceiver"가 추가 되었다.
ISerializationCallbackReceiver를 상속하면 직렬화(ToJson)전에 OnBeforeSerialize가 호출되고
역직렬화(FromJson)전에 OnAfterDeserialize가 호출된다.

public  class Character : ISerializationCallbackReceiver
{
    public  void OnBeforeSerialize ()
    {
        Debug.Log ( "OnBeforeSerialize" );
    }

    public  void OnAfterDeserialize ()
    {
        Debug.Log ( "OnAfterDeserialize" );
    }
}

참조)
http://kou-yeung.hatenablog.com/entry/2015/12/31/014611
https://docs.unity3d.com/ScriptReference/JsonUtility.html
https://docs.unity3d.com/ScriptReference/ISerializationCallbackReceiver.html