Realm のインストール - Java SDK

項目一覧

Overview

前提条件
インストール
プロジェクト Gradle 構成
アプリケーションモジュール Gradle 構成
Atlas Device Sync の有効化
サポートされているプラットフォーム

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

注意

メンテナンスモードでの Java SDK

Java SDK はベストエフォートメンテナンスモードになっており、新しい開発または非致命的なバグ修正は行われなくなりました。新機能を使用してアプリを開発するには、 Kotlin SDKを使用します。同じプロジェクトで Java SDK と Kotlin SDK を使用できます。

Java SDK から Kotlin SDK に移行する方法の詳細については、こちらを参照してください。

注意

新しい Java SDK アプリでは RealmAny を使用できません

新しい App Services アプリは、 RealmAnyタイプのプロパティを持つデータモデルを同期できません。

Overview

このページでは、プロジェクトに Java SDK を使用して Realm をインストールし、開始する方法について詳しく説明します。

プロジェクトでは複数の SDK を使用できます。 Java SDK は新しい開発を受け入れなくなったため、アプリで新機能を使用したい場合に役立ちます。たとえば、Atlas Device Sync のData Ingest機能を Kotlin SDK を使用してアプリに追加すると同時に、他のすべての操作に Java を引き続き使用できます。

前提条件

Android Studio バージョン1 。5 。1またはそれ以上
Java 開発キット（JDK） 11 以上
テスト用のエミュレートデバイスまたはハードウェア Android デバイス。
Android API レベル 16 以上（Android 4.1 以上）。

インストール

Realm は Gradle ビルドシステムのみをサポートしています。 Realm Java SDK をプロジェクトに追加するには、次の手順に従います。

注意

ProGuard

Realm は Realm ライブラリの一部として ProGuid 構成を提供するため、ProGuド構成に Realm 固有のルールを追加する必要はありません。

プロジェクト Gradle 構成

アプリケーションにローカル専用の Realm を追加するには、プロジェクトレベルの Gradle ビルドファイル（通常は<project>/build.gradleにあります）に次の変更を加えます。

Tip

Java SDKはまだ Gradle プラグイン構文をサポートしていません。幸いなことに、この構文を使用するプロジェクトに SDK を追加することはできます。

repositoriesブロックとdependenciesブロックを含むbuildscriptブロックを追加します。
mavenCentral()リポジトリをbuildscript.repositoriesブロックに追加します。
io.realm:realm-gradle-pluginの依存関係を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
}

io.realm:realm-gradle-pluginの依存関係をbuildscript.dependenciesブロックに追加します。
mavenCentral()リポジトリを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
}

アプリケーションモジュール Gradle 構成

次に、アプリケーションレベルの Gradle ビルドファイル（通常は<project>/app/build.gradleにあります）に次の変更を加えます。

アプリケーションで Kotlin を使用している場合は、 kotlin-kaptプラグインを適用します
pluginsブロックの下に、 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'
}

アプリケーションで Kotlin を使用している場合は、 kotlin-kaptプラグインを適用します
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"
}

build.gradleファイルを更新した後、 File > Sync Project with Gradle Filesをクリックして依存関係を解決します。

Atlas Device Sync の有効化

アプリケーションで Atlas Device Sync を使用するには、アプリケーションモジュールbuild.gradleにrealmブロックを作成します。このブロック内で、 syncEnabledをtrueに設定します。

realm {
    syncEnabled = true
}

サポートされているプラットフォーム

Realm の Java SDK を使用すると、次のプラットフォーム向けのアプリを構築できます。

Android
OS を使用
Android オートメーション OS
Android設定
Android モノ

Atlas Device SDK Docsへようこそ

注意

メンテナンス モードでの Java SDK

注意