Android Jetpack架構組件 — Room入坑詳解

時間  2019-11-30
標籤 android jetpack 架構 組件 room 詳解 欄目 Android 简体版
原文   原文鏈接

本文首發於微信公衆號「Android開發之旅」，歡迎關注 ，獲取更多技術乾貨java

Room是Jetpack組件庫一員，屬於ORM庫，主要是對Sqlite作了一層抽象，從而簡化開發者對數據庫操做。Room支持編譯時的語法檢查，而且支持返回LiveData。android

添加依賴

在app的build.gradle中添加以下依賴：數據庫

def room_version = "2.2.0-rc01"
	
implementation "androidx.room:room-runtime:$room_version"
// For Kotlin use kapt instead of annotationProcessor (注意這個註釋)
kapt "androidx.room:room-compiler:$room_version"
複製代碼

若是項目是使用Kotlin語言來開發的，在添加room-compiler的時候使用kapt關鍵字，java語言開發的就使用annotationProcessor關鍵。不然會致使訪問出錯。bash

重要概念

要想使用Room，必需要了解最基礎的三個概念：微信

  • Entity：實體類，對應的是數據庫的一張表結構。須要使用註解 @Entity 標記。
  • Dao：包含訪問一系列訪問數據庫的方法。須要使用註解 @Dao 標記。
  • Database：數據庫持有者，做爲與應用持久化相關數據的底層鏈接的主要接入點。須要使用註解 @Database 標記。 使用@Database註解需知足如下條件： 定義的類必須是一個繼承於RoomDatabase的抽象類。 在註解中須要定義與數據庫相關聯的實體類列表。 包含一個沒有參數的抽象方法而且返回一個帶有註解的 @Dao。

三者之間和應用的對應關係以下圖：架構

Entity

使用 @Entity註解定義的類會被映射爲數據庫中的一張表。默認實體類的類名爲表名，字段名爲表名。固然咱們也是能夠修改的。app

@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
)

複製代碼

好比這裏咱們定義了一個User類。這裏使用了@Entity、@PrimaryKey、@ColumnInfo和@Ignoreide

在@Entity註解中咱們傳入了一個參數 tableName用來指定表的名稱。@PrimaryKey註解用來標註表的主鍵，而且使用autoGenerate = true 來指定了主鍵自增加。@ColumnInfo註解用來標註表對應的列的信息好比表名、默認值等等。@Ignore 註解顧名思義就是忽略這個字段，使用了這個註解的字段將不會在數據庫中生成對應的列信息。也可使用@Entity註解中的 ignoredColumns 參數來指定，效果是同樣的。post

除了以上使用的參數字段外，註解還有其餘的參數，下面我來看下相關源碼瞭解下其餘的參數。gradle

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類是一個 interface，其中定義了一系列的操做數據庫的方法。一般咱們操做數據庫無非就是增刪改查。Room也爲咱們的提供了相關的註解，有@Insert、@Delete、@Update 和 @Query。

@query

咱們先來看下 @Query 查詢註解，它的參數時String類型，咱們直接寫SQL語句進行執行，並且編譯的時候能夠進行語法檢查。好比咱們根據ID查詢某個用戶的信息：

@Query("select * from user where userId = :id")
fun getUserById(id: Long): User
複製代碼

SQL語句引用傳遞的參數直接使用 ：符號進行引用。

@Insert

若是咱們須要向表中插入一條數據,咱們直接定義一個方法並用 @Insert註解標註就能夠：

@Insert(onConflict = OnConflictStrategy.REPLACE)
fun addUser(user: User)
複製代碼

咱們看到直接中有個參數onConflict，表示的是當插入的數據已經存在時候的處理邏輯，有三種操做邏輯：REPLACE、ABORT和IGNORE。若是不指定則默認爲ABORT終止插入數據。這裏咱們將其指定爲REPLACE替換原有數據。

@Delete

若是須要刪除表的數據則使用 @Delete註解：

