Room是Jetpack组件库一员,属于ORM库,主要是对Sqlite做了一层抽象,从而简化开发者对数据库操作。Room支持编译时的语法检查,并且支持返回LiveData。
添加依赖
在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关键。否则会导致访问出错。
重要概念
要想使用Room,必须要了解最基础的三个概念:
Entity:实体类,对应的是数据库的一张表结构。需要使用注解 @Entity 标记。
Dao:包含访问一系列访问数据库的方法。需要使用注解 @Dao 标记。
Database:数据库持有者,作为与应用持久化相关数据的底层连接的主要接入点。需要使用注解 @Database 标记。
使用@Database注解需满足以下条件:
定义的类必须是一个继承于RoomDatabase的抽象类。
在注解中需要定义与数据库相关联的实体类列表。
包含一个没有参数的抽象方法并且返回一个带有注解的 @Dao。
三者之间和应用的对应关系如下图:
Entity
使用 @Entity注解定义的类会被映射为数据库中的一张表。默认实体类的类名为表名,字段名为表名。当然我们也是可以修改的。
@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和@Ignore
在@Entity注解中我们传入了一个参数 tableName用来指定表的名称。@PrimaryKey注解用来标注表的主键,并且使用autoGenerate = true 来指定了主键自增长。@ColumnInfo注解用来标注表对应的列的信息比如表名、默认值等等。@Ignore 注解顾名思义就是忽略这个字段,使用了这个注解的字段将不会在数据库中生成对应的列信息。也可以使用@Entity注解中的 ignoredColumns 参数来指定,效果是一样的。
除了以上使用的参数字段外,注解还有其他的参数,下面我来看下相关源码了解下其他的参数。
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方法,当未匹配到版本的时候就会直接删除表然后重新创建。
推荐阅读
开发属于自己的第一款IDEA插件!
说 4 个关键的技术趋势
深入源码分析Java线程池的实现原理
编程·思维·职场
欢迎扫码关注
文章浏览阅读1k次。通过使用ajax方法跨域请求是浏览器所不允许的,浏览器出于安全考虑是禁止的。警告信息如下:不过jQuery对跨域问题也有解决方案,使用jsonp的方式解决,方法如下:$.ajax({ async:false, url: 'http://www.mysite.com/demo.do', // 跨域URL ty..._nginx不停的xhr
文章浏览阅读2k次。关于在 Oracle 中配置 extproc 以访问 ST_Geometry,也就是我们所说的 使用空间SQL 的方法,官方文档链接如下。http://desktop.arcgis.com/zh-cn/arcmap/latest/manage-data/gdbs-in-oracle/configure-oracle-extproc.htm其实简单总结一下,主要就分为以下几个步骤。..._extproc
文章浏览阅读1.5w次。linux下没有上面的两个函数,需要使用函数 mbstowcs和wcstombsmbstowcs将多字节编码转换为宽字节编码wcstombs将宽字节编码转换为多字节编码这两个函数,转换过程中受到系统编码类型的影响,需要通过设置来设定转换前和转换后的编码类型。通过函数setlocale进行系统编码的设置。linux下输入命名locale -a查看系统支持的编码_linux c++ gbk->utf8
文章浏览阅读750次。今天准备从生产库向测试库进行数据导入,结果在imp导入的时候遇到“ IMP-00009:导出文件异常结束” 错误,google一下,发现可能有如下原因导致imp的数据太大,没有写buffer和commit两个数据库字符集不同从低版本exp的dmp文件,向高版本imp导出的dmp文件出错传输dmp文件时,文件损坏解决办法:imp时指定..._imp-00009导出文件异常结束
文章浏览阅读143次。当下是一个大数据的时代,各个行业都离不开数据的支持。因此,网络爬虫就应运而生。网络爬虫当下最为火热的是Python,Python开发爬虫相对简单,而且功能库相当完善,力压众多开发语言。本次教程我们爬取前程无忧的招聘信息来分析Python程序员需要掌握那些编程技术。首先在谷歌浏览器打开前程无忧的首页,按F12打开浏览器的开发者工具。浏览器开发者工具是用于捕捉网站的请求信息,通过分析请求信息可以了解请..._初级python程序员能力要求
文章浏览阅读7.6k次,点赞2次,收藏6次。@Service标注的bean,类名:ABDemoService查看源码后发现,原来是经过一个特殊处理:当类的名字是以两个或以上的大写字母开头的话,bean的名字会与类名保持一致public class AnnotationBeanNameGenerator implements BeanNameGenerator { private static final String C..._@service beanname
文章浏览阅读6.9w次,点赞73次,收藏463次。1.前序创建#include<stdio.h>#include<string.h>#include<stdlib.h>#include<malloc.h>#include<iostream>#include<stack>#include<queue>using namespace std;typed_二叉树的建立
文章浏览阅读7.1k次。在Asp.net上使用Excel导出功能,如果文件名出现中文,便会以乱码视之。 解决方法: fileName = HttpUtility.UrlEncode(fileName, System.Text.Encoding.UTF8);_asp.net utf8 导出中文字符乱码
文章浏览阅读2.1k次,点赞4次,收藏23次。第一次实验 词法分析实验报告设计思想词法分析的主要任务是根据文法的词汇表以及对应约定的编码进行一定的识别,找出文件中所有的合法的单词,并给出一定的信息作为最后的结果,用于后续语法分析程序的使用;本实验针对 PL/0 语言 的文法、词汇表编写一个词法分析程序,对于每个单词根据词汇表输出: (单词种类, 单词的值) 二元对。词汇表:种别编码单词符号助记符0beginb..._对pl/0作以下修改扩充。增加单词
文章浏览阅读773次。我在使用adb.exe时遇到了麻烦.我想使用与bash相同的adb.exe shell提示符,所以我决定更改默认的bash二进制文件(当然二进制文件是交叉编译的,一切都很完美)更改bash二进制文件遵循以下顺序> adb remount> adb push bash / system / bin /> adb shell> cd / system / bin> chm..._adb shell mv 权限
文章浏览阅读6.8k次,点赞12次,收藏125次。1. 单目相机标定引言相机标定已经研究多年,标定的算法可以分为基于摄影测量的标定和自标定。其中,应用最为广泛的还是张正友标定法。这是一种简单灵活、高鲁棒性、低成本的相机标定算法。仅需要一台相机和一块平面标定板构建相机标定系统,在标定过程中,相机拍摄多个角度下(至少两个角度,推荐10~20个角度)的标定板图像(相机和标定板都可以移动),即可对相机的内外参数进行标定。下面介绍张氏标定法(以下也这么称呼)的原理。原理相机模型和单应矩阵相机标定,就是对相机的内外参数进行计算的过程,从而得到物体到图像的投影_相机-投影仪标定
文章浏览阅读2.2k次。文章目录Wayland 架构Wayland 渲染Wayland的 硬件支持简 述: 翻译一篇关于和 wayland 有关的技术文章, 其英文标题为Wayland Architecture .Wayland 架构若是想要更好的理解 Wayland 架构及其与 X (X11 or X Window System) 结构;一种很好的方法是将事件从输入设备就开始跟踪, 查看期间所有的屏幕上出现的变化。这就是我们现在对 X 的理解。 内核是从一个输入设备中获取一个事件,并通过 evdev 输入_wayland