ホーム>プログラミング関連>JAVAソースコード
ダウンロード

Realm は、携帯電話、タブレット、ウェアラブル内で直接実行されるモバイル データベースです。このリポジトリには、Realm の Java バージョンのソース コードが保持されています。Realm は現在 Android 上でのみ実行されます。

レルム Kotlin

Realm Kotlin SDK は現在 GA であり、Android と Kotlin マルチプラットフォームの両方で使用できます。まだ機能を追加中ですが、新しいプロジェクトには Realm Kotlin の使用を検討してください。何か不足している点があればお知らせください。

特徴

  • モバイルファースト: Realm は、電話、タブレット、ウェアラブル内で直接実行するためにゼロから構築された初のデータベースです。
  • シンプル:データはオブジェクトとして直接公開され、コードでクエリできるため、パフォーマンスとメンテナンスの問題を抱えた ORM が不要になります。さらに、私たちは API を少数のクラスに抑えるよう懸命に努力してきました。ほとんどのユーザーは直感的に API を理解し、シンプルなアプリを数分で立ち上げて実行できるようになりました。
  • 最新: Realm は簡単なスレッド セーフ、関係、暗号化をサポートします。
  • 高速: Realm は、非常に豊富な機能セットを維持しながら、一般的な操作では生の SQLite よりも高速です。
  • デバイス同期: ユーザー、デバイス、バックエンド間でデータをリアルタイムで簡単に同期できます。テンプレート アプリケーションを無料で使い始めて、クラウド バックエンドを作成します。

はじめる

Realm をプロジェクトに追加するには、ドキュメントの詳細な手順を参照してください。

ドキュメント

Realm のドキュメントは、mongodb.com/docs/atlas/device-sdks/sdk/java/ にあります。 API リファレンスは mongodb.com/docs/atlas/device-sdks/sdk/java/api/ にあります。

助けを求める

  • 質問がありますか? : #realm タグで以前の質問を探すか、新しい質問をしてください。私たちは StackOverflow を積極的に監視し、質問に答えます。また、コミュニティ フォーラムをチェックして、何かを行う方法に関する一般的な質問について話し合うこともできます。
  • バグを見つけたと思いますか?問題を開きます。可能であれば、Realm のバージョン、完全なログ、Realm ファイル、問題を示すプロジェクトを含めてください。
  • 機能リクエストがありますか?問題を開きます。この機能で何をすべきか、そしてその機能が必要な理由を教えてください。

スナップショットの使用

まだ公式リリースにパッケージ化されていない最近のバグ修正や機能をテストしたい場合は、Sonatype OSS で入手可能な、Gradle 経由で Realm の現在の開発バージョンの-SNAPSHOTリリースを使用できます。 

 buildscript {
    repositories {
        mavenCentral()
        google()
        maven {
            url 'https://oss.sonatype.org/content/repositories/snapshots/'
        }
        jcenter()
    }
    dependencies {
        classpath "io.realm:realm-gradle-plugin:<version>-SNAPSHOT"
    }
}

allprojects {
    repositories {
        mavenCentral()
        google()
        maven {
            url 'https://oss.sonatype.org/content/repositories/snapshots/'
        }
        jcenter()
    }
}

最新のバージョン番号については、version.txt を参照してください。

レルムの構築

プリコンパイルされたバージョンを使用したくない場合は、Realm をソースから自分でビルドできます。

前提条件

  • Oracle からJDK 8 をダウンロードしてインストールします。

  • Android Studio の最新の安定バージョン。現在は 4.1.1 です。

  • Android SDK Build-Tools 29.0.3 、 Android Pie (API 29)をダウンロードしてインストールします (たとえば、Android Studio のAndroid SDK Managerを介して)。

  • CMake バージョン 3.18.4 をインストールし、Ninja をビルドします。

  • Android Studio の SDK Manager から NDK (Side-by-side) 21.0.6113669をインストールします。利用可能なすべてのバージョンを表示するには、 ☑ Show package details 」を必ずチェックしてください。

  • Android ホーム環境変数をプロファイルに追加します。 

     export ANDROID_HOME=~/Library/Android/sdk

  • macOS Finder から Android Studio を起動している場合は、次のコマンドも実行する必要があります。 

     launchctl setenv ANDROID_HOME "$ANDROID_HOME"

  • Realm Core のアーカイブを保存する場所を指定する場合は、 REALM_CORE_DOWNLOAD_DIR環境変数を定義します。これにより、コア リリース アーティファクトのキャッシュが有効になります。 

     export REALM_CORE_DOWNLOAD_DIR=~/.realmCore

    macOS ユーザーがこの環境変数を確認するには、Android Studio で次のコマンドを実行する必要もあります。 

     launchctl setenv REALM_CORE_DOWNLOAD_DIR "$REALM_CORE_DOWNLOAD_DIR"

