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

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

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,922评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,591评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,546评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,467评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,553评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,580评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,588评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,334评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,780评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,092评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,270评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,925评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,573评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,194评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,437评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,154评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352