導(dǎo)語
Jetpack簡介及其它組件文章
Room是Jetpack組件庫一員，屬于ORM庫，主要是對Sqlite做了一層抽象，從而簡化開發(fā)者對數(shù)據(jù)庫操作。Room支持編譯時(shí)的語法檢查，并且支持返回LiveData。
主要內(nèi)容
- Room的基本使用
具體內(nèi)容
Room的基本使用
添加依賴
在app的build.gradle中添加如下依賴：
def room_version = "2.2.0-rc01"
implementation "androidx.room:room-runtime:$room_version"
// For Kotlin use kapt instead of annotationProcessor (注意這個(gè)注釋)
kapt "androidx.room:room-compiler:$room_version"
如果項(xiàng)目是使用Kotlin語言來開發(fā)的，在添加room-compiler的時(shí)候使用kapt關(guān)鍵字，java語言開發(fā)的就使用annotationProcessor關(guān)鍵。否則會(huì)導(dǎo)致訪問出錯(cuò)。
重要概念
要想使用Room，必須要了解最基礎(chǔ)的三個(gè)概念：
- Entity：實(shí)體類，對應(yīng)的是數(shù)據(jù)庫的一張表結(jié)構(gòu)。需要使用注解 @Entity 標(biāo)記。
- Dao：包含訪問一系列訪問數(shù)據(jù)庫的方法。需要使用注解 @Dao 標(biāo)記。
- Database：數(shù)據(jù)庫持有者，作為與應(yīng)用持久化相關(guān)數(shù)據(jù)的底層連接的主要接入點(diǎn)。需要使用注解 @Database 標(biāo)記。
使用@Database注解需滿足以下條件：
- 定義的類必須是一個(gè)繼承于RoomDatabase的抽象類。
- 在注解中需要定義與數(shù)據(jù)庫相關(guān)聯(lián)的實(shí)體類列表。
- 包含一個(gè)沒有參數(shù)的抽象方法并且返回一個(gè)帶有注解的 @Dao。
三者之間和應(yīng)用的對應(yīng)關(guān)系如下圖：
Entity：
使用 @Entity注解定義的類會(huì)被映射為數(shù)據(jù)庫中的一張表。默認(rèn)實(shí)體類的類名為表名，字段名為表名。當(dāng)然我們也是可以修改的。
@Entity(tableName = "users")
data class User(
@PrimaryKey(autoGenerate = true) var userId: Long,
@ColumnInfo(name = "user_name")var userName: String,
@ColumnInfo(defaultValue = "china") var address: String,
@Ignore var sex: Boolean
)
比如這里我們定義了一個(gè)User類。這里使用了@Entity、@PrimaryKey、@ColumnInfo和@Ignore
在@Entity注解中我們傳入了一個(gè)參數(shù) tableName用來指定表的名稱。@PrimaryKey注解用來標(biāo)注表的主鍵，并且使用autoGenerate = true 來指定了主鍵自增長。@ColumnInfo注解用來標(biāo)注表對應(yīng)的列的信息比如表名、默認(rèn)值等等。@Ignore 注解顧名思義就是忽略這個(gè)字段，使用了這個(gè)注解的字段將不會(huì)在數(shù)據(jù)庫中生成對應(yīng)的列信息。也可以使用@Entity注解中的 ignoredColumns 參數(shù)來指定，效果是一樣的。
除了以上使用的參數(shù)字段外，注解還有其他的參數(shù)，下面我來看下相關(guān)源碼了解下其他的參數(shù)。
Entity注解：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Entity {
String tableName() default "";
Index[] indices() default {};
boolean inheritSuperIndices() default false;
String[] primaryKeys() default {};
String[] ignoredColumns() default {};
}
PrimaryKey注解：
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface PrimaryKey {
boolean autoGenerate() default false;
}
ColumnInfo注解：
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface ColumnInfo {
String name() default INHERIT_FIELD_NAME;
@SuppressWarnings("unused") @SQLiteTypeAffinity int typeAffinity() default UNDEFINED;
boolean index() default false;
@Collate int collate() default UNSPECIFIED;
String defaultValue() default VALUE_UNSPECIFIED;
String INHERIT_FIELD_NAME = "[field-name]";
int UNDEFINED = 1;
int TEXT = 2;
int INTEGER = 3;
int REAL = 4;
int BLOB = 5;
@IntDef({UNDEFINED, TEXT, INTEGER, REAL, BLOB})
@Retention(RetentionPolicy.CLASS)
@interface SQLiteTypeAffinity {
}
int UNSPECIFIED = 1;
int BINARY = 2;
int NOCASE = 3;
int RTRIM = 4;
@RequiresApi(21)
int LOCALIZED = 5;
@RequiresApi(21)
int UNICODE = 6;
@IntDef({UNSPECIFIED, BINARY, NOCASE, RTRIM, LOCALIZED, UNICODE})
@Retention(RetentionPolicy.CLASS)
@interface Collate {
}
String VALUE_UNSPECIFIED = "[value-unspecified]";
}
Ignore注解：
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.CLASS)
public @interface Ignore {
}
Dao：
Dao類是一個(gè) interface，其中定義了一系列的操作數(shù)據(jù)庫的方法。通常我們操作數(shù)據(jù)庫無非就是增刪改查。Room也為我們的提供了相關(guān)的注解，有@Insert、@Delete、@Update 和 @Query。
@query：
我們先來看下 @Query 查詢注解，它的參數(shù)是String類型，我們直接寫SQL語句進(jìn)行執(zhí)行，而且編譯的時(shí)候可以進(jìn)行語法檢查。比如我們根據(jù)ID查詢某個(gè)用戶的信息：
@Query("select * from user where userId = :id")
fun getUserById(id: Long): User
SQL語句引用傳遞的參數(shù)直接使用 ：符號進(jìn)行引用。
@Insert：
如果我們需要向表中插入一條數(shù)據(jù),我們直接定義一個(gè)方法并用 @Insert注解標(biāo)注就可以：
@Insert(onConflict = OnConflictStrategy.REPLACE)
fun addUser(user: User)
我們看到直接中有個(gè)參數(shù)onConflict，表示的是當(dāng)插入的數(shù)據(jù)已經(jīng)存在時(shí)候的處理邏輯，有三種操作邏輯：REPLACE、ABORT和IGNORE。如果不指定則默認(rèn)為ABORT終止插入數(shù)據(jù)。這里我們將其指定為REPLACE替換原有數(shù)據(jù)。
@Delete：
如果需要?jiǎng)h除表的數(shù)據(jù)則使用 @Delete注解：
@Delete
fun deleteUserByUser(user: User)
使用主鍵來查找要?jiǎng)h除的實(shí)體。
@Update：
如果需要修改某一條數(shù)據(jù)則使用 @Update注解，和@Delete一樣也是根據(jù)主鍵來查找要?jiǎng)h除的實(shí)體。
@Update
fun updateUserByUser(user: User)
上面說的 @Query 查詢接受的參數(shù)是一個(gè)字符串，所以像刪除或者更新我們也可以使用 @Query 注解來使用SQL語句來直接執(zhí)行。比如根據(jù)userid來查詢某個(gè)用戶或者根據(jù)userid更新某個(gè)用戶的姓名：
@Query("delete from user where userId = :id ")
fun deleteUserById(id:Long)
@Query("update user set userName = :updateName where userID = :id")
fun update(id: Long, updateName: String)
效果是完全一樣的。
Database：
首先定義一個(gè)抽象類繼承RoomDatabase類，并添加注解 @Database 來標(biāo)識：
@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
abstract fun userDao(): UserDao
companion object {
private var instance: AppDatabase? = null
fun getInstance(context: Context): AppDatabase {
if (instance == null) {
instance = Room.databaseBuilder(
context.applicationContext,
AppDatabase::class.java,
"user.db" //數(shù)據(jù)庫名稱
).allowMainThreadQueries().build()
}
return instance as AppDatabase
}
}
}
還記得上文中說Database需要滿足的是那個(gè)要求嗎？這里可以和上文聯(lián)系起來對比看下。
使用entities來映射相關(guān)的實(shí)體類，version來指明當(dāng)前數(shù)據(jù)庫的版本號。這里使用了單例模式來返回Database，以防止新建過多的實(shí)例造成內(nèi)存的浪費(fèi)。Room.databaseBuilder(context,klass,name).build()來創(chuàng)建Database，其中第一個(gè)參數(shù)為上下文，第二個(gè)參數(shù)為當(dāng)前Database的class字節(jié)碼文件，第三個(gè)參數(shù)為數(shù)據(jù)庫名稱。
默認(rèn)情況下Database是不可以在主線程中進(jìn)行調(diào)用的。因?yàn)榇蟛糠智闆r，操作數(shù)據(jù)庫都還算是比較耗時(shí)的動(dòng)作。如果需要在主線程調(diào)用則使用allowMainThreadQueries進(jìn)行說明。
使用：
以上都定義好后，就是如何調(diào)用了。我們在Activity中使用：
class RoomActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val userDao = AppDatabase.getInstance(this).userDao()
//insert數(shù)據(jù)
for (i in (0 until 10)) {
val user = User(userName = "李四$i", userPhone = "110$i")
userDao.addUser(user)
}
//query所有數(shù)據(jù)
userDao.getAllUsers().forEach {
Log.e("room", "==query==${it.userId},${it.userName},${it.userPhone}")
}
//update數(shù)據(jù)
userDao.updateUserById(2, "張三")
val updateUser = userDao.getUserById(2)
Log.e("room", "==update==${updateUser.userId},${updateUser.userName},${updateUser.userPhone}")
//Delete數(shù)據(jù)
val row = userDao.deleteUserById(10)
Log.e("room", "刪除了 $row 行")
}
}
我們來看下數(shù)據(jù)：
插入的10條數(shù)據(jù)
room: ==query==1,李四0,1100
room: ==query==2,李四1,1101
room: ==query==3,李四2,1102
room: ==query==4,李四3,1103
room: ==query==5,李四4,1104
room: ==query==6,李四5,1105
room: ==query==7,李四6,1106
room: ==query==8,李四7,1107
room: ==query==9,李四8,1108
room: ==query==10,李四9,1109
更新了id為2的這條數(shù)據(jù)
room: ==update==2,張三,1101
刪除了id為10的數(shù)據(jù)
room: 刪除了 1 行
生成的數(shù)據(jù)庫在data/data/packageName/databases 目錄中。
Dao和Database相關(guān)文件在編譯后會(huì)在build目錄下生成 UserDao_Impl和AppDatabase_Impl文件，有興趣的可以自己去看下。
數(shù)據(jù)庫升級和降級：
在使用數(shù)據(jù)庫的時(shí)候避免不了的就是數(shù)據(jù)庫的更新。數(shù)據(jù)庫的升級或者降級使用addMigrations方法進(jìn)行操作：
instance = Room.databaseBuilder(
context.applicationContext,
AppDatabase::class.java,
"user.db"
).addMigrations(object :Migration(1,2){
override fun migrate(database: SupportSQLiteDatabase) {
database.execSQL("ALTER TABLE user ADD age INTEGER Default 0 not null ")
}
})allowMainThreadQueries().build()
其中Migration需要兩個(gè)參數(shù)，startVersion表示的是升級開始的版本，endVersion表示要升級到的版本。同時(shí)需要將@Database注解中的version的值修改為和endVersion相同。
比如上面代碼將數(shù)據(jù)庫從版本1升級到版本2，并在版本2上增加了age一列：
數(shù)據(jù)庫降級使用也是一樣。也是使用addMigrations只是startVersion > endVersion 。
當(dāng)在升級或者降級的過程中出現(xiàn)版本未匹配到的情況的時(shí)候，默認(rèn)情況下會(huì)直接拋異常出來。當(dāng)然我們也可以處理異常。
升級的時(shí)候可以添加fallbackToDestructiveMigration方法，當(dāng)未匹配到版本的時(shí)候就會(huì)直接刪除表然后重新創(chuàng)建。
降級的時(shí)候添加fallbackToDestructiveMigrationOnDowngrade方法，當(dāng)未匹配到版本的時(shí)候就會(huì)直接刪除表然后重新創(chuàng)建。
