realm java下載 - realm java原始碼下載

realm java

JAVA源碼

1.0.0

下載

Realm 是一個直接在手機、平板電腦或穿戴式裝置內運作的行動資料庫。該儲存庫包含 Java 版本 Realm 的原始程式碼，目前僅在 Android 上運行。

Kotlin 領域

Realm Kotlin SDK 現已正式發布，可用於 Android 和 Kotlin 多平台。雖然我們仍在添加功能，但請考慮在任何新專案中使用 Realm Kotlin，如果您錯過了任何內容，請告訴我們！

特徵

行動優先： Realm 是第一個從頭開始建立的直接在手機、平板電腦和穿戴式裝置中運行的資料庫。
簡單：資料直接作為物件公開並可透過程式碼查詢，從而消除了充滿效能和維護問題的 ORM 的需要。另外，我們努力將我們的 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 檔案以及顯示問題的項目。
有功能請求嗎？打開一個問題。告訴我們該功能應該做什麼，以及您為什麼需要該功能。

使用快照

如果您想測試最近的錯誤修復或尚未打包在正式版本中的功能，您可以透過 Gradle 使用 Realm 目前開發版本的-SNAPSHOT版本，該版本可在 Sonatype OSS 上使用

 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 管理員安裝 NDK（並排） 21.0.6113669 。請記住選取☑ Show package details以顯示所有可用版本。
將 Android home 環境變數新增到您的設定檔中：
```
 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"
```

最好將所有符號定義（以及它們附帶的launchctl命令，如果您使用的是 macOS）添加到~/.profile （如果登入 shell 是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。

下載原始碼

您可以使用git下載Realm Java的原始程式碼。由於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 文件

完整的建造可能需要一個小時或更長時間才能完成。

從源頭構建

可以使用 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.properties ：

 buildCore=true
enableLTO=false

注意：如果在 OSX 上構建，您可能希望透過停用 Gatekeeper 來阻止所有 NDK 可執行檔： sudo spctl --master-disable 。請記住隨後啟用它： sudo spctl --master-enable

其他命令

./gradlew tasks將顯示所有可用的任務
./gradlew javadoc將生成 Javadocs
./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 項目都有wrapper任務來產生 Gradle 包裝器。這些任務引用/dependencies.list中定義的gradle屬性來決定生成包裝器的 Gradle 版本。我們有一個腳本./tools/update_gradle_wrapper.sh來自動執行這些步驟。當您更新 Gradle Wrappers 時，請遵循以下步驟。

將/dependencies.list中定義的gradle屬性編輯為新的 Gradle Wrapper 版本。
執行/tools/update_gradle_wrapper.sh 。

陷阱

此儲存庫分為六個 Gradle 項目：

realm ：它包含實際的函式庫（包括 JNI 層）和註解處理器。
realm-annotations ：它包含 Realm 定義的註解。
realm-transformer ：它包含字節碼轉換器。
gradle-plugin ：它包含 Gradle 插件。
examples ：它包含範例項目。該專案直接依賴gradle-plugin ，它添加了對realm產生的工件的依賴關係。
根資料夾是另一個 Gradle 專案。它所做的只是協調其他工作。

這意味著如果assembleExamples尚未先執行，則./gradlew clean和./gradlew cleanExamples將失敗。請注意，IntelliJ 不支援同一視窗中的多個項目，因此六個 Gradle 專案中的每一個都必須作為單獨的 IntelliJ 項目匯入。

由於儲存庫包含幾個完全獨立的 Gradle 項目，因此需要運行多個獨立的建置來組裝它。在建置日誌中看到類似以下的行： :realm:realm-library:compileBaseDebugAndroidTestSources UP-TO-DATE並不代表您可以執行./gradlew :realm:realm-library:compileBaseDebugAndroidTestSources 。

範例

./examples資料夾包含許多範例項目，展示如何使用 Realm。如果這是您第一次簽出或拉取此儲存庫的新版本來嘗試範例，則必須先從頂層目錄呼叫./gradlew installRealmJava 。否則，這些範例將無法編譯，因為它們依賴mavenLocal()中安裝的所有 Realm 工件。

獨立的範例可以從網站下載。

在設備上執行測試

要執行這些測試，您必須有一個設備連接到建置計算機，並且adb命令必須位於您的PATH中

連接 Android 裝置並驗證命令adb devices顯示已連接的裝置：
```
adb devices
List of devices attached
004c03eb5615429f device
```

運行儀器測試：

 cd realm
./gradlew connectedBaseDebugAndroidTest

這些測試可能需要長達半小時才能完成。

使用領域對象伺服器執行測試

realm/realm-library/src/syncIntegrationTest中的測試需要正在執行的測試伺服器才能運作。可以從tools/sync_test_server/Dockerfile建置 docker 映像來執行測試伺服器。 tools/sync_test_server/start_server.sh將自動建置 docker 映像。

要在本機上運行測試伺服器：

安裝 docker 並運行它。
執行tools/sync_test_server/start_server.sh ：
```
 cd tools/sync_test_server
./start_server.sh
```
在伺服器停止之前，此命令不會完成。

運行儀器測試

在新的終端機視窗中，運行：

 cd realm
./gradlew connectedObjectServerDebugAndroidTest

請注意，如果使用 VirtualBox (Genymotion)，則需要橋接網路才能使測試正常運作。這是在VirtualBox > Network中完成的。將“適配器 2”設定為“橋接適配器”。

這些測試可能需要長達半小時才能完成。

貢獻

請參閱 CONTRIBUTING.md 以了解更多詳細資訊！

該項目遵守 MongoDB 行為準則。透過參與，您應該遵守此準則。請將不可接受的行為回報至[email protected]。

目錄realm/config/studio包含建議用於專案程式碼的 lint 和樣式檔案。使用 Android Studio > Preferences... > Code Style > Manage... > Import 或 Android Studio > Preferences... > Inspections > Manage... > Import 從 Android Studio 匯入它們。匯入後，在「管理...」按鈕左側的下拉清單中選擇樣式/lint。