Android Jetpack 之 Room ---入门使用

前言

最近在学习 Google 推出的框架Jetpack，虽然目前网上的资料已经很多了，但为了加深印象和边动手练习跟着学习,所以站在了下面的巨人的肩膀上，并根据当前最新的API 和编写实际Demo,记录下一些学习笔记，大部分是参考巨人们的，整理和休整，加入自己理解和更新吧，学习领略了Android Jetpack组件的一点魅力

目前学习笔记系列为：

• Android Jetpack 之 Lifecycles ---入门使用
• Android Jetpack 之 LiveData---入门使用
• Android Jetpack 之 Room ---入门使用
• Android Jetpack 之 WorkManger---入门使用
• ....待续

日常鸣谢巨人

Google官方博文

CSDN 博主Alex@W

正题

Room 简介

Room是Google提供的一个ORM库

Room提供了三个主要的组件

1. @Database：@Database用来注解类，并且注解的类必须是继承自RoomDatabase的抽象类。该类主要作用是创建数据库和创建Daos（data access objects，数据访问对象）
2. @Entity：@Entity用来注解实体类，@Database通过entities属性引用被@Entity注解的类，并利用该类的所有字段作为表的列名来创建表
3. @Dao：@Dao用来注解一个接口或者抽象方法，该类的作用是提供访问数据库的方法。在使用@Database注解的类中必须定一个不带参数的方法，这个方法返回使用@Dao注解的类

入门使用

添加依赖

    apply plugin: 'kotlin-android'
    
    apply plugin: 'kotlin-android-extensions'
    
    apply plugin: 'kotlin-kapt'
    
    def room_version = "1.1.1"
    implementation "android.arch.persistence.room:runtime:$room_version"
    // use kapt for Kotlin
    annotationProcessor "android.arch.persistence.room:compiler:$room_version"
    
    // optional - RxJava support for Room
    implementation "android.arch.persistence.room:rxjava2:$room_version"
    
    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation "android.arch.persistence.room:guava:$room_version"
    
    kapt 'android.arch.persistence.room:compiler:1.1.1'

创建实体类 用 @Entity 注解

    @Entity(tableName = "users")
    class User {
        @PrimaryKey(autoGenerate = true)
        var uid: Int = 0
    
        @ColumnInfo(name = "user_name")
        var name: String = ""
    
        @ColumnInfo(name = "user_age")
        var age: Int = 0
    
        override fun toString(): String {
            return "{User, uid : $uid ,name : $name ,age :$age}"
        }
    }

1. tableName = "users" 表名
2. ColumnInfo(name = "user_name") 列名
3. PrimaryKey(autoGenerate = true) 主键，自增长

创建访问数据库的接口类 使用@DAO注解

主要是声明访问数据库的方法

    @Insert
    fun insertAll(vararg users: User)

    @Delete
    fun delete(user: User)

    @Delete
    fun deleteAll(users: List)

    @Query("SELECT * FROM users")
    fun getAllUsers():List

    @Update
    fun updateUser(user: User)

针对 SQLite的 CURD 四大操作，分别对应四种注解

1. @Insert
2. @Delete
3. @Query("SELECT * FROM users")
4. @Update

创建 AppDataBase ，使用 @Database 注解

    @Database(entities = arrayOf(User::class), version = 2)
    abstract class AppDataBase : RoomDatabase() {
    
        // 必须包含一个具有0个参数且返回带@Dao注释的类的抽象方法
        abstract fun userDao(): UserDao
    
        companion object {
            private var appDataBase: AppDataBase? = null
            fun getInstance(context: Context): AppDataBase? {
                if (appDataBase == null) {
                    synchronized(AppDataBase::class.java) {
                        appDataBase = Room.databaseBuilder(context.applicationContext,     AppDataBase::class.java, "user_database").build()
                    }
                }
                return appDataBase!!
            }
        }
    }

1. version = 2 数据库版本，更新数据库模型时，需要更新
2. entities = ，对应使用 @Entity 标记的实体类
3. abstract fun userDao(): UserDao 必须包含一个具有0个参数且返回带@Dao注释的类的抽象方法，也就是返回 @Dao 标记的访问数据库的接口类
4. 使用单例，提供外部获得AppDataBase 实例的创建

创建数据库，并执行 CURD操作

    // init dao
    userDao = AppDataBase.getInstance(this)!!.userDao()
    
    // 增加用户
    val user = User()
    user.name = "用户A"
    user.age = 20
    rDao!!.insertAl(user)
    
    //查找全部用户
    val users =userDao!!.getAllUsrs()
    
    //删除指定id 用户
     val user = User()
     user.uid = 1
     userDao!!.delee(user)
     
    //更新某指定id 用户
    val user = User()
    user.uid = 1
    user.name = "用户A被改名了"
    userDao!!.updateUser(user)