LitePal框架浅析，阿里正式启动2021届春季校招

LitePal简介

LitePal是一款开源的Android数据库框架，采用了对象关系映射(ORM)的模式，将平时开发时最常用的一些数据库功能进行了封装，使得开发者不用编写一行SQL语句就可以完成各种建表、増删改查的操作。

LitePal项目地址:https://github.com/LitePalFramework/LitePal

一、更新表结构

使用LitePal框架需要在项目中新建一个含litepal.xml文件的assets文件夹，以及创建各个实体类，实体类应继承LitePalSupport类。

litepal.xml应包含如下代码:

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

假如我们的实体类是这样的:

public class Album extends LitePalSupport {

private String name;

private float price;

private byte[] cover;

private Date releaseDate;

private List songs = new ArrayList();

// generated getters and setters.

…

}

此时如果需要更新表结构，只需修改实体类，并更改litepal.xml中的数据库版本号，在下一次操作数据库时就会更新表结构，非常巧妙的设计，那么他究竟是怎么实现的呢？让我们一起去看源码吧。

@Override

public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {

Generator.upgrade(db);

SharedUtil.updateVersion(newVersion);

}

这里首先继承了SQLiteOpenHelper类，并重写了onCreate()和onUpgrade()方法。

Generator中的upgrade(SQLiteDatabase db)方法:

static void upgrade(SQLiteDatabase db) {

drop(db);

create(db, false);

updateAssociations(db);

upgradeTables(db);

addAssociation(db, false);

}

第一步删除原数据库，第二步创建新数据库，第三步更新数据库表(移除外键)，第四步更新所有数据库中的表，第五步添加外键。各方法的具体实现这里就不赘述了，想了解请移步github。

SharedUtil中的updateVersion(int newVersion)方法：

public static void updateVersion(int newVersion) {

SharedPreferences.Editor sEditor = LitePalApplication.getContext()

.getSharedPreferences(LITEPAL_PREPS, Context.MODE_PRIVATE).edit();

sEditor.putInt(VERSION, newVersion);

sEditor.commit();

}

很明显，这段代码是将新的版本号用SharedPreferences保存在本地。

二、保存数据

使用LitePal保存数据示例:

Album album = new Album();

album.setName(“album”);

album.setPrice(10.99f);

album.setCover(getCoverImageBytes());

album.save();

这个save()方法是继承父类LitePalSupport的方法，想要进行CRUD操作，实体类必须继承LitePalSupport类。现在我们一起来看一下save()方法是怎么实现的:

/*@return If the model is saved successfully, return true. Any exception

```
    happens, return false.
```

public boolean save() {

try {

saveThrows();

return true;

} catch (Exception e) {

e.printStackTrace();

return false;

}

savaThrows()方法:

public void saveThrows() {

synchronized (LitePalSupport.class) {

SQLiteDatabase db = Connector.getDatabase();

db.beginTransaction();

try {

SaveHandler saveHandler = new SaveHandler(db);

saveHandler.onSave(this);

clearAssociatedData();

db.setTransactionSuccessful();

} catch (Exception e) {

throw new LitePalSupportException(e.getMessage(), e);

} finally {

db.endTransaction();

}

这里主要看onSave()方法，这是onSave()方法的关键代码:

String className = baseObj.getClassName();

List supportedFields = getSupportedFields(className);

Collection associationInfos = getAssociationInfo(className);

if (!baseObj.isSaved()) {

analyzeAssociatedModels(baseObj, associationInfo
s);

doSaveAction(baseObj, supportedFields);

analyzeAssociatedModels(baseObj, associationInfos);

} else {

analyzeAssociatedModels(baseObj, associationInfos);

doUpdateAction(baseObj, supportedFields);

}

如果是已经已经保存的对象则直接执行更新操作，否则执行保存操作。

接下来继续看doSavaAction()方法:

private void doSaveAction(LitePalSupport baseObj, List supportedFields, List supportedGenericFields)

throws SecurityException, IllegalArgumentException, NoSuchMethodException,

IllegalAccessException, InvocationTargetException {

values.clear();

beforeSave(baseObj, supportedFields, values);

long id = saving(baseObj, values);

afterSave(baseObj, supportedFields, supportedGenericFields, id);

}

beforeSave()方法:在保存之前，先对其进行解析，把所有的数据包括字段值和外键值保存在ConteneValues中。saving()方法，返回值是long:

private long saving(LitePalSupport baseObj, ContentValues values) {