Prima di iniziare
Prima di poter utilizzare Realtime Database, devi:
Registra il tuo progetto Unity e configuralo in modo che utilizzi 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 progetto Unity comporta attività sia nella console Firebase sia nel progetto Unity aperto (ad esempio, scarichi i file di configurazione di Firebase dalla console, quindi li sposti nel progetto Unity).
Salvataggio dei dati
Esistono cinque metodi per scrivere dati in Firebase Realtime Database:
Metodo | Utilizzi comuni |
---|---|
SetValueAsync() |
Scrivere o sostituire i dati in un percorso definito, ad esempio
users/<user-id>/<username> . |
SetRawJsonValueAsync() |
Scrivi o sostituisci i dati con JSON non elaborato, ad esempio
users/<user-id>/<username> . |
Push() |
Aggiungere elementi 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 delle chiavi per un percorso definito senza sostituire tutti i dati. |
RunTransaction() |
Aggiornare dati complessi che potrebbero essere danneggiati da aggiornamenti simultanei. |
Recuperare un DatabaseReference
Per scrivere dati nel database, devi avere 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 dati in un riferimento
Operazioni di scrittura di base
Per le operazioni di scrittura di base, puoi utilizzare SetValueAsync()
per salvare i dati in un riferimento specificato, sostituendo eventuali dati esistenti in quel percorso. Puoi utilizzare questo metodo per passare tipi che corrispondono ai tipi JSON disponibili come segue:
string
long
double
bool
Dictionary<string, Object>
List<Object>
Se utilizzi un oggetto C# con tipi, puoi utilizzare JsonUtility.ToJson()
incorporato per convertire l'oggetto in JSON non elaborato e chiamare SetRawJsonValueAsync()
.
Ad esempio, potresti avere una classe Utente che ha 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 secondari. Tuttavia, puoi comunque
aggiornare un elemento secondario senza riscrivere l'intero oggetto. Se vuoi consentire agli utenti di aggiornare i propri profili, puoi aggiornare il nome utente come segue:
mDatabaseRef.Child("users").Child(userId).Child("username").SetValueAsync(name);
Aggiungere elementi a un elenco di dati
Utilizza il metodo Push()
per accodare dati a un elenco in applicazioni multiutente.
Il metodo Push()
genera una chiave univoca ogni volta che viene aggiunto un nuovo elemento figlio al riferimento Firebase specificato. Utilizzando queste chiavi generate automaticamente per ogni nuovo elemento dell'elenco, più client possono aggiungere elementi secondari nella stessa posizione contemporaneamente senza conflitti di scrittura. La chiave unica generata da Push()
si basa su un timestamp, pertanto gli elementi dell'elenco vengono ordinati automaticamente in ordine cronologico.
Puoi utilizzare il riferimento ai nuovi dati restituiti dal metodo Push()
per ottenere il valore della chiave generata automaticamente dell'elemento secondario o impostare i dati per l'elemento secondario. La chiamata di Key
su un riferimento Push()
restituisce il valore della chiave generata automaticamente.
Aggiornare campi specifici
Per scrivere contemporaneamente in nodi secondari specifici di un nodo senza sovrascrivere altri nodi secondari, utilizza il metodo UpdateChildrenAsync()
.
Quando chiami UpdateChildrenAsync()
, puoi aggiornare i valori secondari 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 utilizzando la distribuzione 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 un LeaderboardEntry e aggiornarlo contemporaneamente nel feed dei risultati recenti e nell'elenco dei risultati 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 in più posizioni della
struttura ad albero JSON con una singola chiamata a UpdateChildrenAsync()
, ad esempio come questo
esempio crea la nuova voce in entrambe le posizioni. Gli aggiornamenti simultanei apportati in questo modo sono atomici: o tutti gli aggiornamenti vanno a buon fine o tutti non vanno a buon fine.
Elimina dati
Il modo più semplice per eliminare i dati è chiamare RemoveValue()
su un riferimento alla loro posizione.
Puoi anche eliminare specificando null
come valore per un'altra operazione di scrittura, ad esempio SetValueAsync()
o UpdateChildrenAsync()
. Puoi utilizzare questa tecnica con UpdateChildrenAsync()
per eliminare più elementi secondari in una singola chiamata API.
Scopri quando i dati vengono sottoposti a commit.
Per sapere quando i dati vengono applicati al server Firebase Realtime Database, puoi aggiungere un'istruzione continue. Sia SetValueAsync()
sia UpdateChildrenAsync()
restituisce un Task
che ti consente di sapere quando l'operazione è completata. Se la chiamata non va a buon fine per qualsiasi motivo, IsFaulted
Attività sarà true con la proprietà Exception
che indica il motivo dell'errore.
Salvare i dati come transazioni
Quando lavori con dati che potrebbero essere danneggiati da modifiche contemporaneamente, ad esempio contatori incrementali, puoi utilizzare un'operazione di transazione.
Assegni a questa operazione un Func
. Questo aggiornamento Func
prende lo stato corrente
degli argomenti dei dati e restituisce il nuovo stato desiderato che vuoi
scrivere. Se un altro client scrive nella posizione prima che il nuovo valore venga scritto correttamente, la funzione di aggiornamento viene richiamata di nuovo con il nuovo valore corrente e la scrittura viene riprovata.
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 i punteggi contemporaneamente o se il client ha dati non aggiornati. Se la transazione viene rifiutata, il server restituisce il valore corrente al client, che esegue di nuovo la transazione con il valore aggiornato. L'operazione viene ripetuta fino a quando la transazione non viene accettata o non sono stati effettuati troppi tentativi.
Scrivere dati offline
Se un client perde la connessione di rete, l'app continuerà a funzionare correttamente.
Ogni client collegato a un database Firebase gestisce la propria versione interna di tutti i dati attivi. Quando i dati vengono scritti, vengono prima scritti in questa versione locale. Il client Firebase sincronizza quindi i dati con i server database remoto e con altri client in base al criterio "best effort".
Di conseguenza, tutte le scritture nel database attivano immediatamente gli eventi locali, prima che qualsiasi dato venga scritto sul server. Ciò significa che la tua app rimane dinamica indipendentemente dalla latenza o dalla connettività di rete.
Una volta ripristinata la connettività, l'app riceve l'insieme appropriato di eventi in modo che il client si sincronizzi con lo stato attuale del server, senza dover scrivere codice personalizzato.