Jetpack Room高级用法

2024-01-28 16:55:40

在上一篇中，我们对Room进行了ViewModel+LiveData封装。在本篇中，将会讲解Room对应的升级与预填充。直接开始吧！

数据库升级

Room提供了Migration API，用于在数据库架构发生变化时进行数据库升级。Migration API允许您指定从旧版本数据库到新版本数据库的迁移路径。

为了使用Migration API，您需要在数据库类中实现onUpgrade()方法。onUpgrade()方法接收两个参数：旧版本数据库和新版本数据库。您可以在onUpgrade()方法中编写代码来将旧版本数据库中的数据迁移到新版本数据库中。

例如，假设您有一个名为User的实体类，并且您在User实体类中添加了一个名为age的字段。为了将旧版本数据库中的数据迁移到新版本数据库中，您可以在onUpgrade()方法中编写以下代码：

@Override
public void onUpgrade(SupportSQLiteDatabase db, int oldVersion, int newVersion) {
    if (oldVersion == 1 && newVersion == 2) {
        db.execSQL("ALTER TABLE User ADD COLUMN age INTEGER");
    }
}

这段代码首先检查数据库的旧版本和新版本是否分别为1和2。如果满足这个条件，则执行SQL语句"ALTER TABLE User ADD COLUMN age INTEGER"。这条SQL语句会在User表中添加一个名为age的整型字段。

您可以在数据库类中添加多个onUpgrade()方法来处理不同的数据库版本升级。例如，如果您在User实体类中又添加了一个名为address的字段，则可以在数据库类中添加以下onUpgrade()方法：

@Override
public void onUpgrade(SupportSQLiteDatabase db, int oldVersion, int newVersion) {
    if (oldVersion == 2 && newVersion == 3) {
        db.execSQL("ALTER TABLE User ADD COLUMN address TEXT");
    }
}

数据预填充

Room提供了两种方法来预填充数据：使用@Insert注解和使用@Update注解。

使用`@Insert`注解预填充数据

您可以使用@Insert注解来预填充数据。@Insert注解可以用于实体类和数据访问对象(DAO)方法。

例如，假设您有一个名为User的实体类，并且您要预填充一个名为John的用户。您可以使用以下代码来预填充John用户：

@Entity
public class User {
    @PrimaryKey(autoGenerate = true)
    private int id;
    private String name;
    private int age;

    //省略getter和setter方法
}

@Dao
public interface UserDao {
    @Insert
    void insert(User user);
}

public class MainActivity extends AppCompatActivity {
    private UserDao userDao;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        userDao = Room.databaseBuilder(this, AppDatabase.class, "app-database")
                .build()
                .userDao();

        User user = new User();
        user.setName("John");
        user.setAge(25);

        userDao.insert(user);
    }
}

这段代码首先定义了一个名为User的实体类，然后定义了一个名为UserDao的数据访问对象(DAO)接口。在MainActivity类中，首先获取UserDao实例，然后创建一个名为John的用户对象，并将其插入到数据库中。

使用`@Update`注解预填充数据

您可以使用@Update注解来预填充数据。@Update注解可以用于实体类和数据访问对象(DAO)方法。

例如，假设您有一个名为User的实体类，并且您要预填充一个名为John的用户。您可以使用以下代码来预填充John用户：

@Entity
public class User {
    @PrimaryKey(autoGenerate = true)
    private int id;
    private String name;
    private int age;

    //省略getter和setter方法
}

@Dao
public interface UserDao {
    @Update
    void update(User user);
}

public class MainActivity extends AppCompatActivity {
    private UserDao userDao;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        userDao = Room.databaseBuilder(this, AppDatabase.class, "app-database")
                .build()
                .userDao();

        User user = new User();
        user.setId(1);
        user.setName("John");
        user.setAge(25);

        userDao.update(user);
    }
}