美文网首页
JetPack学习之路一:Room库的使用(Kotlin)

JetPack学习之路一:Room库的使用(Kotlin)

作者: Dale_Dawson | 来源:发表于2020-06-02 16:09 被阅读0次

    Android Jetpack

    Jetpack 是一套库、工具和指南,可帮助开发者更轻松地编写优质应用。这些组件可帮助您遵循最佳做法、让您摆脱编写样板代码的工作并简化复杂任务,以便您将精力集中放在所需的代码上。
    Jetpack 包含与平台 API 解除捆绑的 androidx.* 软件包库。这意味着,它可以提供向后兼容性,且比 Android 平台的更新频率更高,以此确保您始终可以获取最新且最好的 Jetpack 组件版本。

    Room

    Room 持久性库在 SQLite 的基础上提供了一个抽象层,让用户能够在充分利用 SQLite 的强大功能的同时,获享更强健的数据库访问机制。

    开始使用

    1.注入依赖

    在app目录下的build.gradle的dependencies添加如下代码

     def room_version = "2.2.5"
     implementation "androidx.room:room-runtime:$room_version"
     kapt  "androidx.room:room-compiler:$room_version"
    

    此处需要说明的是使用kapt 需要在该文件的最上方添加

    apply plugin: 'kotlin-kapt'
    

    2.创建ORM映射类

        @Entity
        class Person constructor(){
            constructor(name:String,age:Int):this(){
                this.name = name
                this.age = age
            }
            @PrimaryKey(autoGenerate = true)
            var id:Int? = null
            var name:String? = null
            var age:Int? = null
        
            @Ignore
            var sex:Int?=null
            override fun toString(): String {
                return "Person(id=$id, name=$name, age=$age, sex=$sex)"
            }
        }
    

    可以看见类中用到了几个注解,那就先来了解一下相关的注解及作用。

    @Entity注解:标识数据库映射关系的类,可以指定表名等,不指定的话默认表=名和类名一致,索引等信息
    @PrimaryKey注解:指定主键,可设置自动增长等属性
    @ColumnInfo注解:指定列信息,如列名等信息
    @Ignore注解:标识忽略此属性,不对应生成数据库字段
    @Dao注解:标识Dao层注解,编译时候会生成该接口或抽象类的实现
    @Insert注解:标识该抽象方法为插入数据库,入参为Entity注解标注的类对象
    @Query注解:标识该抽象方法为查询的方法(表面),需传入sql语句,其实sql语句可以实现增删改查的操作,也就是说可以实现常用全部操作
    @Delete注解:标注该方法为删除的方法,入参为Entity注解标注的类对象
    @Update注解:标注该方法为更新的方法,入参为Entity注解标注的类对象
    @Database注解:标注该类为数据库操作类,一般为单例对象,入参entities为对应映射的kclass对象集合,verson处理数据库升级相关,通过此类可以拿到相关数据库操作的dao对象,进行相关的数据库操作

    3.创建Dao(常用增删改查四个方法)

        @Dao
        abstract class PersonDao {
            @Insert
            abstract fun insert(person: Person)
            @Delete
            abstract fun delete(person: Person)
            @Update
            abstract fun update(person: Person)
            @Query("SELECT * FROM Person")
            abstract fun getPersonList():MutableList<Person>
        }
    

    直接通过对象来操作增删改查

    4.创建RoomDatabase子类,持有dao的引用

        @Database(entities = [Person::class], version = 1)
        abstract class PersonRoomDatabase : RoomDatabase() {
            abstract fun personDao(): PersonDao
            companion object {
                @Volatile
                private var instance: PersonRoomDatabase? = null
                fun getPersonRoomDatabase(context:Context):PersonRoomDatabase{
                    if (null == instance){
                        synchronized(PersonRoomDatabase::class){
                            if (null == instance){
                                instance = Room.databaseBuilder(context.applicationContext,PersonRoomDatabase::class.java,"db_person").allowMainThreadQueries().build()
                            }
                        }
                    }
                    return instance!!
                }
            }
        }
    

    5.调用(增删改查)

    val personDao = PersonRoomDatabase.getPersonRoomDatabase(this).personDao()
    val person = Person("张三",18)
    personDao.insert(person)
    

    val person = Person()
    person.id = 1
    personDao.delete(person)
    

    val person = Person("李四",20)
    person.id = 2
    personDao.update(person)
    

    var personList: MutableList<Person> = personDao.getPersonList()
    Log.d(Common.TAG,"共有${personList.size}个人")
    personList.forEach {
        Log.d(Cst.TAG,it.toString())
    }
    

    以上就是常用增删改查的基本操作,想要高端操作,我们继续看

    6.拓展操作

    用@Query注解也可以实现增删改,让你继续感受自己写sql的快感

    
    @Query("insert into Person values (:id,:name,:age)")
        fun insertQuery(id:Int?,name:String?,age:Int?)
    @Query("delete from Person where id = :id")
        fun deleteQuery(id:Int?)
    @Query("update Person set name = :name , age = :age where id= :id")
        fun updateQuery(id:Int?,name:String?,age:Int?)
    @Query("select * from Person where id= :id")
        fun findById(id:Int?): MutableList<Person>
     @Query("select * from Person where age > :age")
        fun findByAge(age:Int?): MutableList<PersonBean>
    @Query("select * from Person where name like :name")
        fun findByNameRule(name: String?): MutableList<Person>
    

    调用方法和上面一样

    7.Room升级

    当我们增删表,修改表结构,增删字段的时候就需要升级
    升级步骤如下
    1.修改版本号,在RoomDatabase的子类中,改变version的值(我上一个版本是1)

    @Database(entities = [PersonBean::class,Teacher::class], version = 2)
    

    2.如果是增加表,则相应的增加、减少entities数组的内容,如果是增删字段,在对应的ORM映射类中增删即可
    3.增加Migration

    Room.databaseBuilder(context.applicationContext,PersonRoomDatabase::class.java,"db_test")
                                .addMigrations(object: Migration(1,2){
                                    override fun migrate(database: SupportSQLiteDatabase) {
                                        //此处为增删表、增删字段的sql书写处
                                        database.execSQL("CREATE TABLE IF NOT EXISTS `Teacher` (" +
                                                "`id` INTEGER PRIMARY KEY AUTOINCREMENT," +
                                                "`name` TEXT," +
                                                "`classes` TEXT," +
                                                "`age` INTEGER " +
                                                ");")
                                    }
                                })
                                .allowMainThreadQueries().build()
    

    源码地址

    https://github.com/DalesDawson/JetPackStudy

    这是本人在学习过程中产生的总结,记录一下,如有错误请各位大佬及时指出

    相关文章

      网友评论

          本文标题:JetPack学习之路一:Room库的使用(Kotlin)

          本文链接:https://www.haomeiwen.com/subject/wfquzhtx.html