すべてのシンボル定義 (および macOS を使用している場合はそれに付随するlaunchctlコマンド) を~/.profile (ログイン シェルがzshの場合は~/.zprofile ) に追加することをお勧めします。

  • Android Studio で Realm Java を開発する場合は、Android Studio 上で以下の手順を実行し、一部のディレクトリをインデックス対象から除外することを推奨します。ビルド後のインデックス作成フェーズが大幅に高速化されます。

    • /realm/realm-library/の下で、 Projectビューでbuild 、 .cxx 、およびdistributionフォルダーを選択します。
    • Command + Shift + Aを押して、 Find actionダイアログを開きます。デフォルトのキーマップや macOS を使用していない場合は、 Find actionを検索して、 Keymap設定でショートカット キーを見つけることができます。
    • Excluded ( Excludeではない) アクションを検索して選択します。選択したフォルダーのアイコンがオレンジ色になります (デフォルトのテーマの場合)。
    • Android Studioを再起動します。

ソースをダウンロードする

Realm Java のソース コードは git を使用してダウンロードできます。 realm-java には git サブモジュールがあるため、リポジトリのクローンを作成するときに--recursive使用します。 

 git clone [email protected]:realm/realm-java.git --recursive

または

 git clone https://github.com/realm/realm-java.git --recursive

建てる

すべての前提条件を完了すると、Realm の構築は簡単なコマンドで完了します。 

 ./gradlew assemble

このコマンドにより次のものが生成されます。

  • Realm Gradle プラグインの jar ファイル
  • Realm ライブラリの aar ファイル
  • 注釈用のjarファイル
  • 注釈プロセッサ用のjarファイル

完全なビルドが完了するまでに 1 時間以上かかる場合があります。

ソースから構築する

Realm Core のサブモジュール バージョンを使用して Realm Java を構築することができます。これを行うには、ビルド時にパラメータ-PbuildCore=trueを指定します。 

 ./gradlew assembleBase -PbuildCore=true

