Android学习笔记：SQLite数据库开源库LitePal的基本使用方法

通过项目实践，来熟悉利用开源库LitePal来操作SQLite数据库的基本使用方法。

一、LitePal开源库

1、简介

（1）、LitePal：一款开源的Android数据库框架，它采用了对象关系映射(ORM)模式，将平时开发最常用的一些数据库功能进行了封装，从而使得开发者不用编写一行SQL语句就可以完成各种建表、増删改查的操作。并且LitePal很“轻”，jar包大小不到100k，近乎零配置，这一点和Hibernate这类的框架有很大区别。目前，LitePal的源码已经托管到了GitHub上。地址： https://github.com/LitePalFramework/LitePal。

（2）、对象关系映射：Object Relational Mapping，简称ORM。是通过使用描述对象和数据库之间映射的元数据，将面向对象语言程序中的对象自动持久化到关系数据库中。本质上就是将数据从一种形式转换到另外一种形式。 简单的说，就是将面向关系的数据库和我们使用的面向对象的语言建立一种映射关系。

2、配置

原来需要下载源码或者Jar包才可以使用，现在LitePal开源库项目已经提交到了jcenter上，我们只需要在app/build.grade文件中声明该开源库的引用。

新建项目，LitePalTest， 以下所有关于目录的说明，均在project模式的目录结构下。

（1）、编辑app/build.grade文件，在dependencies闭包中添加以下内容：

dependencies {
    compile 'org.litepal.android:core:1.6.1'
}

编辑完成后，点击页面上方的Sync now来同步。其中，1.6.1是版本号，最新版本号信息可以到LitePal项目主页去查看。

（2）、配置litepal.xml。

  右击app/src/main目录，New -> Directory，新建一个assets目录，在该目录下，New -> File，输入litepal.xml，创建XML文件。并编辑以下内容：

<?xml version="1.0" encoding="utf-8"?>
<litepal>

    <dbname value="BookStore" />

    <version value="1" />

    <list>

    </list>

</litepal>

其中，dbname是数据库名，我们沿用上一篇 关于SQLiteDatabase操作SQLite数据所使用的案例，version是数据库的版本号，list标签指定映射模型。

（3）、配置LitePalApplication。

修改AndroidManifest.xml文件，添加以下内容：

<manifest>
    <application
        android:name="org.litepal.LitePalApplication"
        ...
    >
        ...
    </application>
</manifest>

当然，如果你使用了自己的Application，如下所示：

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        LitePal.initialize(this);
    }
    ...
}

在配置AndroidManifest.xml文件时，则需要按如下所示配置：

<manifest>
    <application
        android:name="com.example.MyApplication"
        ...
    >
        ...
    </application>
</manifest>

经过以上三步配置之后，就可以开始使用LitePal了。

3、创建数据库

继续沿用上一篇案例的布局方案，如下所示：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical" >

    <Button
        android:id="@+id/create_database"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="创建"
        />

    <Button
        android:id="@+id/add_data"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="添加"
        />

    <Button
        android:id="@+id/update_data"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="更新"
        />

    <Button
        android:id="@+id/delete_data"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="删除"
        />

    <Button
        android:id="@+id/query_data"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="查询"
        />

</LinearLayout>

（1）、定义Book类。

package com.my.litepaltest;

public class Book {
    private int id;         //主键，可定义可不定义，会自动生成。
    private String author;  //作者
    private double price;   //价格
    private int pages;      //页数
    private String name;    //书名

    //自动生成的getter和setter方法，Alt + Insert
    
    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }

    public int getPages() {
        return pages;
    }

    public void setPages(int pages) {
        this.pages = pages;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

快速生成getter和setter方法快捷键：Alt + Insert

这个Book类就对应的数据库中的Book表。
（2）、将Book类添加到映射模型中。

修改litepal.xml文件，在list标签下添加以下数据：

<list>
    <mapping class = "com.my.litepaltest.Book" />
</list>

mapping标签就是用来声明我们配置的映射类型，要使用完整的类名。

（3）、修改MainActivity中的代码：

package com.my.litepaltest;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Button;

import org.litepal.LitePal;

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Button createDatabase = (Button)findViewById(R.id.create_database);
        Button addData = (Button)findViewById(R.id.add_data);
        Button updateData = (Button)findViewById(R.id.update_data);
        Button deleteData = (Button)findViewById(R.id.delete_data);
        Button queryData = (Button)findViewById(R.id.query_data);

        //更新按钮点击事件
        createDatabase.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                LitePal.getDatabase();  //打开或创建数据库
            }
        });

    }
}

