Android sqlite迁移到room

一、替换方案

• 原有的数据库替换，创建你的 entity 类，RoomDatabase，并且更新你自定义的 SQLiteOpenHelper 为 SupportSQLiteOpenHelper。

• 新的需求，创建 DAO 类去代替有 Cursor 和 ContentValue 的代码。

二、具体替换步骤

1、创建 entity 类
如果你已经有每张表数据的 model 对象类，就只用添加 @Entity， @PrimaryKey 和 @ColumnInfo 的注解。

@Entity(tableName = "users")
public class User {

   @PrimaryKey
   @ColumnInfo(name = "userid")
   private int mId;

   @ColumnInfo(name = "username")
   private String mUserName;

   public User(int id, String userName) {
       this.mId = id;
       this.mUserName = userName;
   }

   public int getId() { return mId; }

   public String getUserName() { return mUserName; }
}

2、创建 Room 数据库
创建一个继承 RoomDatabase 的抽象类。在 @Database 注解中，列出所有你已创建的 entity 类。现在，我们就不用再创建 DAO 类了。

更新你数据库版本号并生成一个 Migration 对象。如果你没改数据库的 schema，你仍需要生成一个空的 Migration 对象让 Room 保留已有的数据。

@Database(entities = {<all entity classes>}, 
          version = <incremented_sqlite_version>)
public abstract class AppDatabase extends RoomDatabase {
    private static UsersDatabase INSTANCE;
    static final Migration      MIGRATION_<sqlite_version>_<incremented_sqlite_version> 
= new Migration(<sqlite_version>, <incremented_sqlite_version>) {
         @Override public void migrate(
                    SupportSQLiteDatabase database) {
           // 因为我们并没有对表进行更改，
           // 所以这里没有什么要做的 
         }
    };

3、更新使用 SQLiteOpenHelper 的类
一开始，我们的 LocalDataSource 类使用 CustomOpenHelper 进行工作，现在我要把它更新为使用 SupportSQLiteOpenHelper，这个类可以从 RoomDatabase.getOpenHelper() 获得。

public class LocalUserDataSource {
	private SupportSQLiteOpenHelper mDbHelper;
 	LocalUserDataSource(@NonNull SupportSQLiteOpenHelper helper) {
    	mDbHelper = helper;
	}
}

因为 SupportSQLiteOpenHelper 并不是直接继承 SQLiteOpenHelper，而是对它的一层包装，我们需要更改获得可写可读数据库的调用方式，并使用 SupportSQLiteDatabase 而不再是 SQLiteDatabase。

SupportSQLiteDatabase db = mDbHelper.getWritableDatabase();

SupportSQLiteDatabase 是一个数据库抽象层，提供类似 SQLiteDatabase 中的方法。因为它提供了一个更简洁的 API 去执行插入和查询数据库的操作，代码相比以前也需要做一些改动。

对于插入操作，Room 移除了可选的 nullColumnHack 参数。使用 SupportSQLiteDatabase.insert 代替 SQLiteDatabase.insertWithOnConflict。

@Override
public void insertOrUpdateUser(User user) {
    SupportSQLiteDatabase db = mDbHelper.getWritableDatabase();

    ContentValues values = new ContentValues();
    values.put(COLUMN_NAME_ENTRY_ID, user.getId());
    values.put(COLUMN_NAME_USERNAME, user.getUserName());

    - db.insertWithOnConflict(TABLE_NAME, null, values,
    -        SQLiteDatabase.CONFLICT_REPLACE);
    + db.insert(TABLE_NAME, SQLiteDatabase.CONFLICT_REPLACE,
    + values);
    db.close();
}

要查询的话，SupportSQLiteDatabase 提供了4种方法：

Cursor query(String query);
Cursor query(String query, Object[] bindArgs);
Cursor query(SupportSQLiteQuery query);
Cursor query(SupportSQLiteQuery query, CancellationSignal cancellationSignal);

4、新的需求
既然你的数据层已经在使用 Room，你可以开始逐渐创建 DAO 类（附带测试）并通过 DAO 的调用替代 Cursor 和 ContentValue 的代码。

像在 users 表中按名字顺序查询第一个用户这个操作应该定义在 UserDao 接口中。

@Dao
public interface UserDao {
    @Query(“SELECT * FROM Users ORDERED BY name ASC LIMIT 1”)
    User getFirstUserAlphabetically();
}

这个方法会在 LocalDataSource 中被调用。

public class LocalDataSource {
     private UserDao mUserDao;
     public User getFirstUserAlphabetically() {
        return mUserDao.getFirstUserAlphabetically();
     }
}