[TUTORIAL] Salvando e carregando dados com serialização (Parte 3)

The Last one:

Bem vindos(as) a última parte do nosso tutorial de como criar uma arquitetura simples e eficaz para persistir dados em seu jogo.
É de suma importância que você já esteja por dentro de assuntos já mencionados anteriormente, como serialização e playerprefs, para que possa dar seguimento a esta leitura de maneira mais segura. Caso contrário, recomendo dar uma rápida lida nos tópicos linkados como referência.

As quatro entidades:

Parece nome de filme de terror, mas esse assunto do tópico é de extrema importância para a concepção da arquitetura do nosso sistema de save/load para que ele fique -como nossos amigos gringos gostam de chamar- pretty much simple, ou seja, ele vai ficar tão simples de utilizar e vai se encaixar perfeitamente com qualquer situação e tipo de dado, que você vai ficar muito feliz por ter encontrado esse tópico aqui.

Para estruturar nosso sistema, vamos precisar pensar em quatro entidades responsáveis por gerenciar todo nosso ecossistema: a classe concreta que mantém o modelo de dados a serem carregados, a classe abstrata que assegura o tipo do dado e mantém um contrato de implementação, a classe responsável por realizar as ações em torno do save/load do sistema, e a classe MonoBehaviour necessária para consumir essas informações.

Classe concreta:

Vamos começar pela classe concreta que vai possuir as variáveis necessárias para serem salvas e carregadas.
Essa classe em nosso exemplo, vai se assemelhar muito à struct que tínhamos nos tutoriais anteriores (ainda mais porque vamos utilizar ainda a ideia de "PlayerData").
Então para tal, vamos manter as mesmas variáveis, com a diferença de que estamos lidando com uma classe e não uma struct:

Código:

namespace Data{
 [System.Serializable]
    public class PlayerData
    {
        public string name;
        public float coins;
        public float health;
        public int score;
}
}

Aqui estamos criando um namespace, para ser nosso container de classes e métodos referentes à manipulação e gerenciamento de dados.
Você pode criar um novo script na Unity com o nome "Data", remover todas as linhas existentes nele, e escrever o código acima para implementar nossa primeira entidade do sistema. Essa entidade será responsável por conter o modelo de dados que iremos querer salvar e carregar no jogo.

Agora vamos supor que você deseje não apenas persistir dados do player, mas também de outros elementos do game, como por exemplo, o inventário.
Poderíamos ter outra classe que modela nossos dados, da seguinte forma:

Código:

namespace Data {
(...)PlayerData

[System.Serializable]
public class InventoryData{
public string equippedItemName;
public Items[] allItems;
public int itemsCount;
}
}

Aqui temos uma situação onde queremos também guardar informações sobre nosso inventário, como item equipado, lista de itens nesse inventário, a quantidade desses itens e etc.

Perceba que agora temos duas classes referente à nossa entidade de modelo de dados, ou seja, temos classes que possuem propósito em comum, mas que não se conectam de forma alguma em nossa estrutura arquitetural. 

Para fazer com que todas as classes em nosso jogo, que forem modelos de dados, sejam um tipo em comum, vamos buscar pela nossa segunda entidade: A classe abstrata.

Classe Abstrata:

A nossa classe abstrata aqui, entra com o papel de fornecer um tipo em comum para todas as nossas classes de modelagem de dados (PlayerData e InventoryData, por exemplo).
Não só isso, como também estabelece um contrato de comportamento para a implementação da ID do nosso objeto.
Esse ID é muito importante para que possamos diferenciar cada instância da classe para que sejam únicos, onde esse ID pode posteriormente ser utilizado como chave do PlayerPrefs, também.

Nós vamos implementar nossa classe abstrata (que chamarei de "PersistentData") com um campo privado, porém, que pode ser serializado (Utilizando o atributo UnityEngine.SerializableField), e que vai ser acessado externamente através de uma propriedade somente leitura. Como mencionado, esse campo será referente ao ID do objeto.

Vamos também criar um método que seta o valor do ID internamente. Esse ID será do tipo "string".
A implementação da nossa segunda entidade ficará assim:

Código:

namespace Data
{
    public abstract class PersistentData
    {
        [UnityEngine.SerializeField]
        private string id;

        public string ID
        {
            get { return id; }
            private set { id = value; }
        }