运行程序，点击创建按钮：

使用adb调试工具，查看数据库是否已经创建。

可以看到数据库已存在，Book也已经建立，还可以查看建表语句：

可以看到建表语句是常规的建表语句，LitePal做了一系列的封装。

4、升级数据库

在使用SQLiteOpenHelper帮助类操作数据库时，升级数据库都是采用DROP语句，将原来的表drop掉在重新创建，虽然可以通过复杂的逻辑来控制原来的表里的数据不被删除，但是维护成本很高。LitePal采用了更加强大的升级数据库方式，无需删除原表，只需要修改、版本号加一两个步骤。

例：在Book表中新增一项press（出版社）列，并再增加一个新的表：Category（图书分类表）。

（1）、修改Book类代码：

public class Book {
    ...
    private String press;   //出版社
	...
    public String getPress() {
        return press;
    }

    public void setPress(String press) {
        this.press = press;
    }
}

（2）、新建Category类

package com.my.litepaltest;

public class Category {
    private int id; 
    private String categoryName;    //分类名
    private int categoryCode;       //分类代码

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getCategoryName() {
        return categoryName;
    }

    public void setCategoryName(String categoryName) {
        this.categoryName = categoryName;
    }

    public int getCategoryCode() {
        return categoryCode;
    }

    public void setCategoryCode(int categoryCode) {
        this.categoryCode = categoryCode;
    }
}

（3）、将Category类添加到映射模型中， 更新数据库一定要记得将版本号加一。

修改litepal.xml文件：

<litepal>

    ...

    <version value="2" />

    <list>
        ...
        <mapping class = "com.my.litepaltest.Category" />
    </list>

</litepal>

运行程序，点击创建按钮，然后查看建表语句，检查是否更新。

数据表已成功创建。

5、添加数据

使用LitePal添加数据只需要将模型类的实例创建出来后，设置好数据，调用save()方法就可以了。

另外， 涉及到LitePal的CURD操作时，模型类必须继承DataSupport类才可以。

（1）、修改Book类。

public class Book extends DataSupport{
	...
}

（2）、修改MainActivity中的代码，在createDatabase的点击事件下新增一个addData的点击事件。

    //添加按钮点击事件
    addData.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            Book book = new Book();
            book.setName("The Da Vinci Code");
            book.setAuthor("Dan Brown");
            book.setPages(454);
            book.setPrice(16.96);
            book.setPress("Unknown");
            book.save();
        }
    });

save()方法在Book类中并不存在，之所以能使用是因为他是从DataSupport类中继承来的。作用就是添加刚刚保存好的数据。
运行程序，点击添加按钮，然后查看Book表中的数据。

可以看到刚刚设置的数据已经保存到了数据库中。

6、更新数据

更新数据有很多种方式（API接口很多），相对于添加数据来说更复杂一点。对于LitePal来说，它只会对 已存储的对象重新设值。

已存储的对象：LitePal通过modle.isSaved()方法来判断该对象是否已存储。返回值为true代表已存储，false代表未存储。

modle.isSaved()返回true的两种情况：

（1）、该对象调用过modle.save()来添加数据了。

（2）、通过LitePal的API查询到的对象。

下面介绍两种更新数据的两种方式：

（1）、对刚刚添加的数据进行更新。

修改MainActivity的代码，在addData的点击事件下，新增一个updateData的点击事件：

public class MainActivity extends AppCompatActivity {

		...

        //更新数据的点击事件
        updateData.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Book book = new Book();
                book.setName("The Lost Symbol");
                book.setAuthor("Dan Brown");
                book.setPages(510);
                book.setPrice(19.95);
                book.setPress("Unknown");
                book.save();
                book.setPrice(10.99);   //对刚才更新的数据重新设值
                book.save();            //调用save()方法更新数据
            }
        });

    }
}

