数据库框架LitePal使用指南

这里只是对于使用 LitePal框架的常用API总结笔记

---

• 基础配置
• 使用注意
• 数据操作
• 注解使用
• 多个数据库
• 1.5新功能

---

基础配置：

1. 依赖引入： compile 'org.litepal.android:core:1.5.0' </br>引入最新资源地址，具体最新版本看LitePal项目的Github：</br> https://github.com/LitePalFramework/LitePal

2. 创建assets目录：同时在assets目录下创建litepal.xml文件:</br>
   

   litepalxml.png

3. 使本地Appliacation继承LitePalApplication

4. Connector.getDatabase(); 就可以创建表，至此配置完成

---

使用注意：

1. 升级表：直接在XML中配置的VERSION改变就可以了
2. 表表之间的关联，LitePal已经帮我们自动在表中作出了ID关联</br>所以我们只需要在对象中保存关联的对象在属性中就可以了
3. 对于列也就是属性，必须设置GET,SET方法才能使用，ID最好也手动设置一下
4. 对于要进行CRUD操作，需要让实体类去继承DataSupport

---

数据操作：

• 插入操作：
• 使用save方法就可以向表中插入数据，返回值表示插入成功与否（ID已经自动设置进去Bean类里面了）
• 多条记录可以使用saveAll(Collection)

News news = new News();  
news.setTitle("这是一条新闻标题");  
news.setContent("这是一条新闻内容");  
news.setPublishDate(new Date());  
news.save(); 
------------------------------------------

List<News> newsList=new ArraysList()
DataSupport.saveAll(newsList);   

• 修改操作：
  返回值表示此次修改影响了多少行数据
• 根据ID修改数据：
  DataSupport: public static int update(Class<?> modelClass, ContentValues values, int id)
• 修改符合条件的数据
  DataSupport: public static int updateAll(Class<?> modelClass, ContentValues values, String... conditions)
• 修改全部数据：
  DataSupport: public static int updateAll(Class<?> modelClass, ContentValues values)
• 自身调用修改:

News updateNews = new News();  
updateNews.setTitle("今日iPhone6发布");  
updateNews.updateAll("title = ? and commentcount > ?", "今日iPhone6发布", "0"); 

• 设置为默认值：

News updateNews = new News();  
updateNews.setToDefault("commentCount");  
updateNews.updateAll();  

• 删除操作：
• 根据ID删除行：
  DataSupport ：public static int delete(Class<?> modelClass, long id)
• 删除符合条件的行：
  DataSupport.deleteAll(News.class, "title = ? and commentcount = ?", "今日iPhone6发布", "0");
• 删除表中全部数据：
  DataSupport.deleteAll(News.class);
• 删除持久化数据对象：

News news = new News();  
news.setTitle("这是一条新闻标题");  
news.setContent("这是一条新闻内容");  
news.save();  
...  
if (news.isSaved()) {  
    news.delete();  
}  

• 查询操作：
• 根据ID的简单查询的多种重载：

News news = DataSupport.find(News.class, 1);
List<News> newsList = DataSupport.findAll(News.class, 1, 3, 5, 7);
long[] ids = new long[] { 1, 3, 5, 7 };  
List<News> newsList = DataSupport.findAll(News.class, ids);

• 连缀查询：

 List<News> newsList = DataSupport.select("title", "content")  
        .where("commentcount > ?", "0")  
        .order("publishdate desc").limit(10).offset(10)  
        .find(News.class);   

• 原生查询：

Cursor cursor = DataSupport.findBySQL("select * from news where commentcount>?", "0");

• 聚合函数（对于字符串是不起作用的）：
• 求数量：
  int result = DataSupport.count(News.class);
• 求总和:
  int result = DataSupport.sum(News.class, "commentcount", int.class);
• 求平均数：
  double result = DataSupport.average(News.class, "commentcount");
• 求最大：
  int result = DataSupport.max(News.class, "commentcount", int.class);
• 求最小：
  int result = DataSupport.min(News.class, "commentcount", int.class);

---

注解使用：

在1.3版本以后可以开始使用约束

• 非空约束 （nullable）
• 唯一约束 （unique ）
• 不映射到表中（ignore）
• 默认值（defaultValue）

@Column(nullable = false)    
private String name;
    
@Column(unique = true)    
private String serial; 

@Column(igonre = true)
private String mark;

@Column(defaultValue = "0")
private String test;

---

多个数据库：

在1.4.0版本以后支持多个数据库使用：

• 创建新的数据库同时插入指定表：

LitePalDB litePalDB = new LitePalDB(String DB_NAME, int Version);
litePalDB.addClassName(Singer.class.getName());
litePalDB.addClassName(Album.class.getName());
litePalDB.addClassName(Song.class.getName());
LitePal.use(litePalDB);

• 创建新的数据库同时使用XML配置的表：

LitePalDB litePalDB = LitePalDB.fromDefault("newdb");
LitePal.use(litePalDB);

• 初始化数据库:

LitePal.useDefault();

• 删除数据库：

LitePal.deleteDatabase("newdb");

---

1.5新功能：

异步操作

• 异步的使用(CRUD全部同理)：在原有命令下加上Async ， 回调监听就如下连缀listen(Callback callBack)

//添加
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) {
    }
});

//查询
DataSupport.findAllAsync(Album.class)
.listen(new FindMultiCallback() {
    @Override
    public <T> void onFinish(List<T> t) {
        List<Album> allAlbums = (List<Album>) t;
    }
});

• 插入或更新（条件符合则更新，没有则插入）

Person p = new Person();
p.setName("小明");
p.setAge(16);
p.saveOrUpdate("name=?", p.getName());