Instale o React Native SDK
Nesta página
O Atlas Device SDK for React Native permite o desenvolvimento do React Native aplicativos que usam as JavaScript Typescript linguagens e . React Native permite que você crie aplicativos iOS e Android multiplataforma com uma única base de código usando o React framework.
Pré-requisitos
Antes de começar, verifique se seu ambiente de desenvolvimento atende os pré-requisitos a seguir. Eles são necessários para a versão mais recente do React Native SDK:
Siga as instruções oficiais do React Native CLI Quickstart para definir seu ambiente.
React Native v0.71.4 ou posterior. Confira o gráfico de compatibilidade para determinar qual versão do React Native é compatível com React Native SDK versões específicas .
Observação
Realm JS v10.6.0 e posterior suporta Mac Catalyst
Para React Native versão 0.64 e inferior, você deve executar etapas adicionais para criar seu aplicativo ao usar o Mac Catalyst.
Use o SDK com Expo
Você pode usar o React Native SDK com um aplicativo React Native simples ou com a Expo. Esta página e a documentação do React Native SDK geralmente presumem que você está usando um aplicativo React Native simples e não o Expo.
Se você quiser usar o SDK React Native com Expo, confira a página Bootstrap with Expo.
Instalar o SDK em um aplicativo React Native simples
Selecione a guia abaixo que corresponde à sua versão do React Native. Siga as etapas para criar um projeto React Native e adicionar o React Native SDK a ele.
Dica
Atlas Device SDK e Realm
O SDK usa o banco de dados do Realm Core para persistência de dados do dispositivo. Quando você instala o React Native SDK, os nomes dos pacotes refletem o nome do Realm.
Enable Hermes
Observação
Para usar o Hermes, seu aplicativo deve usar Realm v11 ou superior e React Native 0.70,0 ou superior
O SDK oferece suporte para o mecanismo JavaScript otimizado para dispositivos móveis do React Native, o Hermes. Como padrão, novos aplicativos criados com o React Native CLI já vêm com o Hermes ativado.
Recomendamos que você use Hermes com o SDK. No entanto, o SDK também suporta o mecanismo JavaScriptCore (JSC) se seu aplicativo exigir.
Aplicativos existentes que usam o JSC podem ativar o Hermes separadamente para Android e iOS. Para saber como, consulte o Como usar o Hermes guia nos React Native Docs.
Resolver dependências de CocoaPods
Para o aplicativo para iOS, busque as dependências do CocoaPods com os seguintes comandos do diretório de projeto do React Native:
cd ios && pod install && cd ..
Isso baixa as bibliotecas do SDK e gera novamente o arquivo de projeto .xcworkspace
com o qual você pode trabalhar no Xcode para executar seu aplicação.
Habilitar TypeScript (recomendado, mas opcional)
TypeScript é um superconjunto do JavaScript que adiciona verificação de tipo estático e outros recursos destinados a tornar o desenvolvimento em escala de aplicativos mais robusto. Se você quiser usar o TypeScript em seu projeto, siga os guias oficiais TypeScript e React Native da equipe React Native. O SDK oferece suporte para o TypeScript de forma nativa e se integra facilmente a um projeto TypeScript.
Instalar a biblioteca @domínio/react
@realm/reagir é um pacote npm que simplifica operações comuns do SDK, como consultar, gravar em um banco de dados e escutar notificações de alteração de objeto. Isso reduz os códigos padrão, como a criação de seus próprios ouvintes e gerenciamento de estado.
@realm/react
fornece acesso ao SDK por meio de um conjunto de provedores que têm vários hooks. Os hooks atualizam o estado do React quando os dados mudam. Isso significa que os componentes que usam esses hooks são renderizados novamente em qualquer alteração nos dados no banco de dados.
Observação
Use @realm/react com o Realm JS versão 11 ou posterior
Para usar Realm JavaScript versão 11.0.0 ou mais tarde com @realm/React, você deve usar @realm/react
versão 0.4.0 ou mais tarde.
No diretório do projeto React Native, adicione @realm/react
ao seu projeto com o seguinte comando:
npm install @realm/react
Execute o aplicativo
O React Native permite o desenvolvimento simultâneo de um aplicativo para iOS e Android que tenha a mesma base de código do React. Você pode editar os arquivos de origem de .js
ou .ts
no diretório do projeto para desenvolver seu aplicativo.
Em desenvolvimento, os aplicativos leem o código-fonte do React como um pacote de um servidor de pacotes local. Para executar o servidor de pacotes, use o seguinte comando em seu diretório de projeto do React Native:
npm start
Com o servidor de pacotes em execução, agora você pode iniciar os aplicativos Android e iOS:
Para executar o aplicativo para Android, use o Android Studio para abrir o diretório
android
no diretório do projeto e clique em Run.Para executar o aplicativo iOS, use o Xcode para abrir o arquivo
.xcworkspace
no diretórioios
. Se você não usou o CocoaPods durante a configuração, abra o arquivo.xcodeproj
no diretórioios
. Após abrir o projeto, clique em Run.
Observação
Requisitos da versão @ Realm/React
O Realm@ /React A biblioteca requer React-native >= 0.59
versão. Se você estiver desenvolvendo usando versões mais antigas do React Native, poderá usar o SDK sem @realm/react
. Como a documentação do React Native SDK faz uso pesado do pacote @realm/react
, consulte a documentação do Node.js SDK
Confirmar a etapa do link (Android)
Para desenvolvimento para Android, confirme se a etapa do link adicionou corretamente o módulo SDK aos arquivos de configuração do Gradle. Em algumas versões, sabe-se que o React Native não vincula o SDK corretamente. Se isso acontecer, você poderá vincular o SDK manualmente adicionando as linhas ausentes abaixo aos arquivos correspondentes.
Primeiro, certifique-se de que o arquivo android/settings.gradle
inclua o SDK e especifique o diretório de projeto do SDK:
rootProject.name = 'MyApp' include ':realm' project(':realm').projectDir = new File(rootProject.projectDir, '../node_modules/realm/android') apply from: file("../node_modules/@react-native-community/cli-platform-android/native_modules.gradle"); applyNativeModulesSettingsGradle(settings) include ':app'
Em segundo lugar, verifique se a seção android/app/build.gradle
do arquivo dependencies
declara o SDK como uma dependência:
dependencies { implementation project(':realm') implementation fileTree(dir: "libs", include: ["*.jar"]) implementation "com.facebook.react:react-native:+" // From node_modules // ... }
Por fim, certifique-se de que o arquivo MainApplication.java
importe o RealmReactPackage
e o instancie em sua lista de pacotes.
import io.realm.react.RealmReactPackage; // Add this import. public class MainApplication extends Application implements ReactApplication { protected List<ReactPackage> getPackages() { return Arrays.<ReactPackage>asList( new MainReactPackage(), new RealmReactPackage() // Add this line. ); } // ... }
Habilitar TypeScript (opcional)
TypeScript é um superconjunto do JavaScript que adiciona verificação de tipo estático e outros recursos destinados a tornar o desenvolvimento em escala de aplicativos mais robusto. Se você quiser usar o TypeScript em seu projeto, siga os guias oficiais TypeScript e React Native da equipe React Native. O SDK oferece suporte para o TypeScript de forma nativa e se integra facilmente a um projeto TypeScript.
Execute o aplicativo
O React Native permite o desenvolvimento simultâneo de um aplicativo para iOS e Android que tenha a mesma base de código do React. Você pode editar os arquivos de origem de .js
ou .ts
no diretório do projeto para desenvolver seu aplicativo.
Em desenvolvimento, os aplicativos leem o código-fonte do React como um pacote de um servidor de pacotes local. Para executar o servidor de pacotes, use o seguinte comando em seu diretório de projeto do React Native:
npm start
Com o servidor de pacotes em execução, agora você pode iniciar os aplicativos Android e iOS:
Para executar o aplicativo para Android, use o Android Studio para abrir o diretório
android
no diretório do projeto e clique em Run.Para executar o aplicativo iOS, use o Xcode para abrir o arquivo
.xcworkspace
no diretórioios
. Se você não usou o CocoaPods durante a configuração, abra o arquivo.xcodeproj
no diretórioios
. Após abrir o projeto, clique em Run.
Importar o SDK
Adicione a linha seguinte ao topo dos seus arquivos-fonte onde você deseja usar o SDK:
import Realm from "realm";