运行程序，然后点击更新按钮，查看Book表中的数据。

可以看到，原本添加的数据是19.95，更新后变成了10.99.

（2）、更灵活的更新方式，updateAll()方法。

updateAll()方法是一种约束式更新，它可以利用约束语句对一行或几行数据进行更新，不添加约束即对该表内的所有数据进行更新。

更改updateData点击事件里的内容：

    //更新数据的点击事件
    updateData.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View v) {
//            Book book = new Book();
//            book.setName("The Lost Symbol");
//            book.setAuthor("Dan Brown");
//            book.setPages(510);
//            book.setPrice(19.95);
//            book.setPress("Unknown");
//            book.save();
//            book.setPrice(10.99);   //对刚才更新的数据重新设值
//            book.save();            //调用save()方法更新数据

            Book book = new Book();
            book.setPrice(14.95);      //设置新的价格
            book.setPress("Anchor");   //设置新的出版社
            //利用约束语句，将书名为The Lost Symbol和作者为Dan Brown的图书价格、出版社更新
            book.updateAll("name = ? and author = ?","The Lost Symbol","Dan Brown");

        }
    });

运行程序，点击更新按钮，查看Book表中的数据：

数据库中的数据已经按照程序预期进行了更新。

注：

①、约束条件的连接符号只能用 and 进行连接，不能使用 & 符号。

②、对某字段进行恢复成默认值时（Java的数据类型都有默认值，如布尔类型的默认值是false），不可以使用setXXX()方法进行设置，只能使用setToDefault()方法。例如：

Book book = new Book();
book.setToDefault("pages");
book.updateAll();

上述代码就是对 pages 字段的值进行恢复默认值。若不添加约束条件，则对Book表的所有 pages 字段均有效。

7、删除数据

LitePal删除数据的方式主要有两种，一种是对 已存储对象的删除操作，调用model.delete()方法。另一种是更加灵活的约束式删除方式。

修改MainActivity代码，在updateData点击事件的下面添加deleteData的点击事件：

public class MainActivity extends AppCompatActivity {

		...

        //删除数据的点击事件
        deleteData.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //删除Book表中价格大于 15 的书籍
                DataSupport.deleteAll(Book.class,"price > ?","15");
            }
        });

    }
}

运行程序，点击删除按钮，查看Book表中的数据：

对比上一次的查询结果，价格大于15的书籍已经被删除。

注：

①：不再是创建Book类实例进行操作，而是调用DataSupport类的deleteAll()方法进行删除操作。

②：deleteAll()方法若不指定约束条件，则删除表内所有数据。

8、查询数据

数据库最强大的功能就是查询，LitePal对查询方法进行了很多优化，有很多方法可供选择。

修改MainActivity中的代码，在deleteData的点击事件下新增一个queryData点击事件。

public class MainActivity extends AppCompatActivity {

		...
		
        //查询数据的点击事件
        queryData.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //查询Book表的所有数据，返回List列表
                List<Book> books = DataSupport.findAll(Book.class);
                for(Book book : books){
                    Log.d("MainActivity", "book name is " + book.getName());
                    Log.d("MainActivity", "book author is " + book.getAuthor());
                    Log.d("MainActivity", "book pages is " + book.getPages());
                    Log.d("MainActivity", "book prices is " + book.getPrice());
                    Log.d("MainActivity", "book press is " + book.getPress());
                }
            }
        });

    }
}

运行程序，点击查询按钮，查看Logcat输出：

数据库中仅剩的一条数据的详细信息已经被打印了出来。

注：

①：不再是创建Book类实例进行操作，而是调用DataSupport类的findAll()方法进行删除操作。

②：findAll()方法返回的是一个List列表。

③：findAll()方法若不指定约束条件，则返回表内所有数据

更多的LitePal查询方式：

（1）、查询Book表的第一条数据

Book firstBook = DataSupport.findFirst(Book.class);

