android 中Greendao使用和数据库升级

原创

mob64ca12d94299 2024-09-07 05:20:19 ©著作权

文章标签 User 数据库升级 java 文章分类 Android 移动开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d94299的原创作品，请联系作者获取转载授权，否则将追究法律责任

Android 中 GreenDAO 使用及数据库升级指南

GreenDAO 是一个轻量级的 ORM（对象关系映射）库，可以帮助开发者在 Android 应用中方便地使用数据库。在本篇文章中，我们将逐步指导你完成 GreenDAO 的使用以及如何处理数据库升级。

整体流程概述

以下是使用 GreenDAO 时的一般步骤：

步骤	描述
1	添加依赖
2	创建实体类
3	创建 DAO 及数据库管理类
4	实现数据的插入和查询
5	数据库升级的处理
6	测试和验证

详细步骤及代码示例

1. 添加依赖

首先，在 build.gradle 中添加 GreenDAO 的依赖：

dependencies {
    implementation 'org.greenrobot:greendao:3.3.0'
}

这段代码将 GreenDAO 库添加到项目中。

2. 创建实体类

创建一个数据实体类，例如 User：

@Entity
public class User {
    @Id
    private Long id;  // 用户ID

    private String name;  // 用户名

    // Getter 和 Setter 方法
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

@Entity 注解用于定义一个实体类，@Id 注解标记主键字段。

3. 创建 DAO 及数据库管理类

使用 GreenDAO 提供的工具生成 DAO 类，并实现 DaoMaster 和 DaoSession：

// 在 Application 中配置 GreenDAO
public class MyApp extends Application {
    private DaoSession daoSession;

    @Override
    public void onCreate() {
        super.onCreate();
        setupDatabase();
    }

    private void setupDatabase() {
        DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "mydatabase-db", null);
        SQLiteDatabase db = helper.getWritableDatabase();
        daoSession = new DaoMaster(db).newSession();
    }

    public DaoSession getDaoSession() {
        return daoSession;
    }
}

该代码段负责初始化数据库连接和 DAO 会话。

4. 实现数据的插入和查询

插入数据的示例：

User user = new User();
user.setName("Alice");
// 获取 DAO 并插入
daoSession.getUserDao().insert(user);

这段代码创建一个 User 对象，并调用 insert 方法将其保存到数据库中。

查询数据的示例：

List<User> users = daoSession.getUserDao().loadAll();
for (User user : users) {
    Log.d("User", user.getName());
}

使用 loadAll 方法获取所有用户数据并输出。

5. 数据库升级的处理

在更新数据库结构时，需处理数据库升级。我们需要重写 onUpgrade 方法：

public class MyOpenHelper extends DaoMaster.OpenHelper {
    public MyOpenHelper(Context context, String name) {
        super(context, name);
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        // 这里根据需要实现数据迁移
        switch (oldVersion) {
            case 1:
                // 例如：添加新字段
                db.execSQL("ALTER TABLE 'USER' ADD COLUMN 'age' INTEGER");
                // 继续添加更高的版本
            case 2:
                // 处理 version 2 升级
                break;
        }
    }
}

使用 execSQL 方法执行 SQL 语句，处理数据库结构修改。

6. 状态图和类图

接下来，来展示相关的状态图和类图：

stateDiagram
    [*] --> Start
    Start --> EntityCreated
    EntityCreated --> DaoCreated
    DaoCreated --> DataOperations
    DataOperations --> UpgradeHandled
    UpgradeHandled --> End

classDiagram
    class User {
        +Long id
        +String name
        +getId()
        +setId()
        +getName()
        +setName()
    }

    class UserDao {
        +insert(user: User)
        +loadAll(): List<User>
    }

    class MyApp {
        +setupDatabase()
        +getDaoSession(): DaoSession
    }