Salvare i dati

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Prima di iniziare

Prima di poter utilizzare il database in tempo reale , è necessario:

  • Registra il tuo progetto Unity e configuralo per utilizzare Firebase.

    • Se il tuo progetto Unity utilizza già Firebase, è già registrato e configurato per Firebase.

    • Se non hai un progetto Unity, puoi scaricare un'app di esempio .

  • Aggiungi l' SDK Firebase Unity (in particolare, FirebaseDatabase.unitypackage ) al tuo progetto Unity.

Tieni presente che l'aggiunta di Firebase al tuo progetto Unity comporta attività sia nella console Firebase che nel tuo progetto Unity aperto (ad esempio, scarichi i file di configurazione di Firebase dalla console, quindi li sposti nel tuo progetto Unity).

Salvataggio dei dati

Esistono cinque metodi per scrivere i dati nel database in tempo reale di Firebase:

Metodo Usi comuni
SetValueAsync() Scrivi o sostituisci i dati in un percorso definito, ad esempio users/<user-id>/<username> .
SetRawJsonValueAsync() Scrivi o sostituisci i dati con Json non elaborati, ad esempio users/<user-id>/<username> .
Push() Aggiungi a un elenco di dati. Ogni volta che chiami Push() , Firebase genera una chiave univoca che può essere utilizzata anche come identificatore univoco, ad esempio user-scores/<user-id>/<unique-score-id> .
UpdateChildrenAsync() Aggiorna alcune chiavi per un percorso definito senza sostituire tutti i dati.
RunTransaction() Aggiorna dati complessi che potrebbero essere danneggiati da aggiornamenti simultanei.

Ottieni un riferimento al database

Per scrivere dati nel database, è necessaria un'istanza di DatabaseReference :

using Firebase;
using Firebase.Database;

public class MyScript: MonoBehaviour {
  void Start() {
    // Get the root reference location of the database.
    DatabaseReference reference = FirebaseDatabase.DefaultInstance.RootReference;
  }
}

Scrivere, aggiornare o eliminare i dati in corrispondenza di un riferimento

Operazioni di scrittura di base

Per le operazioni di scrittura di base, puoi usare SetValueAsync() per salvare i dati in un riferimento specificato, sostituendo tutti i dati esistenti in quel percorso. Puoi utilizzare questo metodo per passare i tipi che corrispondono ai tipi JSON disponibili come segue:

  • string
  • long
  • double
  • bool
  • Dictionary<string, Object>
  • List<Object>

Se si utilizza un oggetto C# tipizzato, è possibile utilizzare JsonUtility.ToJson() per convertire l'oggetto in Json non elaborato e chiamare SetRawJsonValueAsync() . Ad esempio, potresti avere una classe User con il seguente aspetto:

public class User {
    public string username;
    public string email;

    public User() {
    }

    public User(string username, string email) {
        this.username = username;
        this.email = email;
    }
}

Puoi aggiungere un utente con SetRawJsonValueAsync() come segue:

private void writeNewUser(string userId, string name, string email) {
    User user = new User(name, email);
    string json = JsonUtility.ToJson(user);

    mDatabaseRef.Child("users").Child(userId).SetRawJsonValueAsync(json);
}

L'utilizzo di SetValueAsync() o SetRawJsonValueAsync() in questo modo sovrascrive i dati nella posizione specificata, inclusi eventuali nodi figlio. Tuttavia, puoi comunque aggiornare un figlio senza riscrivere l'intero oggetto. Se vuoi consentire agli utenti di aggiornare i loro profili, puoi aggiornare il nome utente come segue:

mDatabaseRef.Child("users").Child(userId).Child("username").SetValueAsync(name);

Aggiungi a un elenco di dati

Utilizzare il metodo Push() per aggiungere dati a un elenco in applicazioni multiutente. Il metodo Push() genera una chiave univoca ogni volta che viene aggiunto un nuovo figlio al riferimento Firebase specificato. Utilizzando queste chiavi generate automaticamente per ogni nuovo elemento nell'elenco, diversi client possono aggiungere figli nella stessa posizione contemporaneamente senza conflitti di scrittura. La chiave univoca generata da Push() si basa su un timestamp, quindi gli elementi dell'elenco vengono automaticamente ordinati cronologicamente.

È possibile utilizzare il riferimento ai nuovi dati restituiti dal metodo Push() per ottenere il valore della chiave generata automaticamente dal figlio o impostare i dati per il figlio. La chiamata della Key su un riferimento Push() restituisce il valore della chiave generata automaticamente.

Aggiorna campi specifici

Per scrivere contemporaneamente su elementi figlio specifici di un nodo senza sovrascrivere altri nodi figlio, utilizzare il metodo UpdateChildrenAsync() .

Quando si chiama UpdateChildrenAsync() , è possibile aggiornare i valori figlio di livello inferiore specificando un percorso per la chiave. Se i dati vengono archiviati in più posizioni per una migliore scalabilità, puoi aggiornare tutte le istanze di tali dati utilizzando il fan-out dei dati . Ad esempio, un gioco potrebbe avere una classe LeaderboardEntry come questa:

public class LeaderboardEntry {
    public string uid;
    public int score = 0;

    public LeaderboardEntry() {
    }

    public LeaderboardEntry(string uid, int score) {
        this.uid = uid;
        this.score = score;
    }

    public Dictionary<string, Object> ToDictionary() {
        Dictionary<string, Object> result = new Dictionary<string, Object>();
        result["uid"] = uid;
        result["score"] = score;

        return result;
    }
}