（2）、查询Book表的最后一条数据

Book lastBook = DataSupport.findLast(Book.class);

（3）、select()方法用于指定查询某几列的数据，对应SQL的select关键字，例如只查询name和author两列的数据：

List<Book> books = DataSupport.select("name","author").find(Book.class);

（4）、where()方法用于指定查询的约束条件，对应SQL的where关键字，例如只查询页数大于400的书籍：

List<Book> books = DataSupport.where("pages > ?","400").find(Book.class);

（5）、order()方法用于指定结果的排序方式，对应SQL的order by关键字，例如将查询结果按书价从高到低排序：

List<Book> books = DataSupport.order("price desc").find(Book.class);

其中desc代表降序，asc或者不写表示升序。

（6）、limit()方法用于指定查询结果的数量，例如查询表中的前三条数据：

List<Book> books = DataSupport.limit(3).find(Book.class);

（7）、offset()用于指定查询结果的偏移量，例如查询表中的第2、3、4条数据：

List<Book> books = DataSupport.limit(3).offset(1).find(Book.class);

limit()和offset()方法共同对应了SQL的limit关键字。

（8）、更灵活的查询方式，将上述5种方法进行任意的连缀组合，完成一个复杂的查询：

List<Book> books = DataSupport.select("name","author","pages")
							  .where("pages > ?","400")
							  .order("pages")
							  .limit(10)
							  .offset(10)
							  .find(Book.class);

这段代码的含义是：查询10~20行中满足页数大于400这个条件的name、author和pages这三列数据，并将查询结果按页数的升序排列。

（9）、LitePal仍然支持使用原生的SQL来查询：

Cursor cursor = DataSupport.findBtSQL("select * from Book where pages > ? and price < ?","400","200");

9、异步操作

默认情况下，每个数据库操作都在主线程上，如果你的操作可能要花费大量的时间，例如保存或查询大量数据，就会使用到异步操作。LitePal支持CURD所有方法的异步操作，若是想从后台线程中查询Book表（假设此时Book表里的数据非常多）中的所有数据，可以使用以下的代码：

DataSupport.findAllAsync(Book.class).listen(new FindMultiCallback() {
    @Override
    public <T> void onFinish(List<T> t) {
        List<Book> books = (List<Book>) t;
    }
});

如果使用findAllAsync()而不是findAll()，需要添加一个listen()方法，一旦操作完成，查询结果将在onFinish()方法中被回调。

book.setName("The Da Vinci Code");
book.setAuthor("Dan Brown");
book.setPages(454);
book.setPrice(16.96);
book.setPress("Unknown");
book.saveAsync().listen(new saveCallback(){
	@Override
    public void onFinish(boolean success) {
		...
    }
});

如果使用saveAsync()而不是save()方法，将会在后台向数据库中添加数据，保存结果将在onFinish()方法中被回调。

10、多个数据库

如果应用程序需要多个数据库，LitePal同样支持，你可以在程序运行时创建多个数据库。

例如在运行时，创建一个Person数据库，包含姓名name、年龄Age和性别Sex三个字段：

LitePalDB litePalDB = new LitePalDB("Person", 1);
litePalDB.addClassName(Name.class.getName());
litePalDB.addClassName(Age.class.getName());
litePalDB.addClassName(Sex.class.getName());
LitePal.use(litePalDB); 	//创建数据库

如果想新建一个数据库，但是这个数据库的配置和litepal.xml一样，可以使用以下代码：

LitePalDB litePalDB = LitePalDB.fromDefault("BookStore");
LitePal.use(litePalDB); 	//使用litepal.xml创建一个新数据库

也可以随时返回默认的数据库：

LitePal.useDefault(); 	//返回默认数据库

也可以通过指定数据库的名字来删除它：

LitePal.deleteDatabase("BookStore"); 	//删除数据库

对比使用SQLiteDatabase来操作SQLite数据库，LitePal在使用上会更加强大。

本文总结参考自郭神（郭霖）的《第一行代码 第2版》和GitHub上的源码说明。

LitePal是郭神开发的开源库，书中都没有说明，百度了才知道，真的是低调！！