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 参数-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。