LitePal是一个开放源码的Android库，非常容易地使用SQLite数据库。无需编写SQL语句的情况下,可以完成大多数数据库操作，包括创建或升级表、CRUD操作、聚合函数等。
- 项目是郭霖(第一行代码作者)团队开源维护,有非常完善的中文文档
- 持续更新中,针对kotlin语法进行过优化,使用起来非常丝滑
- 几乎为零配置(只有一个配置文件，几乎没有属性)
- 自动维护所有表(例如创建、更改或删除表)
- 简易完善而流畅的API
准备
导入
implementation 'org.litepal.android:kotlin:3.0.0'
配置
唯一的配置文件,在assets下新建一个litepal.xml然后按一下规则配置
<?xml version="1.0" encoding="utf-8"?>
<litepal>
<!--
定义应用程序的数据库名称。
默认情况下，每个数据库名都应该以.db结尾。
如果你没有用。db来命名你的数据库，LitePal会自动为你加上后缀。
For example:
下面写法会生成BookStore.db
-->
<dbname value="BookStore" />
<!--
定义数据库的版本。
每次你想要升级数据库，修改映射标记中定义的版本值+ 1，数据库升级将会被自动处理。
详情见后文的升级.
-->
<version value="1" />
<!--
用映射标签指定的modle在表中定义数据模型.
LitePal会在模型中定义的字段将映射到对应表的列中。
For example:
下面Song 属于package com.routon.litepal.litepaltest.dbmodel
-->
<list>
<mapping class="com.routon.litepal.litepaltest.dbmodel.Album" />
<mapping class="com.routon.litepal.litepaltest.dbmodel.Song" />
<mapping class="com.routon.litepal.litepaltest.dbmodel.Book" />
</list>
<!--
定义.db文件的位置。
"internal"表示.db文件将存储在内部存储的数据库文件夹中，没有人可以访问,默认设置。。
"external"表示.db文件将存储在主外部存储设备上的目录路径中，应用程序可以在该路径中放置它所拥有的每个人都可以访问的持久文件。
也可以自定义:
For example:
下面路径即为 /storage/emulated/0/routon/litePal/db/BookStore.db
-->
<storage value="routon/litePal/db" />
</litepal>
配置完成
配置LitePalApplication
在我们的Application中
override fun onCreate() {
...
LitePal.initialize(this)
...
}
即可
LitePal.initialize(this)此方法需要尽早调用,且使用application context作为参数
开始使用
1.定义model
java:
public class Song extends LitePalSupport {
@Column(nullable = false)
private String name;
private int duration;
@Column(defaultValue="无用")
private String uselessField;
// generated getters and setters.
...
}
kotlin:
class Book(
@Column(unique = true, defaultValue = "unknown")
val name: String,
val page: Int) : LitePalSupport() {
val id: Long = 0
}
需要注意的是，如果你的实体类中需要定义id这个字段，不要把它放到构造函数当中，因为id的值是由LitePal自动赋值的，而不应该由用户来指定。因此这里我们在Book类的内部声明了一个只读类型的id。
然后将这些模型添加到litepal.xml
<list>
<mapping class="com.routon.litepal.litepaltest.dbmodel.Song" />
<mapping class="com.routon.litepal.litepaltest.dbmodel.Book" />
</list>
下一次操作数据库时将生成这些表。例如，获取SQLiteDatabase有以下代码:
LitePal.getDatabase()
在实践中发现,LitePal需要文件读取权限,也就是说,这一步操作需要放到获取权限之后
2.升级表
只要修改想改模型就行了
然后在配置文件litepal.xml中把<version value="x" />改为<version value="x+1" />就可以了
注意
有些升级条件LitePal无法处理，升级表中的所有数据都将被清除：
- 添加一个注释为unique = true.
- 将字段的注释更改为unique = true.
- 将字段的注释更改为nullable = false.
注意以上情况，这样会导致数据丢失。
3.增删改查
增
继承自LitePalSupport的每个模型都有save()方法。
直接调用即可
val song = Song()
song.name = "first song"
song.duration = 180
song.save()
如此简单
查
val songs = LitePal
.where("name like ?", "first%").limit(1)
.find<Song>()
改
songs[0].name="second song"
songs[0].save()
删
songs[0].name="second song"
songs[0].delete()
其他的例子
实在是语义性太强了,不需要注释,自行阅读吧
val albumToUpdate = LitePal.find<Album>(1)
albumToUpdate.price = 20.99f // raise the price
albumToUpdate.save()
val albumToUpdate = Album()
albumToUpdate.price = 20.99f // raise the price
albumToUpdate.update(id)
val albumToUpdate = Album()
albumToUpdate.price = 20.99f // raise the price
albumToUpdate.updateAll("name = ?", "album")
LitePal.delete<Song>(id)
LitePal.deleteAll<Song>("duration > ?" , "350")
val song = LitePal.find<Song>(id)
val allSongs = LitePal.findAll<Song>()
val songs = LitePal.where("name like ? and duration < ?", "song%", "200").order("duration").find<Song>()
4.异步操作
默认情况下，每个数据库操作都位于主线程上。如果操作可能花费很长时间，例如保存或查询大量记录。就可能需要使用异步操作。
LitePal支持对所有CRUD方法的异步操作。
例如:要在后台线程上查找song表中的所有记录，请使用如下代码。
LitePal.findAsync<Song>().listen { allSongs ->
}
5.其他
可以支持多数据库,也有升级监听.暂时不需要,可以自行了解
结语
相关demo git库
https://git.dev.tencent.com/zhoulei26/android-scarlet.git
