Maneira integrada de trabalhar com JSON no Unity Code

JSON (JavaScript Object Notation) é um formato de intercâmbio de dados amplamente utilizado e integrá-lo ao Unity pode ser poderoso para lidar com configurações, salvar o progresso do jogo ou trocar dados com serviços externos. Este guia orienta você nos fundamentos do trabalho com JSON em Unity.

Etapa 1: Compreendendo o JSON

JSON consiste em pares de valores-chave e estruturas aninhadas.

Etapa 2: Trabalhando com JSON no código Unity

Unity simplifica a serialização e desserialização JSON por meio de sua classe 'JsonUtility'. Este guia demonstra as etapas básicas para trabalhar com JSON em Unity sem bibliotecas externas.

• Crie uma estrutura JSON:

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

• Serialização - Convertendo objeto C# em 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);
    }
}

• Desserialização - Convertendo JSON em objeto 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));
    }
}

Limitações conhecidas

'JsonUtility' não oferece suporte direto à serialização e desserialização de matrizes de objetos de nível superior (por exemplo, '[{},{},{}]') sem uma classe de encapsulamento. Para contornar isso, você pode usar uma classe auxiliar para agrupar o array. Aqui está um exemplo:

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

No exemplo acima, a classe 'PlayerDataArrayWrapper' é usada para agrupar o array ao serializar e desserializar. É uma prática comum criar tais classes wrapper ao lidar com matrizes de objetos de nível superior em 'JsonUtility'.

Conclusão

'JsonUtility' simplifica a serialização e desserialização JSON diretamente, sem bibliotecas externas. Use esta abordagem nativa para operações JSON simples em projetos Unity.