SquiDB 开源项目安装与使用指南

目录结构及介绍

当您通过 git clone https://github.com/yahoo/squidb.git 克隆 SquiDB 项目后, 您将会看到以下主要目录:

1. squidb-android

此目录包含了针对 Android 平台的 SquiDB 实现. 这部分代码提供了类型安全的对象映射以及面向对象的 SQL 构建器.

2. squidb-ios

虽然此目录名称暗示着这是用于 iOS 的代码, 但是请注意, 截至最新提交, SquiDB 主要关注 Android 平台. 不过, 由于 SquiDB 使用了 Google 的 j2objc 工具进行跨平台支持, 因此这个目录可能随着项目发展而完善.

3. squidb-common

这里存放的是共同代码, 包括数据访问对象 (DAO), SQL 语句构建等基础组件.

4. squidb-processor

此目录包含 SquiDB 注解处理器. 这个工具负责读取并解析你的 DAO 和实体类定义, 自动生成相应的 SQL 查询代码.

5. tests

测试目录, 包含了单元测试和其他质量保障相关的代码.

启动文件介绍

SquiDB 作为一个库, 自身并没有可直接运行的 "主" 函数. 然而, 在集成 SquiDB 到您的 Android 或者其他基于 Java 的项目中时, 下列步骤必不可少:

1. 添加依赖

在你的项目 build.gradle 文件中添加 SquiDB 的依赖:

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

如果你使用 Kotlin 或者特定插件（如 android-apt）则需做适当调整.

2. 创建数据模型

接下来, 根据你的数据需求创建实体和 DAO 类.

3. 初始化数据库

在你的应用程序生命周期合适的位置初始化 SquiDB 数据库:

public class App extends Application {

    private static Database mDatabase;

    @Override
    public void onCreate() {
        super.onCreate();
        mDatabase = new SquidDatabase.Builder(this)
            .addDao(Foo.class)
            .addDao(Bar.class)
            .build();
    }
}

配置文件介绍

SquiDB 库本身没有独立的配置文件, 它的设计允许你在应用层面自定义数据库行为. 主要是通过 Builder 设计模式在实例化数据库时传递参数. 如上所示, 你可以在这个阶段添加你需要的 DAO 类, 设置缓存策略, 日志级别等等.

此外, res/xml/squidb_database.xml 文件可用于控制默认的行为, 如日志记录等级, 缓存大小和事务处理方式. 然而在许多情况下, 这些选项通常在代码中直接通过 Builder API 来设置更为灵活.

总结而言, SquiDB 强调代码优先的配置方法, 让开发人员能够更灵活地控制其在不同环境下的表现.