SquiDB 开源项目教程

项目介绍

SquiDB 是一个为 Android 和 iOS 设计的跨平台 SQLite 数据库层。它旨在使开发者能够尽可能简单地使用 SQLite 数据库，同时仍然提供原始 SQL 的强大功能和灵活性。SquiDB 结合了类型安全的对象（代表表行）和面向对象的 SQL 语句构建器，使读写数据变得容易，无需处理复杂的 SQL 字符串。此外，它还包括内置工具和钩子，帮助开发者轻松编写数据库迁移和实现 ContentProviders。

项目快速启动

添加依赖

首先，在你的 Android 项目中添加 SquiDB 依赖。在 build.gradle 文件中添加以下代码：

dependencies {
    implementation 'com.yahoo.squidb:squidb:3.2.3'
    annotationProcessor 'com.yahoo.squidb:squidb-processor:3.2.3'
}

如果你使用的是 Kotlin，请使用 kapt 代替 annotationProcessor：

dependencies {
    implementation 'com.yahoo.squidb:squidb:3.2.3'
    kapt 'com.yahoo.squidb:squidb-processor:3.2.3'
}

创建数据库模型

创建一个 Java 类来定义你的数据库表：

import com.yahoo.squidb.annotations.TableModelSpec;

@TableModelSpec(className = "Person", tableName = "people")
public class PersonSpec {
    public String firstName;
    public String lastName;
    public int age;
}

初始化数据库

在你的应用中初始化数据库：

import com.yahoo.squidb.data.SquidDatabase;
import com.yahoo.squidb.sql.Table;

public class MyDatabase extends SquidDatabase {
    @Override
    public String getName() {
        return "mydatabase.db";
    }

    @Override
    protected Table[] getTables() {
        return new Table[]{
            Person.TABLE
        };
    }
}

使用数据库

在你的应用中使用数据库：

MyDatabase database = new MyDatabase();
Person person = new Person();
person.setFirstName("John");
person.setLastName("Doe");
person.setAge(30);
database.persist(person);

应用案例和最佳实践

应用案例

SquiDB 可以用于各种需要本地数据存储的应用，例如：

• 任务管理应用：存储任务列表和详细信息。
• 笔记应用：存储笔记和标签。
• 健康追踪应用：存储用户的健康数据。

最佳实践

• 数据库迁移：使用 SquiDB 的内置工具轻松管理数据库版本和迁移。
• 内容提供者：利用 SquiDB 实现 ContentProviders，方便与其他应用共享数据。
• 响应式架构：使用 squidb-reactive 库实现响应式数据更新。

典型生态项目

SquiDB 可以与其他开源项目结合使用，例如：

• Retrofit：用于网络请求，将数据同步到本地数据库。
• Room：另一个 Android 数据库库，可以与 SquiDB 结合使用，提供更丰富的功能。
• RxJava：用于处理异步数据流，与 squidb-reactive 结合使用，实现响应式编程。

通过这些模块的介绍和示例，你可以快速上手并充分利用 SquiDB 的功能，为你的跨平台应用提供强大的本地数据存储解决方案。