        protected void SetID(string id) => this.id = id;
    }

(...) PlayerData
(...) InventoryData
}

Perceba que o modificador "private" foi setado ao nosso acessor "set", pois esse valor só poderá ser atribuído pela classe abstrata, internamente e uma única vez.

Após ter feito isto, podemos fazer com que nossas classes concretas herdem de "PersistentData":

Código:

public class PlayerData : PersistentData {...}
public class InventoryData : PersistentData {...}

Nosso último passo é definir o construtor de nossas classes, pois é através do construtor que iremos ter acesso ao valor da chave de nosso objeto instanciado. Esse construtor será responsável por chamar o método "SetID" implementado na classe abstrata, onde é responsável por setar o valor do id da nossa instância.

Código:

public PlayerData(string id) => SetID(id);

*Implementação na classe "PlayerData", mas você deve fazer o mesmo para todas as outras classes de modelagem!

Neste ponto estamos preparados para implementar nossa terceira entidade: o gerenciador de dados.

Gerenciador de dados:

Nossa terceira entidade será responsável por realizar de fato as ações de save/load e também de limpeza de dados no nosso jogo.
Para criar essa entidade, crie um novo script no projeto, chame-o de "DataManager", e exclua todas as linhas nesse script.

Nós vamos declarar uma classe static que vai possuir os seguintes métodos:

• Save -> Para salvar alguma estrutura de dados, passada como argumento;
  
• Load -> Para carregar um objeto anteriormente salvo, passando a chave (id) desse objeto como argumento;
  
• DeleteKey -> Método para deletar/resetar algum dado salvo, passando a chave do objeto a ser apagado, como argumento;
  
• DeleteAll -> Método responsável por deletar/resetar todos os objetos salvos em nosso jogo;
  
• HasKey -> Método simples que vai validar se uma chave existe em nosso PlayerPrefs, passando essa chave como argumento.
  

Vamos primeiramente implementar nosso método "Save", utilizando os conceitos que vimos nos tópicos anteriores, sobre serialização:

Código:

using UnityEngine;