プロシージャー間の最適化は、パラメーター-PenableLTO=falseを使用してオフにできます。 

 ./gradlew assembleBase -PenableLTO=false`

注: Baseバリアントをビルドすると、常にレルムコアがビルドされます。

注: プロシージャ間の最適化はデフォルトで有効になっています。

注: Android Studio 内のソースからビルドする場合は、Realm プロジェクトSettings > Build, Execution, Deployment > Compiler > Command-line optionsに移動し、 -PbuildCore=trueまたは-PenableLTO=falseを追加して、Gradle パラメーターを更新する必要があります。 -PenableLTO=false 。あるいは、それをgradle.propertiesに追加することもできます。 

 buildCore=true
enableLTO=false

注: OSX 上に構築している場合は、Gatekeeper を無効にして、すべての NDK 実行可能ファイルをブロックしないようにすることもできます: sudo spctl --master-disable 。後で忘れずに有効にしてください: sudo spctl --master-enable

その他のコマンド

  • ./gradlew tasks利用可能なすべてのタスクを表示します
  • ./gradlew javadoc Javadoc を生成します
  • ./gradlew monkeyExamplesすべてのサンプルに対してモンキー テストを実行します
  • ./gradlew installRealmJava Realm ライブラリとプラグインを mavenLocal() にインストールします。
  • ./gradlew clean -PdontCleanJniFiles JNI 関連ファイルを除く、生成されたすべてのファイルを削除します。これにより、再コンパイル時間が大幅に短縮されます。
  • ./gradlew connectedUnitTests -PbuildTargetABIs=$(adb shell getprop ro.product.cpu.abi)接続されたデバイスに対応する ABI のみの JNI ファイルをビルドします。これらのテストには、オブジェクト サーバーが実行されている必要があります (下記を参照)。

上記のコマンドを使用して Javadoc を生成すると、警告が生成される場合があります。警告にもかかわらず、Javadoc は生成されます。

Gradle ラッパーのアップグレード

このリポジトリ内のすべての Gradle プロジェクトには、Gradle Wrappers を生成するwrapperタスクがあります。これらのタスクは、 /dependencies.listで定義されたgradleプロパティを参照して、生成するラッパーの Gradle バージョンを決定します。これらの手順を自動化するスクリプト./tools/update_gradle_wrapper.shがあります。 Gradle Wrappers を更新する場合は、次の手順に従ってください。

  1. /dependencies.listで定義されているgradleプロパティを新しい Gradle Wrapper バージョンに編集します。
  2. /tools/update_gradle_wrapper.shを実行します。

落とし穴

リポジトリは 6 つの Gradle プロジェクトで構成されています。

  • realm : 実際のライブラリ (JNI 層を含む) と注釈プロセッサが含まれます。
  • realm-annotations : Realm によって定義されたアノテーションが含まれます。
  • realm-transformer : バイトコード トランスフォーマーが含まれています。
  • gradle-plugin : Gradle プラグインが含まれています。
  • examples : サンプル プロジェクトが含まれています。このプロジェクトは、 realmによって生成されたアーティファクトに依存関係を追加するgradle-pluginに直接依存しています。
  • ルート フォルダーは別の Gradle プロジェクトです。他のジョブを調整するだけです。

これは、最初にassembleExamplesが実行されていない場合、 ./gradlew cleanおよび./gradlew cleanExamples失敗することを意味します。 IntelliJ は同じウィンドウ内の複数のプロジェクトをサポートしていないため、6 つの Gradle プロジェクトのそれぞれを別個の IntelliJ プロジェクトとしてインポートする必要があることに注意してください。

リポジトリには完全に独立した Gradle プロジェクトがいくつか含まれているため、それをアセンブルするためにいくつかの独立したビルドが実行されます。ビルド ログに:realm:realm-library:compileBaseDebugAndroidTestSources UP-TO-DATEのような行が表示されても./gradlew :realm:realm-library:compileBaseDebugAndroidTestSources実行できることを意味するものではありません。

例

./examplesフォルダーには、Realm の使用方法を示すサンプル プロジェクトが多数含まれています。このリポジトリの新しいバージョンを初めてチェックアウトまたはプルして例を試す場合は、最初に最上位ディレクトリから./gradlew installRealmJava呼び出す必要があります。そうしないと、サンプルはmavenLocal()にインストールされているすべての Realm アーティファクトに依存するため、コンパイルされません。

スタンドアロンのサンプルは Web サイトからダウンロードできます。

デバイス上でテストを実行する

これらのテストを実行するには、デバイスがビルド コンピューターに接続されており、 adbコマンドがPATHに含まれている必要があります。

  1. Android デバイスを接続し、コマンドadb devices接続されたデバイスが表示されることを確認します。 

    adb devices
List of devices attached
004c03eb5615429f device

  2. インストルメンテーション テストを実行します。 

     cd realm
./gradlew connectedBaseDebugAndroidTest

これらのテストが完了するまでに 30 分ほどかかる場合があります。

レルムオブジェクトサーバーを使用したテストの実行

realm/realm-library/src/syncIntegrationTestでのテストには、実行中のテスト サーバーが機能する必要があります。 tools/sync_test_server/Dockerfileから Docker イメージを構築して、テスト サーバーを実行できます。 tools/sync_test_server/start_server.sh Docker イメージを自動的に構築します。

テストサーバーをローカルで実行するには:

  1. dockerをインストールして実行します。

  2. tools/sync_test_server/start_server.shを実行します。 

     cd tools/sync_test_server
./start_server.sh

    このコマンドは、サーバーが停止するまで完了しません。

  3. インストルメンテーション テストを実行する

    新しいターミナル ウィンドウで、次を実行します。 

     cd realm
./gradlew connectedObjectServerDebugAndroidTest

VirtualBox (Genymotion) を使用している場合、テストが機能するにはネットワークをブリッジする必要があることに注意してください。これはVirtualBox > Networkで行います。 「アダプター 2」を「ブリッジアダプター」に設定します。

これらのテストが完了するまでに 30 分ほどかかる場合があります。

貢献する

詳細については、CONTRIBUTING.md を参照してください。

このプロジェクトは MongoDB の行動規範に準拠しています。参加することにより、この規範を遵守することが期待されます。容認できない行為は、[email protected] に報告してください。

ディレクトリrealm/config/studioプロジェクト コードに推奨される lint ファイルとスタイル ファイルが含まれています。これらを Android Studio からインポートするには、[Android Studio] > [設定...] > [コード スタイル] > [管理...] > [インポート]、または [Android Studio] > [設定...] > [インスペクション] > [管理...] > [インポート] を選択します。インポートしたら、「管理...」ボタンの左側にあるドロップダウンでスタイル/lint を選択します。

ライセンス

Realm Java は、Apache 2.0 ライセンスに基づいて公開されています。

Realm Core も Apache 2.0 ライセンスに基づいて公開されており、ここから入手できます。

フィードバック

Realm を使用していて満足している場合は、@realm について言及したツイートを送信して感想を共有することを検討してください。

気に入らない場合は、改善してほしい点をお知らせください。修正いたします。

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて