LitePal
Android開源數(shù)據(jù)庫框架
資料
設(shè)置
導(dǎo)入
- 配置模組的 build.gradle
compile 'org.litepal.android:core:1.5.0'
配置
- assets 目錄創(chuàng)建 litepal.xml
<?xml version="1.0" encoding="utf-8"?>
<litepal>
<dbname value="demo" />
<version value="1" />
<list>
<mapping class="com.test.model.Reader" />
<mapping class="com.test.model.Magazine" />
</list>
<storage value="external" />
</litepal>
- dbname 定義數(shù)據(jù)庫名瓢宦。默認以 .db 結(jié)尾掉房，如未以此結(jié)尾，則自動添加哩至。
- version 定義數(shù)據(jù)庫版本惕耕。輔助升級數(shù)據(jù)庫纺裁。
- list 根據(jù)標簽 mapping 對應(yīng)的類創(chuàng)建表，成員變量對應(yīng)字段。
- storage 定義數(shù)據(jù)庫文件存儲的地方欺缘，可選 internal 和 external栋豫， 默認為 internal
初始化
- 在自定義的Application中初始化
LitePal.initialize(this);
- 或者使用LitePal庫的Application
<manifest>
<application
android:name="org.litepal.LitePalApplication"
...
>
...
</application>
</manifest>
基本用法
建表
- 定義 Bean，繼承 DataSupport
- id字段可寫可不寫谚殊，默認自動產(chǎn)生
public class Album extends DataSupport {
@Column(unique = true, defaultValue = "unknown") // 唯一笼才，默認值
private String name;
private float price;
private byte[] cover;
private List<Song> songs = new ArrayList<Song>(); // 關(guān)系：對多
// getters/setters
}
public class Song extends DataSupport {
@Column(nullable = false) // 非空
private String name;
private int duration;
@Column(ignore = true) // 忽略
private String uselessField;
private Album album; // 關(guān)系：對一
// getters/setters
}
- 修改 litepal.xml
<list>
<mapping class="org.litepal.litepalsample.model.Album" />
<mapping class="org.litepal.litepalsample.model.Song" />
</list>
- 獲取數(shù)據(jù)庫
SQLiteDatabase db = LitePal.getDatabase();
- 對應(yīng)的SQL語句
CREATE TABLE album (
id integer primary key autoincrement,
name text unique default 'unknown',
price real,
cover blob
);
CREATE TABLE song (
id integer primary key autoincrement,
name text not null,
duration integer,
album_id integer
);
關(guān)系
- 定義Bean時定義成員變量，即在建表時自動創(chuàng)建外鍵
- 對一络凿，成員變量為另一個Bean
- 對多骡送，成員變量為另一個Bean的集合
- 多對多，兩個Bean互相定義成員變量為另一Bean的集合
- 數(shù)據(jù)表刪除操作時絮记，自動按外鍵進行刪除
升級
- 修改 Bean
public class Album extends DataSupport {
@Column(unique = true, defaultValue = "unknown")
private String name;
@Column(ignore = true)
private float price;
private byte[] cover;
private Date releaseDate;
private List<Song> songs = new ArrayList<Song>();
// getters/setters
}
- 修改 litepal.xml
版本號增加摔踱，數(shù)據(jù)自動保存
<version value="2" />
- 丟失數(shù)據(jù)狀況
- 注解成員變量
unique = true - 改變注解
unique = true - 改變注解
nullable = false
- 注解成員變量
增加
- DataSupport：
saveAll - Bean：
save/saveThrows/saveOrUpdate
Album album = new Album();
album.setName("album");
album.setPrice(10.99f);
album.setCover(getCoverImageBytes());
album.save();
Song song1 = new Song();
song1.setName("song1");
song1.setDuration(320);
song1.setAlbum(album); // 添加關(guān)系
song1.save();
Song song2 = new Song();
song2.setName("song2");
song2.setDuration(356);
song2.setAlbum(album); // 添加關(guān)系
song2.save();
修改
- DataSupport：
update/updateAll - Bean：
update/updateAll/setToDefault/assignBaseObjId
Album albumToUpdate = DataSupport.find(Album.class, 1); //查找
albumToUpdate.setPrice(20.99f);
albumToUpdate.save(); // 保存
Album albumToUpdate = new Album();
albumToUpdate.setPrice(20.99f);
albumToUpdate.update(id); // 更新
Album albumToUpdate = new Album();
albumToUpdate.setPrice(20.99f);
albumToUpdate.updateAll("name = ?", "album"); // 更新所有
Album albumToUpdate = new Album();
albumToUpdate.setToDefault("name"); // 更新為默認值
albumToUpdate.updateAll();
刪除
- DataSupport：
delete/deleteAll/markAsDeleted - Bean：
delete/clearSavedState - Bean必須是已持久化的對象，否則無效
DataSupport.delete(Song.class, id); // 刪除
DataSupport.delete(Song.class); // 刪除所有數(shù)據(jù)
DataSupport.deleteAll(Song.class, "duration > ?" , "350"); // 條件刪除
查詢
- DataSupport：
find/findFirst/findLast/findAll/findBySQL/isExist - DataSupport：
select/where/order/limit/offset查詢條件 - Bean：
isSaved
Song song = DataSupport.find(Song.class, id);
Song song = DataSupport.findFirst(Song.class); // 查詢第一條
Song song = DataSupport.findLast(Song.class); // 查詢最后一條
List<Song> allSongs = DataSupport.findAll(Song.class);
List<Song> songs = DataSupport.where("name like ?", "song%").order("duration").find(Song.class);
List<Song> songs = DataSupport.where("name like ?", "song%").order("duration").limit(3).offset(1).find(Song.class); // 分頁查詢
// 聯(lián)合查詢怨愤，可以查詢關(guān)聯(lián)表
Album album = DataSupport.find(Album.class, id, true);
List<Song> songs = album.getSongs();
異步
- 大部分方法都有對應(yīng)的異步方法
// 查詢
DataSupport.findAllAsync(Song.class).listen(new FindMultiCallback() {
@Override
public <T> void onFinish(List<T> t) {
List<Song> allSongs = (List<Song>) t;
}
});
// 增加
Album album = new Album();
album.setName("album");
album.setPrice(10.99f);
album.setCover(getCoverImageBytes());
album.saveAsync().listen(new SaveCallback() {
@Override
public void onFinish(boolean success) {
}
});
聚合函數(shù)
count/average/max/min/sum
int result = DataSupport.count(Song.class);
int result = DataSupport.where("name like ?", "song%").count(Song.class);
double result = DataSupport.sum(Album.class, "price", double.class);
多庫
LitePalDB litePalDB = new LitePalDB("demo2", 1);
litePalDB.addClassName(Singer.class.getName());
litePalDB.addClassName(Album.class.getName());
litePalDB.addClassName(Song.class.getName());
LitePal.use(litePalDB); // 建庫
LitePalDB litePalDB = LitePalDB.fromDefault("newdb");
LitePal.use(litePalDB); // 使用 litepal.xml 創(chuàng)建一個新庫
LitePal.useDefault(); // 返回默認庫
LitePal.deleteDatabase("newdb"); // 刪庫