@Delete
fun deleteUserByUser(user: User)
複製代碼

使用主鍵來查找要刪除的實體。

@Update

若是須要修改某一條數據則使用 @Update註解，和@Delete同樣也是根據主鍵來查找要刪除的實體。

@Update
fun updateUserByUser(user: User)
複製代碼

上面說的 @Query 查詢接受的參數是一個字符串，因此像刪除或者更新咱們也可使用 @Query 註解來使用SQL語句來直接執行。好比根據userid來查詢某個用戶或者根據userid更新某個用戶的姓名：

@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

首先定義一個抽象類繼承RoomDatabase類，並添加註解 @Database 來標識：

@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" //數據庫名稱
                ).allowMainThreadQueries().build()
            }
            return instance as AppDatabase
        }
    }
}
複製代碼

還記得上文中說Database須要知足的是那個要求嗎？這裏能夠和上文聯繫起來對比看下。

使用entities來映射相關的實體類，version來指明當前數據庫的版本號。這裏使用了單例模式來返回Database，以防止新建過多的實例形成內存的浪費。Room.databaseBuilder(context,klass,name).build()來建立Database，其中第一個參數爲上下文，第二個參數爲當前Database的class字節碼文件，第三個參數爲數據庫名稱。

默認狀況下Database是不能夠在主線程中進行調用的。由於大部分狀況，操做數據庫都還算是比較耗時的動做。若是須要在主線程調用則使用allowMainThreadQueries進行說明。

使用

以上都定義好後，就是如何調用了。咱們在Activity中使用：

class RoomActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val userDao = AppDatabase.getInstance(this).userDao()

        //insert數據
        for (i in (0 until 10)) {
            val user = User(userName = "李四$i", userPhone = "110$i")
            userDao.addUser(user)
        }

        //query全部數據
        userDao.getAllUsers().forEach {
            Log.e("room", "==query==${it.userId},${it.userName},${it.userPhone}")
        }

        //update數據
        userDao.updateUserById(2, "張三")
        val updateUser = userDao.getUserById(2)
        Log.e("room", "==update==${updateUser.userId},${updateUser.userName},${updateUser.userPhone}")
        
        //Delete數據
        val row = userDao.deleteUserById(10)
        Log.e("room", "刪除了 $row 行")

    }
}
複製代碼

咱們來看下數據

插入的10條數據
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的這條數據
room: ==update==2,張三,1101

刪除了id爲10的數據
room: 刪除了 1 行
複製代碼

生成的數據庫在data/data/packageName/databases 目錄中。

Dao和Database相關文件在編譯後會在build目錄下生成 UserDao_Impl和AppDatabase_Impl文件，有興趣的能夠本身去看下。

數據庫升級和降級

在使用數據庫的時候避免不了的就是數據庫的更新。數據庫的升級或者降級使用addMigrations方法進行操做：

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須要兩個參數，startVersion表示的是升級開始的版本，endVersion表示要升級到的版本。同時須要將@Database註解中的version的值修改成和endVersion相同。

好比上面代碼將數據庫從版本1升級到版本2，並在版本2上增長了age一列：

數據庫降級使用也是同樣。也是使用addMigrations只是startVersion > endVersion 。

當在升級或者降級的過程當中出現版本未匹配到的狀況的時候，默認狀況下會直接拋異常出來。固然咱們也能夠處理異常。

升級的時候能夠添加fallbackToDestructiveMigration方法，當未匹配到版本的時候就會直接刪除表而後從新建立。

降級的時候添加fallbackToDestructiveMigrationOnDowngrade方法，當未匹配到版本的時候就會直接刪除表而後從新建立。

掃描下方二維碼關注公衆號，獲取更多技術乾貨。

推薦閱讀

還不知道Android Jetpack是什麼？你就out了

Android Jetpack架構組件 — Lifecycle入坑指南

Jetpack架構組件 — LiveData與ViewModel入坑詳解

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程