namespace Data
{
    public static class DataManager
    {
        public static void Save(PersistentData persistentData)
        {
            string keyToSave = persistentData.ID;

            if (keyToSave == null)
                return;

            string objectToSave = JsonUtility.ToJson(persistentData);

            PlayerPrefs.SetString(keyToSave, objectToSave);
            PlayerPrefs.Save();
        }
}

Aqui temos um método bem parecido com o que tínhamos no tópico anterior, onde serializamos um simples texto; com a diferença de que passamos pro método "ToJson" um objeto do tipo "PersistentData" para ser serializado, ou seja, pode ser tanto um objeto "PlayerData" quanto "InventoryData" para ser salvo, ou qualquer outra estrutura de dado que você precise salvar, desde que seja subclasse de "PersistentData".

Agora vamos implementar nosso processo de desserialização através do método Load:

Código:

public static T Load<T>(string dataKey) where T : PersistentData
        {
            string loadedData = PlayerPrefs.GetString(dataKey);

            return JsonUtility.FromJson<T>(loadedData);
        }

Nosso método de Load é muito semelhante ao que tínhamos para nosso processo de carregamento de dados no tópico anterior, ele utiliza o PlayerPrefs com a chave para resgatar a string serializada, e usa esse valor para desserializar essa classe.

Porém, note que temos um retorno do tipo "T" aqui. Ou seja, nós estamos dizendo que esse método pode retornar qualquer tipo, no caso, o tipo que vai ser declarado em sua chamada. Fizemos isso através dos tipos genéricos do C#.
Para não virar bagunça, nós também estipulamos que esse tipo genérico deverá obrigatoriamente ser subclasse de "PersistentData", através de uma restrição de tipo, ou seja, esse tipo pode ser qualquer tipo, desde que seja uma classe filha de "PersistentData", em nosso caso, podendo ser aqui um objeto do tipo "PlayerData" ou "InventoryData".

Por fim, nosso método retorna o objeto desserializado.

O método de deletar um dado salvo é bem simples de implementar, vide:

Código:

public static void DeleteData(string key)
        {
            if(HasKey(key))
            PlayerPrefs.DeleteKey(key);
        }

Aqui, solicitamos uma chave como parâmetro, validamos se essa chave é existente no PlayerPrefs, e por fim, através do método "DeleteKey" do PlayerPrefs, deletamos essa chave, com seu valor salvo.

Para implementar o método "DeleteAll" é mais simples ainda:

Código:

public static void DeleteAllData() => PlayerPrefs.DeleteAll();

Por fim, nosso último método dessa entidade, o método de validar a chave existente:

Código:

public static bool HasKey(string key)
        {
            return !string.IsNullOrEmpty(PlayerPrefs.GetString(key));
        }

Depois de tudo isso, estamos prontos para implementar nossa última entidade: o controlador de dados.

Controlador de dados:

Aqui teremos uma classe que será MonoBehaviour e que vai estar num gameobject da cena, fazendo o papel de controlador de dados.
Essa classe vai de fato chamar as ações de carregamento e salvamento de dados e consumir essas informações para algum propósito no jogo.

Vou utilizar como exemplo a questão de gerenciar os dados do player com o PlayerData.

Crie um novo script com o nome "PlayerManager" e anexe ele a um object da cena.

Para consumir os dados salvos/carregados, vamos criar uma variável do tipo "PlayerData" e também uma chave para esse objeto:

Código:

using UnityEngine;
using Data;

public class PlayerManager : MonoBehaviour{
public PlayerData _playerData {get; private set;}
private const string playerDataKey = "PLAYER_DATA_";
}

Podemos criar um método para atualizar os dados do nosso objeto:

Código:

private void UpdateData(){
_playerData.name = "May";
_playerData.health += 5;
_playerData.score += 100;
_playerData.coins += 200;

DataManager.Save(_playerData);

ShowDataOnConsole();
}

Aqui estamos setando valores arbitrários para nosso objeto, note também que ao final chamamos o método "Save" do DataManager, passando nosso objeto como argumento, para que possamos salvar esses valores atualizados. 
*É importante que sempre que você modifique os valores de uma estrutura persistente, você a salve logo em seguida!

Também chamamos um método chamado "ShowDataOnConsole" que eu vou utilizar para mostrar as informações salvas, no console:

Código:

private void ShowDataOnConsole()
    {
            Debug.Log($"Nome do jogador: {_playerData.name}");
            Debug.Log($"Pontos do jogador: {_playerData.score}");
            Debug.Log($"Vida do jogador: {_playerData.health}");
            Debug.Log($"Moedas do jogador: {_playerData.coins}");

            Debug.Log("================");

    }

Para carregar os dados do nosso player, podemos realizar essa ação toda vez que nossa classe é ativada!
Vamos chamar o método "Load" de "DataManager" e passar a nossa chave, fazendo com que o resultado retornado seja armazenado em nosso objeto "_playerData":

Código:

private void OnEnable(){
_playerData = new PlayerData(playerDataKey);

if(DataManager.HasKey(playerDataKey))
_playerData = DataManager.Load<PlayerData>(playerDataKey);
}

Então primeiramente nós instanciamos esse objeto, passando como construtor a chave do PlayerPrefs, e depois fazemos uma validação se essa chave existe dentro do PlayerPrefs, se sim, chamamos o "Load" passando qual o tipo que queremos retornar, no caso aqui, o PlayerData, e passando como argumento a chave. O valor retornado vai ser colocado dentro da variável "_playerData", restaurando para si, os valores armazenados.

Agora podemos testar tudo isso, fazendo dentro do Update com que quando apertamos o botão "Space" no teclado, os valores sejam atualizados:

Código:

private void Update(){
if(Input.GetKeyDown(KeyCode.Space))
UpdateData();
}

Agora podemos dar play no jogo e testar tudo isso.
Pressione "space" no teclado, e veja no console os valores sendo incrementados.
Agora pare o teste; defina esse método aqui:

Código:

private void Awake() => ShowDataOnConsole();

Salve o script e assim que você entrar no jogo, os valores salvos serão mostrados corretamente no console.

Salvando múltiplos objetos:

Caso tenha a necessidade de salvar mais de um objeto em seu jogo, como por exemplo, os dados de dois jogadores num multiplayer local, você pode utilizar um array de dados para isso, e a manipulação das chaves pode ser um pouco diferente, segue:

Código:

using UnityEngine;
using Data;

public class PlayerManager : MonoBehaviour
{
    public PlayerData[] playersData = new PlayerData[2];

