入门
下载Realm for Android或者在Github realm-java上查看源代码.
原文链接
https://realm.io/docs/java/latest/#getting-started
开发条件
- 我们目前不支持Android之外的Java。
- Android Studio> = 1.5.1
- 最近版本的Android SDK。
- JDK version> = 7。
- 我们支持所有Android版本自API Level 9(Android 2.3 Gingerbread及以上)
安装
Realm安装为Gradle插件。
将Realm安装为Gradle插件需要两个步骤。
步骤1:将以下类路径依赖项添加到项目级build.gradle文件。
buildscript {
repositories {
jcenter()
}
dependencies {
classpath "io.realm:realm-gradle-plugin:3.0.0"
}
}
项目级的build.gradle的位置如下
步骤2:将realm-android插件应用到应用程序级build.gradle文件的顶部。
应用程序级的build.gradle的位置如下
一旦这两个更改完成,只需刷新你的gradle依赖项。 如果你从v0.88之前的版本升级,你可能还需要清洁gradle项目(./gradlew clean)以删除任何遗留的以前的安装。
可以在这里找到两个修改的build.gradle文件的示例:
- 项目级build.gradle
- 应用程序级build.gradle
其他构建系统
不支持Maven&Ant构建系统。 如果你希望看到这些构建系统的支持,请表达你对以下问题的兴趣,然后我们会权衡是否需要添加这种支持。
- Maven支持
- Ant 支持
你的意见将决定我们是否以及何时实现Ant和Maven插件。
从v1.0.0起,不支持Eclipse。 我们建议迁移到Android Studio。
ProGuard
ProGuard配置作为Realm库的一部分提供。 这意味着你不需要为Realm配置任何ProGuard规则。
Realm 浏览器
我们提供独立的Realm浏览器,用于读取和编辑Realm数据库
你可以使用菜单项“ Tools > Generate demo database ”生成带有示例数据的测试数据库。
如果你在查你的应用程序的Realm文件上遇到了问题,就去看下StackOverflow答案详细说明。
Realm浏览器可以在Mac App Store上找到,也可以从我们GitHub页面下载。
浏览器目前不能在Windows或Linux上运行。 在这些平台上,你可以使用Stetho-Realm。 Stetho是由Facebook创建的Chrome浏览器的Android调试桥。
API指南
想知道关于类、方法和其他内容,请查阅API指南
示例
看看我们的例子,看看Realm在应用程序中是如何实践。 有关如何运行示例的更多详细信息,请参阅此处。
introExample包含如何使用当前API的简单示例。
gridViewExample是一个简单的应用程序,显示如何使用Realm作为GridView的后台存储。 它还显示了如何使用GSON使用JSON填充数据库,以及如何使用ABI拆分将最终APK的大小最小化。
threadExample是一个简单的应用程序,显示如何在多线程环境中使用Realm。
adapterExample显示了如何使用RealmBaseAdapter和RealmRecyclerViewAdapter来使Realm以优雅的方式与Android ListView和RecyclerView一起工作。
jsonExample说明了如何使用新的Realm JSON功能呢。
encryptionExample显示如何使用加密的Realms。
rxJavaExamples显示了Realm如何与RxJava一起工作。
unitTestExample显示了如何在使用Realm时编写单元测试。