Wbudowany sposób pracy z JSON w kodzie Unity

JSON (JavaScript Object Notation) to powszechnie używany format wymiany danych, a zintegrowanie go z Unity może okazać się przydatne w obsłudze konfiguracji, zapisywaniu postępu gry lub wymianie danych z usługami zewnętrznymi. Ten przewodnik przeprowadzi Cię przez podstawy pracy z JSON w Unity.

Krok 1: Zrozumienie JSON

JSON składa się z par klucz-wartość i struktur zagnieżdżonych.

Krok 2: Praca z JSON w kodzie Unity

Unity upraszcza serializację i deserializację JSON poprzez klasę 'JsonUtility'. Ten przewodnik przedstawia podstawowe kroki pracy z JSON w Unity bez zewnętrznych bibliotek.

• Utwórz strukturę JSON:

{
  "playerName": "John Doe",
  "playerLevel": 5,
  "inventory": ["sword", "shield"]
}

• Serializacja - Konwersja obiektu C# na JSON:

using UnityEngine;

[System.Serializable]
public class PlayerData
{
    public string playerName;
    public int playerLevel;
    public string[] inventory;
}

public class SerializationExample : MonoBehaviour
{
    void Start()
    {
        PlayerData playerData = new PlayerData
        {
            playerName = "John Doe",
            playerLevel = 5,
            inventory = new string[] { "sword", "shield" }
        };

        string json = JsonUtility.ToJson(playerData);
        Debug.Log(json);
    }
}

• Deserializacja - Konwersja JSON na obiekt C#:

using UnityEngine;

[System.Serializable]
public class PlayerData
{
    public string playerName;
    public int playerLevel;
    public string[] inventory;
}

public class DeserializationExample : MonoBehaviour
{
    void Start()
    {
        string jsonData = "{\"playerName\":\"John Doe\",\"playerLevel\":5,\"inventory\":[\"sword\",\"shield\"]}";
        PlayerData playerData = JsonUtility.FromJson<PlayerData>(jsonData);

        Debug.Log($"Name: {playerData.playerName}, Level: {playerData.playerLevel}");
        Debug.Log("Inventory: " + string.Join(", ", playerData.inventory));
    }
}

Znane ograniczenia

'JsonUtility' nie obsługuje bezpośrednio serializacji i deserializacji tablic obiektów najwyższego poziomu (np. '[{},{},{}]') bez klasy opakowującej. Aby obejść ten problem, możesz użyć klasy pomocniczej do zawinięcia tablicy. Oto przykład:

using UnityEngine;

[System.Serializable]
public class PlayerData
{
    public string playerName;
    public int playerLevel;
}

[System.Serializable]
public class PlayerDataArrayWrapper
{
    public PlayerData[] players;
}

public class TopLevelArrayExample : MonoBehaviour
{
    void Start()
    {
        // Serialization: Converting C# Object Array to JSON
        PlayerData[] players = new PlayerData[]
        {
            new PlayerData { playerName = "John Doe", playerLevel = 5 },
            new PlayerData { playerName = "Jane Smith", playerLevel = 8 }
        };

        PlayerDataArrayWrapper wrapper = new PlayerDataArrayWrapper { players = players };
        string json = JsonUtility.ToJson(wrapper);
        Debug.Log(json);

        // Deserialization: Converting JSON to C# Object Array
        string jsonData = "{\"players\":[{\"playerName\":\"John Doe\",\"playerLevel\":5},{\"playerName\":\"Jane Smith\",\"playerLevel\":8}]}";
        PlayerDataArrayWrapper deserializedData = JsonUtility.FromJson<PlayerDataArrayWrapper>(jsonData);

        foreach (var player in deserializedData.players)
        {
            Debug.Log($"Name: {player.playerName}, Level: {player.playerLevel}");
        }
    }
}

W powyższym przykładzie klasa 'PlayerDataArrayWrapper' służy do zawijania tablicy podczas serializacji i deserializacji. Powszechną praktyką jest tworzenie takich klas opakowań, gdy mamy do czynienia z tablicami obiektów najwyższego poziomu w 'JsonUtility'.

Wniosek

'JsonUtility' upraszcza serializację i deserializację JSON bezpośrednio, bez zewnętrznych bibliotek. Użyj tego natywnego podejścia do prostych operacji JSON w projektach Unity.