    private void Awake()
    {
        InitializePlayers();

        ShowDataOnConsole();
    }

private void Update(){
if(Input.GetKeyDown(KeyCode.Space))
UpdateData();
}

    private void InitializePlayers()
    {
        for (int i = 0; i < playersData.Length; i++)
        {
            string playerKey = playerDataKey + i.ToString();

            playersData[i] = new PlayerData(playerKey);

            if (DataManager.HasKey(playerKey))
            {
                playersData[i] = DataManager.Load<PlayerData>(playerKey);
            }
        }

    }

    public void UpdateData()
    {
        playersData[0].name = "May";
        playersData[0].health += 5;
        playersData[0].score += 200;
        playersData[0].coins += 100;

        playersData[1].name = "May2";
        playersData[1].health += 10;
        playersData[1].score += 400;
        playersData[1].coins += 200;

        DataManager.Save(playersData[0]);
        DataManager.Save(playersData[1]);

        ShowDataOnConsole();
    }

    private void ShowDataOnConsole()
    {
        foreach (PlayerData _playerData in playersData)
        {
            Debug.Log($"Nome do jogador: {_playerData.name}");
            Debug.Log($"Pontos do jogador: {_playerData.score}");
            Debug.Log($"Vida do jogador: {_playerData.health}");
            Debug.Log($"Moedas do jogador: {_playerData.coins}");

            Debug.Log("================");
        }

    }
}


Nesse exemplo, a chave será o texto "PLAYER_DATA_" + o índice do array daquele objeto, ou seja, para o primeiro player teremos a chave: "PLAYER_DATA_0" e para o segundo: "PLAYER_DATA_1".
Perceba em seus testes, que ao carregar os dois objetos, cada um é individual um do outro, por possuírem valores distintos. 

Finalização:

E aqui chega ao fim nosso tutorial! Veja que essa arquitetura além de ser simples de ser implementada, lhe faz economizar código, pois com ela você centraliza as ações de salvar, carregar e deletar dados, tudo numa mesma classe, precisando apenas chamar esses comandos onde achar necessário.
Você pode também utilizar todo esse sistema para diversos tipos de dados diferentes que necessitar, basta criar sua classe de modelagem e fazer ela herdar de "PersistentData".
Esse sistema também é apto para lidar com múltiplas instâncias, igual vimos no exemplo de querer armazenar os valores de dois jogadores diferentes! 
Espero que tenham gostado dessa série de tutoriais sobre serialização e manipulação de dados em armazenamento, acredito que eu tenha ajudado em algo com todos esses conceitos aqui apresentados.

E digo mais: Se estes tópicos obtiverem um certo engajamento relevante, posso criar um vídeo sobre tudo isso lá no meu canal.
Então se gostou, deixe seu feedback aqui, nem que seja apenas com um "like" no tópico. 

Show de bola, eu apoio o vídeo kkk , posso dar uma sugestão? sei que não vai impedir quem queira trapacear alterando os dados salvos, mas ao menos já dificulta pro Joãozinho que aprendeu a usar Lucky patcher no YouTube, seria bom gerar uma hash Sha256 do dado serializado e guardar também, durante o carregamento poderia gerar novamente a hash do arquivo salvo e comparar com a armazenada, sei que não seria 100% efetivo, mas a grande maioria dos usuários nem saberiam que aquilo é uma hash, muito menos saber gerar uma pra alterar também, seria uma camada extra de dificuldade pra quem tenha más intenções.

Fagner escreveu:Show de bola, eu apoio o vídeo kkk , posso dar uma sugestão? sei que não vai impedir quem queira trapacear alterando os dados salvos, mas ao menos já dificulta pro Joãozinho que aprendeu a usar Lucky patcher no YouTube, seria bom gerar uma hash Sha256 do dado serializado e guardar também, durante o carregamento poderia gerar novamente a hash do arquivo salvo e comparar com a armazenada, sei que não seria 100% efetivo, mas a grande maioria dos usuários nem saberiam que aquilo é uma hash, muito menos saber gerar uma pra alterar também, seria uma camada extra de dificuldade pra quem tenha más intenções.

Não acho que vá ajudar, pois tanto o lucky Patcher e o cheat engine, usam os valores na memoria, vulgo endereço de memoria. Ler na leitura ou na escrita e o de menos.