(Opcional) Protótipo e teste com Firebase Local Emulator Suite
Antes de falar sobre como seu aplicativo lê e grava no Realtime Database, vamos apresentar um conjunto de ferramentas que você pode usar para criar protótipos e testar a funcionalidade do Realtime Database: Firebase Local Emulator Suite. Se você estiver experimentando diferentes modelos de dados, otimizando suas regras de segurança ou trabalhando para encontrar a maneira mais econômica de interagir com o back-end, poder trabalhar localmente sem implantar serviços ativos pode ser uma ótima ideia.
Um emulador do Realtime Database faz parte do Local Emulator Suite, que permite que seu aplicativo interaja com o conteúdo e a configuração do banco de dados emulado, bem como, opcionalmente, com os recursos do projeto emulado (funções, outros bancos de dados e regras de segurança).
Usar o emulador do Realtime Database envolve apenas algumas etapas:
- Adicionando uma linha de código à configuração de teste do seu aplicativo para conectar-se ao emulador.
- Na raiz do diretório local do projeto, executando
firebase emulators:start. - Fazer chamadas a partir do código do protótipo do seu aplicativo usando um SDK da plataforma Realtime Database normalmente ou usando a API REST do Realtime Database.
Um passo a passo detalhado envolvendo o Realtime Database e o Cloud Functions está disponível. Você também deve dar uma olhada na introdução do Local Emulator Suite .
Obtenha uma referência FIRDatabase
Para ler ou gravar dados do banco de dados, você precisa de uma instância de FIRDatabaseReference :
Rápido
var ref: DatabaseReference! ref = Database.database().reference()
Objetivo-C
@property (strong, nonatomic) FIRDatabaseReference *ref; self.ref = [[FIRDatabase database] reference];
Gravar dados
Este documento aborda os conceitos básicos de leitura e gravação de dados do Firebase.
Os dados do Firebase são gravados em uma referência Database e recuperados anexando um ouvinte assíncrono à referência. O ouvinte é acionado uma vez para o estado inicial dos dados e novamente sempre que os dados são alterados.
Operações básicas de gravação
Para operações básicas de gravação, você pode usar setValue para salvar dados em uma referência especificada, substituindo quaisquer dados existentes nesse caminho. Você pode usar este método para:
- Passe tipos que correspondem aos tipos JSON disponíveis da seguinte forma:
-
NSString -
NSNumber -
NSDictionary -
NSArray
-
Por exemplo, você pode adicionar um usuário com setValue da seguinte maneira:
Rápido
self.ref.child("users").child(user.uid).setValue(["username": username])
Objetivo-C
[[[self.ref child:@"users"] child:authResult.user.uid]
setValue:@{@"username": username}];
Usar setValue dessa forma substitui os dados no local especificado, incluindo quaisquer nós filhos. No entanto, você ainda pode atualizar um filho sem reescrever o objeto inteiro. Se quiser permitir que os usuários atualizem seus perfis, você pode atualizar o nome de usuário da seguinte maneira:
Rápido
self.ref.child("users/\(user.uid)/username").setValue(username)
Objetivo-C
[[[[_ref child:@"users"] child:user.uid] child:@"username"] setValue:username];
Ler dados
Leia dados ouvindo eventos de valor
Para ler dados em um caminho e escutar alterações, use observeEventType:withBlock de FIRDatabaseReference para observar eventos FIRDataEventTypeValue .
| Tipo de evento | Uso típico |
|---|---|
FIRDataEventTypeValue | Leia e ouça alterações em todo o conteúdo de um caminho. |
Você pode usar o evento FIRDataEventTypeValue para ler os dados em um determinado caminho, conforme eles existem no momento do evento. Este método é acionado uma vez quando o ouvinte é anexado e novamente sempre que os dados, incluindo quaisquer filhos, são alterados. O retorno de chamada do evento recebe um snapshot contendo todos os dados naquele local, incluindo dados filho. Se não houver dados, o instantâneo retornará false quando você chamar exists() e nil quando você ler sua propriedade value .
O exemplo a seguir demonstra um aplicativo de blog social recuperando os detalhes de uma postagem do banco de dados:
Rápido
refHandle = postRef.observe(DataEventType.value, with: { snapshot in
// ...
})
Objetivo-C
_refHandle = [_postRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) {
NSDictionary *postDict = snapshot.value;
// ...
}];
O ouvinte recebe um FIRDataSnapshot que contém os dados no local especificado no banco de dados no momento do evento em sua propriedade value . Você pode atribuir os valores ao tipo nativo apropriado, como NSDictionary . Se não existirem dados no local, o value será nil .
Leia os dados uma vez
Leia uma vez usando getData()
O SDK foi projetado para gerenciar interações com servidores de banco de dados, esteja seu aplicativo online ou offline.
Geralmente, você deve usar as técnicas de eventos de valor descritas acima para ler dados e ser notificado sobre atualizações nos dados do back-end. Essas técnicas reduzem o uso e o faturamento e são otimizadas para oferecer aos usuários a melhor experiência on-line e off-line.
Se precisar dos dados apenas uma vez, você pode usar getData() para obter um instantâneo dos dados do banco de dados. Se por algum motivo getData() não conseguir retornar o valor do servidor, o cliente investigará o cache de armazenamento local e retornará um erro se o valor ainda não for encontrado.
O exemplo a seguir demonstra a recuperação do nome de usuário público de um usuário uma única vez do banco de dados:
Rápido
do {
let snapshot = try await ref.child("users/\(uid)/username").getData()
let userName = snapshot.value as? String ?? "Unknown"
} catch {
print(error)
}
Objetivo-C
NSString *userPath = [NSString stringWithFormat:@"users/%@/username", uid];
[[ref child:userPath] getDataWithCompletionBlock:^(NSError * _Nullable error, FIRDataSnapshot * _Nonnull snapshot) {
if (error) {
NSLog(@"Received an error %@", error);
return;
}
NSString *userName = snapshot.value;
}];
O uso desnecessário de getData() pode aumentar o uso da largura de banda e levar à perda de desempenho, o que pode ser evitado usando um ouvinte em tempo real conforme mostrado acima.
Leia os dados uma vez com um observador
Em alguns casos você pode querer que o valor do cache local seja retornado imediatamente, em vez de verificar um valor atualizado no servidor. Nesses casos, você pode usar observeSingleEventOfType para obter os dados do cache do disco local imediatamente.
Isso é útil para dados que só precisam ser carregados uma vez e não se espera que sejam alterados com frequência ou que exijam escuta ativa. Por exemplo, o aplicativo de blog dos exemplos anteriores usa este método para carregar o perfil de um usuário quando ele começa a criar uma nova postagem:
Rápido
let userID = Auth.auth().currentUser?.uid
ref.child("users").child(userID!).observeSingleEvent(of: .value, with: { snapshot in
// Get user value
let value = snapshot.value as? NSDictionary
let username = value?["username"] as? String ?? ""
let user = User(username: username)
// ...
}) { error in
print(error.localizedDescription)
}
Objetivo-C
NSString *userID = [FIRAuth auth].currentUser.uid;
[[[_ref child:@"users"] child:userID] observeSingleEventOfType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) {
// Get user value
User *user = [[User alloc] initWithUsername:snapshot.value[@"username"]];
// ...
} withCancelBlock:^(NSError * _Nonnull error) {
NSLog(@"%@", error.localizedDescription);
}];
Atualizando ou excluindo dados
Atualizar campos específicos
Para gravar simultaneamente em filhos específicos de um nó sem substituir outros nós filhos, use o método updateChildValues .
Ao chamar updateChildValues , você pode atualizar valores filho de nível inferior especificando um caminho para a chave. Se os dados forem armazenados em vários locais para melhor escalar, você poderá atualizar todas as instâncias desses dados usando o data fan-out . Por exemplo, um aplicativo de blog social pode querer criar uma postagem e atualizá-la simultaneamente para o feed de atividades recentes e para o feed de atividades do usuário da postagem. Para fazer isso, o aplicativo de blog usa um código como este:
Rápido
guard let key = ref.child("posts").childByAutoId().key else { return }
let post = ["uid": userID,
"author": username,
"title": title,
"body": body]
let childUpdates = ["/posts/\(key)": post,
"/user-posts/\(userID)/\(key)/": post]
ref.updateChildValues(childUpdates)
Objetivo-C
NSString *key = [[_ref child:@"posts"] childByAutoId].key;
NSDictionary *post = @{@"uid": userID,
@"author": username,
@"title": title,
@"body": body};
NSDictionary *childUpdates = @{[@"/posts/" stringByAppendingString:key]: post,
[NSString stringWithFormat:@"/user-posts/%@/%@/", userID, key]: post};
[_ref updateChildValues:childUpdates];
Este exemplo usa childByAutoId para criar uma postagem no nó contendo postagens para todos os usuários em /posts/$postid e simultaneamente recuperar a chave com getKey() . A chave pode então ser usada para criar uma segunda entrada nas postagens do usuário em /user-posts/$userid/$postid .
Usando esses caminhos, você pode realizar atualizações simultâneas em vários locais na árvore JSON com uma única chamada para updateChildValues , como este exemplo cria a nova postagem em ambos os locais. As atualizações simultâneas feitas dessa maneira são atômicas: ou todas as atualizações são bem-sucedidas ou todas as atualizações falham.
Adicionar um bloco de conclusão
Se quiser saber quando seus dados foram confirmados, você pode adicionar um bloco de conclusão. Tanto setValue quanto updateChildValues utilizam um bloco de conclusão opcional que é chamado quando a gravação é confirmada no banco de dados. Este ouvinte pode ser útil para controlar quais dados foram salvos e quais dados ainda estão sendo sincronizados. Se a chamada não tiver êxito, o ouvinte receberá um objeto de erro indicando o motivo da falha.
Rápido
do {
try await ref.child("users").child(user.uid).setValue(["username": username])
print("Data saved successfully!")
} catch {
print("Data could not be saved: \(error).")
}
Objetivo-C
[[[_ref child:@"users"] child:user.uid] setValue:@{@"username": username} withCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
if (error) {
NSLog(@"Data could not be saved: %@", error);
} else {
NSLog(@"Data saved successfully.");
}
}];
Excluir dados
A maneira mais simples de excluir dados é chamar removeValue em uma referência ao local desses dados.
Você também pode excluir especificando nil como o valor para outra operação de gravação, como setValue ou updateChildValues . Você pode usar essa técnica com updateChildValues para excluir vários filhos em uma única chamada de API.
Desanexar ouvintes
Os observadores não param automaticamente de sincronizar os dados quando você sai de um ViewController . Se um observador não for removido corretamente, ele continuará sincronizando os dados com a memória local. Quando um observador não for mais necessário, remova-o passando o FIRDatabaseHandle associado para o método removeObserverWithHandle .
Quando você adiciona um bloco de retorno de chamada a uma referência, um FIRDatabaseHandle é retornado. Esses identificadores podem ser usados para remover o bloco de retorno de chamada.
Se vários ouvintes tiverem sido adicionados a uma referência de banco de dados, cada ouvinte será chamado quando um evento for gerado. Para interromper a sincronização de dados nesse local, você deve remover todos os observadores de um local chamando o método removeAllObservers .
Chamar removeObserverWithHandle ou removeAllObservers em um ouvinte não remove automaticamente os ouvintes registrados em seus nós filhos; você também deve acompanhar essas referências ou identificadores para removê-los.
Salvar dados como transações
Ao trabalhar com dados que podem ser corrompidos por modificações simultâneas, como contadores incrementais, você pode usar uma operação de transação . Você fornece dois argumentos a esta operação: uma função de atualização e um retorno de chamada de conclusão opcional. A função de atualização toma o estado atual dos dados como argumento e retorna o novo estado desejado que você gostaria de escrever.
Por exemplo, no aplicativo de blog social de exemplo, você pode permitir que os usuários marquem e desmarquem postagens com estrela e controlem quantas estrelas uma postagem recebeu da seguinte maneira:
Rápido
ref.runTransactionBlock({ (currentData: MutableData) -> TransactionResult in
if var post = currentData.value as? [String: AnyObject],
let uid = Auth.auth().currentUser?.uid {
var stars: [String: Bool]
stars = post["stars"] as? [String: Bool] ?? [:]
var starCount = post["starCount"] as? Int ?? 0
if let _ = stars[uid] {
// Unstar the post and remove self from stars
starCount -= 1
stars.removeValue(forKey: uid)
} else {
// Star the post and add self to stars
starCount += 1
stars[uid] = true
}
post["starCount"] = starCount as AnyObject?
post["stars"] = stars as AnyObject?
// Set value and report transaction success
currentData.value = post
return TransactionResult.success(withValue: currentData)
}
return TransactionResult.success(withValue: currentData)
}) { error, committed, snapshot in
if let error = error {
print(error.localizedDescription)
}
}
Objetivo-C
[ref runTransactionBlock:^FIRTransactionResult * _Nonnull(FIRMutableData * _Nonnull currentData) {
NSMutableDictionary *post = currentData.value;
if (!post || [post isEqual:[NSNull null]]) {
return [FIRTransactionResult successWithValue:currentData];
}
NSMutableDictionary *stars = post[@"stars"];
if (!stars) {
stars = [[NSMutableDictionary alloc] initWithCapacity:1];
}
NSString *uid = [FIRAuth auth].currentUser.uid;
int starCount = [post[@"starCount"] intValue];
if (stars[uid]) {
// Unstar the post and remove self from stars
starCount--;
[stars removeObjectForKey:uid];
} else {
// Star the post and add self to stars
starCount++;
stars[uid] = @YES;
}
post[@"stars"] = stars;
post[@"starCount"] = @(starCount);
// Set value and report transaction success
currentData.value = post;
return [FIRTransactionResult successWithValue:currentData];
} andCompletionBlock:^(NSError * _Nullable error,
BOOL committed,
FIRDataSnapshot * _Nullable snapshot) {
// Transaction completed
if (error) {
NSLog(@"%@", error.localizedDescription);
}
}];
Usar uma transação evita que a contagem de estrelas fique incorreta se vários usuários marcarem a mesma postagem com estrela ao mesmo tempo ou se o cliente tiver dados desatualizados. O valor contido na classe FIRMutableData é inicialmente o último valor conhecido do cliente para o caminho ou nil se não houver nenhum. O servidor compara o valor inicial com seu valor atual e aceita a transação se os valores corresponderem ou a rejeita. Se a transação for rejeitada, o servidor retorna o valor atual ao cliente, que executa a transação novamente com o valor atualizado. Isso se repete até que a transação seja aceita ou muitas tentativas tenham sido feitas.
Incrementos atômicos do lado do servidor
No caso de uso acima, estamos gravando dois valores no banco de dados: o ID do usuário que marca/desmarca a postagem com estrela e a contagem incrementada de estrelas. Se já sabemos que o usuário está estrelando a postagem, podemos usar uma operação de incremento atômico em vez de uma transação.
Rápido
let updates = [ "posts/\(postID)/stars/\(userID)": true, "posts/\(postID)/starCount": ServerValue.increment(1), "user-posts/\(postID)/stars/\(userID)": true, "user-posts/\(postID)/starCount": ServerValue.increment(1) ] as [String : Any] Database.database().reference().updateChildValues(updates)
Objetivo-C
NSDictionary *updates = @{[NSString stringWithFormat: @"posts/%@/stars/%@", postID, userID]: @TRUE,
[NSString stringWithFormat: @"posts/%@/starCount", postID]: [FIRServerValue increment:@1],
[NSString stringWithFormat: @"user-posts/%@/stars/%@", postID, userID]: @TRUE,
[NSString stringWithFormat: @"user-posts/%@/starCount", postID]: [FIRServerValue increment:@1]};
[[[FIRDatabase database] reference] updateChildValues:updates];
Este código não usa uma operação de transação, portanto, não será executado novamente se houver uma atualização conflitante. Porém, como a operação de incremento acontece diretamente no servidor de banco de dados, não há chance de conflito.
Se você quiser detectar e rejeitar conflitos específicos do aplicativo, como um usuário marcando uma postagem que já marcou com estrela antes, você deverá escrever regras de segurança personalizadas para esse caso de uso.
Trabalhe com dados off-line
Se um cliente perder a conexão de rede, seu aplicativo continuará funcionando corretamente.
Cada cliente conectado a um banco de dados Firebase mantém sua própria versão interna de quaisquer dados ativos. Quando os dados são gravados, eles são gravados primeiro nesta versão local. O cliente Firebase então sincroniza esses dados com os servidores de banco de dados remotos e com outros clientes com base no "melhor esforço".
Como resultado, todas as gravações no banco de dados acionam eventos locais imediatamente, antes que qualquer dado seja gravado no servidor. Isso significa que seu aplicativo permanece responsivo independentemente da latência ou conectividade da rede.
Depois que a conectividade for restabelecida, seu aplicativo receberá o conjunto apropriado de eventos para que o cliente sincronize com o estado atual do servidor, sem precisar escrever nenhum código personalizado.
Falaremos mais sobre o comportamento offline em Saiba mais sobre recursos online e offline .
Próximos passos
- Trabalhando com listas de dados
- Aprenda como estruturar dados
- Saiba mais sobre recursos on-line e off-line