Android Orma 开源项目最佳实践

1. 项目介绍

Android Orma 是一个面向 Android 应用的对象关系映射（ORM）库。它通过在编译时使用注解处理生成助手类，实现了类型安全的查询构建器。Orma 的接口简洁易用，遵循了 Larry Wall 的格言：“简单的事情应该简单，困难的事情应该可能”。它的特点包括：

• 快速，接近手写代码的速度
• POJO 模型，无限制的模型类
• 支持模型类实现 Parcelable 或扩展其他类
• 支持跨线程传递模型类实例
• 易于迁移，自动处理ALTER TABLE操作，如添加或删除列
• 类型安全，支持代码补全
• 支持自定义原始查询

2. 项目快速启动

添加依赖

在项目的 build.gradle 文件中声明 Orma 和其注解处理器的依赖：

dependencies {
    annotationProcessor 'com.github.maskarade.android.orma:orma-processor:6.0.2'
    compile 'com.github.maskarade.android.orma:orma:6.0.2'
}

定义模型类

创建一个注解为 @Table 的模型类，该类包含至少一个 @Column 或 @PrimaryKey 注解的字段：

@Table
public class Todo {
    @PrimaryKey(autoincrement = true)
    public long id;

    @Column(indexed = true)
    public String title;

    @Column
    @Nullable
    public String content;

    @Column
    public long createdTimeMillis;
}

配置数据库

实例化一个由 orma-processor 生成的 OrmaDatabase 类，通常作为单例使用：

OrmaDatabase orma = OrmaDatabase.builder(context)
        .name("main.db")
        .build();

数据操作

使用 OrmaDatabase 对象进行创建、读取、更新和删除操作：

// 创建
Todo todo = ...;
orma.insertIntoTodo(todo);

// 读取
orma.selectFromTodo()
        .titleEq("foo")
        .executeAsObservable()
        .subscribe(...);

// 更新
orma.updateTodo()
        .titleEq("foo")
        .content("a new content")
        .execute();

// 删除
orma.deleteFromTodo()
        .titleEq("foo")
        .execute();

3. 应用案例和最佳实践

• 迁移管理：Orma 会自动处理表结构变更，但是在复杂的迁移场景中，建议手动编写迁移脚本来确保数据安全。
• 线程管理：Orma 支持在异步任务中执行数据库操作，确保不在主线程中进行耗时操作。
• 类型适配器：对于复杂的数据类型，可以使用 Orma 的类型适配器来支持序列化和反序列化。

4. 典型生态项目

Orma 作为 Android 的 ORM 库，其生态项目可能包括：

• 与流行的 Android 开发工具和库的集成，如 Retrofit、Dagger 等。
• 社区贡献的扩展库，提供额外的功能，如加密支持或高级查询优化。
• 教程和示例项目，帮助开发者快速上手和使用 Orma。