Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Atlas Device SDKs

Instalar Realm - Java SDK

Nesta página

  • Visão geral
  • Pré-requisitos
  • Instalação
  • Configuração do projeto Gradle
  • Configuração do módulo de aplicativo Gradle
  • Ativar o Atlas Device Sync
  • Plataformas suportadas

Observação

Java SDK no modo de manutenção

O Java SDK está no modo de manutenção da melhor maneira possível e não recebe mais novos desenvolvimentos ou correções de bugs não críticos. Para desenvolver seu app com novos recursos, use o Kotlin SDK. Você pode usar o Java SDK com o Kotlin SDK no mesmo projeto.

Saiba mais sobre como Migrar do Java SDK para o Kotlin SDK.

Observação

Novas aplicações Java SDK não podem usar RealmAny

Os novos aplicativos App Services não poderão sincronizar modelos de dados com propriedades do tipo RealmAny.

Visão geral

Esta página detalha como instalar o Realm usando o Java SDK em seu projeto e como começar.

Você pode utilizar vários SDKs em seu projeto. Como o Java SDK não está mais recebendo novos desenvolvimentos, isso é útil se você quiser usar novos recursos em seu app. Por exemplo, você pode adicionar o recurso de ingestão de dados do Atlas Device Sync ao seu aplicativo usando o Kotlin SDK e continuar usando Java para o resto.

Pré-requisitos

Instalação

O Realm oferece suporte apenas ao sistema de construção Gradle. Siga estas etapas para adicionar o Realm Java SDK ao seu projeto.

Observação

ProGuard

Como o Realm fornece uma configuração do ProGuard como parte da biblioteca do Realm, você não precisa adicionar regras específicas do Realm à configuração do ProGuard.

Configuração do projeto Gradle

Para adicionar Realm somente local ao seu aplicativo, faça as seguintes alterações no arquivo de construção do Gradle no nível do projeto, normalmente encontrado em <project>/build.gradle:

Dica

O Java SDK ainda não é compatível com a sintaxe Gradle Plugin. Felizmente, você ainda pode adicionar o SDK a projetos que usam essa sintaxe.

  • Adicione um bloco buildscript que contenha um bloco repositories e um bloco dependencies.

  • Adicione o repositório mavenCentral() ao bloco buildscript.repositories.

  • Adicione a dependência io.realm:realm-gradle-plugin ao bloco buildscript.dependencies.

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "io.realm:realm-gradle-plugin:10.18.0"
    }
}
plugins {
    id 'com.android.application' version '7.1.2' apply false
    id 'com.android.library' version '7.1.2' apply false
    id 'org.jetbrains.kotlin.android' version '1.6.10' apply false
    id "org.jetbrains.kotlin.kapt" version "1.6.20" apply false
}
task clean(type: Delete) {
    delete rootProject.buildDir
}

  • Adicione a dependência io.realm:realm-gradle-plugin ao bloco buildscript.dependencies.

  • Adicione o repositório mavenCentral() ao bloco allprojects.repositories.

buildscript {
    repositories {
        google()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:3.5.1"
        classpath "io.realm:realm-gradle-plugin:10.18.0"
    }
}
allprojects {
    repositories {
        google()
        mavenCentral()
    }
    dependencies {
    }
}
task clean(type: Delete) {
    delete rootProject.buildDir
}

Configuração do módulo de aplicativo Gradle

Em seguida, faça as seguintes alterações no arquivo de construção Gradle do seu aplicativo, normalmente encontrado em <project>/app/build.gradle:

  • Aplique o plugin kotlin-kapt se o seu aplicativo usar o Kotlin

  • Abaixo do bloco plugins, aplique o plugin realm-android.

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
    id 'org.jetbrains.kotlin.kapt'
}
apply plugin: "realm-android"
android {
    compileSdk 31
    defaultConfig {
        applicationId "com.mongodb.example-realm-application"
        minSdk 28
        targetSdk 31
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_11
        targetCompatibility JavaVersion.VERSION_11
    }
    kotlinOptions {
        jvmTarget = '11'
    }
}
dependencies {
    implementation 'io.realm:realm-gradle-plugin:10.10.1'
    implementation 'androidx.core:core-ktx:1.7.0'
    implementation 'androidx.appcompat:appcompat:1.4.1'
    implementation 'com.google.android.material:material:1.5.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

  • Aplique o plugin kotlin-kapt se o seu aplicativo usar o Kotlin

  • Aplique o plug-in realm-android

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'realm-android'
android {
    compileSdkVersion 31
    buildToolsVersion "29.0.2"
    defaultConfig {
        applicationId "com.mongodb.example-realm-application"
        minSdkVersion 28
        targetSdkVersion 31
    }
    compileOptions {
        sourceCompatibility 1.11
        targetCompatibility 1.11
    }
    kotlinOptions {
        jvmTarget = '11'
    }
}
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    implementation "androidx.appcompat:appcompat:1.1.0"
    implementation "androidx.core:core-ktx:1.2.0"
}

Após atualizar os arquivos build.gradle , resolva as dependências clicando em File > Sync Project with Gradle Files.

Ativar o Atlas Device Sync

Para utilizar Atlas Device Sync na sua aplicação, crie um bloco realm no seu módulo de aplicação build.gradle. Dentro deste bloco, defina syncEnabled como true.

realm {
    syncEnabled = true
}

Plataformas suportadas

O Java SDK do Realm permite que você construa apps para as seguintes plataformas:

  • Android

  • Wear OS

  • Android Automotive OS

  • AndroidTV

  • Android Things

Próximo

Bem-vindo aos Docs do Atlas Device SDK