Per creare una LeaderboardEntry e aggiornarla contemporaneamente al feed dei punteggi recenti e all'elenco dei punteggi dell'utente, il gioco utilizza un codice come questo:

private void WriteNewScore(string userId, int score) {
    // Create new entry at /user-scores/$userid/$scoreid and at
    // /leaderboard/$scoreid simultaneously
    string key = mDatabase.Child("scores").Push().Key;
    LeaderBoardEntry entry = new LeaderBoardEntry(userId, score);
    Dictionary<string, Object> entryValues = entry.ToDictionary();

    Dictionary<string, Object> childUpdates = new Dictionary<string, Object>();
    childUpdates["/scores/" + key] = entryValues;
    childUpdates["/user-scores/" + userId + "/" + key] = entryValues;

    mDatabase.UpdateChildrenAsync(childUpdates);
}

Questo esempio utilizza Push() per creare una voce nel nodo contenente voci per tutti gli utenti in /scores/$key e recuperare contemporaneamente la chiave con Key . La chiave può quindi essere utilizzata per creare una seconda voce nei punteggi dell'utente in /user-scores/$userid/$key .

Utilizzando questi percorsi, puoi eseguire aggiornamenti simultanei a più posizioni nell'albero JSON con una singola chiamata a UpdateChildrenAsync() , ad esempio come questo esempio crea la nuova voce in entrambe le posizioni. Gli aggiornamenti simultanei effettuati in questo modo sono atomici: tutti gli aggiornamenti riescono o tutti gli aggiornamenti falliscono.

Elimina dati

Il modo più semplice per eliminare i dati consiste nel chiamare RemoveValue() su un riferimento alla posizione di tali dati.

Puoi anche eliminare specificando null come valore per un'altra operazione di scrittura come SetValueAsync() o UpdateChildrenAsync() . Puoi usare questa tecnica con UpdateChildrenAsync() per eliminare più elementi figlio in una singola chiamata API.

Sapere quando i tuoi dati sono impegnati.

Per sapere quando i tuoi dati sono impegnati nel server Firebase Realtime Database, puoi aggiungere una continuazione. Sia SetValueAsync() che UpdateChildrenAsync() restituiscono un'attività che consente di sapere quando l' Task è stata completata. Se la chiamata non riesce per qualsiasi motivo, Tasks IsFaulted sarà true con la proprietà Exception che indica il motivo per cui si è verificato l'errore.

Salva i dati come transazioni

Quando si lavora con dati che potrebbero essere danneggiati da modifiche simultanee, ad esempio contatori incrementali, è possibile utilizzare un'operazione di transazione . Assegna a questa operazione un Func . Questo aggiornamento Func prende lo stato corrente dei dati come argomento e restituisce il nuovo stato desiderato che si desidera scrivere. Se un altro client scrive nella posizione prima che il tuo nuovo valore venga scritto correttamente, la tua funzione di aggiornamento viene chiamata di nuovo con il nuovo valore corrente e la scrittura viene ripetuta.

Ad esempio, in un gioco potresti consentire agli utenti di aggiornare una classifica con i cinque punteggi più alti:

private void AddScoreToLeaders(string email, 
                               long score,
                               DatabaseReference leaderBoardRef) {

    leaderBoardRef.RunTransaction(mutableData => {
      List<object> leaders = mutableData.Value as List<object>

      if (leaders == null) {
        leaders = new List<object>();
      } else if (mutableData.ChildrenCount >= MaxScores) {
        long minScore = long.MaxValue;
        object minVal = null;
        foreach (var child in leaders) {
          if (!(child is Dictionary<string, object>)) continue;
          long childScore = (long)
                      ((Dictionary<string, object>)child)["score"];
          if (childScore < minScore) {
            minScore = childScore;
            minVal = child;
          }
        }
        if (minScore > score) {
          // The new score is lower than the existing 5 scores, abort.
          return TransactionResult.Abort();
        }

        // Remove the lowest score.
        leaders.Remove(minVal);
      }

      // Add the new high score.
      Dictionary<string, object> newScoreMap =
                       new Dictionary<string, object>();
      newScoreMap["score"] = score;
      newScoreMap["email"] = email;
      leaders.Add(newScoreMap);
      mutableData.Value = leaders;
      return TransactionResult.Success(mutableData);
    });
}

L'utilizzo di una transazione impedisce che la classifica sia errata se più utenti registrano punteggi contemporaneamente o se il cliente aveva dati non aggiornati. Se la transazione viene rifiutata, il server restituisce il valore corrente al client, che esegue nuovamente la transazione con il valore aggiornato. Questo si ripete fino a quando la transazione non viene accettata o sono stati effettuati troppi tentativi.

Scrivi dati offline

Se un client perde la connessione di rete, l'app continuerà a funzionare correttamente.

Ogni client connesso a un database Firebase mantiene la propria versione interna di tutti i dati attivi. Quando i dati vengono scritti, vengono scritti prima in questa versione locale. Il client Firebase sincronizza quindi i dati con i server di database remoti e con altri client in base al "miglior sforzo".

Di conseguenza, tutte le scritture nel database attivano eventi locali immediatamente, prima che i dati vengano scritti sul server. Ciò significa che la tua app rimane reattiva indipendentemente dalla latenza di rete o dalla connettività.

Una volta ristabilita la connettività, l'app riceve il set di eventi appropriato in modo che il client si sincronizzi con lo stato corrente del server, senza dover scrivere codice personalizzato.

Prossimi passi