LitePal框架浅析

LitePal框架浅析

因为在移动软件开发课程期中记事本项目中使用到了LitePal框架，感到方便、实用之余，也很好奇作者究竟是怎么实现的，所以在这里就简单地分析一下源码(主要是CRUD操作部分)。

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"?>
<litepal>
 	<!-- 数据库名 -->
    <dbname value="demo" />

    <!-- 数据库版本号 -->
    <version value="1" />

    <!-- 
    定义模型映射, e.g.  
    	<list>
    		<mapping class="com.test.model.Reader" />
    		<mapping class="com.test.model.Magazine" />
    	</list>
    -->
    <list>
    	<mapping class="com.test.model.Album" />
    </list>
       
</litepal>

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

public class Album extends LitePalSupport {
	
    private String name;
	
    private float price;
	
    private byte[] cover;
	
    private Date releaseDate;
	
    private List<Song> songs = new ArrayList<Song>();

    // 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<Field> supportedFields = getSupportedFields(className);
Collection<AssociationsInfo> associationInfos = getAssociationInfo(className);
if (!baseObj.isSaved()) {
			analyzeAssociatedModels(baseObj, associationInfos);
			doSaveAction(baseObj, supportedFields);
			analyzeAssociatedModels(baseObj, associationInfos);
		} else {
			analyzeAssociatedModels(baseObj, associationInfos);
			doUpdateAction(baseObj, supportedFields);
		}

如果是已经已经保存的对象则直接执行更新操作，否则执行保存操作。
接下来继续看doSavaAction()方法:

private void doSaveAction(LitePalSupport baseObj, List<Field> supportedFields, List<Field> 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) {
        if (values.size() == 0) {
            values.putNull("id");
        }
		return mDatabase.insert(baseObj.getTableName(), null, values);
	}

是不是觉得似曾相识？对的，这里最终执行的还是SQLiteDatabase中的insert方法。同样的doUpdateAction()方法与之类似，最终调用的是SQLiteDatabase中的update方法，这里就不再详叙了。这就是litepal框架保存数据的最终实现。

三、更新数据

保存数据最终是调用SQLiteDatabase中提供的方法实现保存，更新数据会不会也一样呢？接下来咱们一起来看看LitaPal是怎么实现数据更新的。首先看一个使用LitePal更新数据的实例：

Album albumToUpdate = new Album();
albumToUpdate.setPrice(20.99f); // raise the price
albumToUpdate.update(id);

当然更新数据也可以使用sava()方法，原因第二部分讲过了，这里就不再重复。
LitePal提供了update()和updateAll()等方法更新数据，因为实现大同小异，所以我们这里只分析update()方法。
DataSupport.update( id)：

public synchronized int update(long id) {
		try {
			UpdateHandler updateHandler = new UpdateHandler(Connector.getDatabase());
			int rowsAffected = updateHandler.onUpdate(this, id);
			getFieldsToSetToDefault().clear();
			return rowsAffected;
		} catch (Exception e) {
			throw new DataSupportException(e.getMessage());
		}
	}

UpdateHandler.onUpdate():

int onUpdate(LitePalSupport baseObj, long id) throws SecurityException, IllegalArgumentException,
			NoSuchMethodException, IllegalAccessException, InvocationTargetException {
		List<Field> supportedFields = getSupportedFields(baseObj.getClassName());
		List<Field> supportedGenericFields = getSupportedGenericFields(baseObj.getClassName());
        updateGenericTables(baseObj, supportedGenericFields, id);
		ContentValues values = new ContentValues();
		putFieldsValue(baseObj, supportedFields, values);
		putFieldsToDefaultValue(baseObj, values, id);
		if (values.size() > 0) {
			return mDatabase.update(baseObj.getTableName(), values, "id = " + id, null);
		}
		return 0;
	}

没有猜错，果然还是熟悉的味道。前面两个方法用于给各字段赋值，后面使用SQLiteDatabase对象的update方法。

四、删除数据

LitePal提供的删除方法也很多，这里也只分析按id删除的方法。还是先看一个实例:

LitePal.delete(Album.class, id);

这是一个静态方法，接着看代码:

public static synchronized int delete(Class<?> modelClass, long id) {
		int rowsAffected = 0;
		SQLiteDatabase db = Connector.getDatabase();
		db.beginTransaction();
		try {
			DeleteHandler deleteHandler = new DeleteHandler(db);
			rowsAffected = deleteHandler.onDelete(modelClass, id);
			db.setTransactionSuccessful();
			return rowsAffected;
		} finally {
			db.endTransaction();
		}
	}

看完前面几种操作的源码，这个应该很容易理解了，首先获取一个SQLiteDatabase实例，接着开启事务，进行删除操作，最后关闭事务。让我们来看看DeleteHandler的onDelete方法：

int onDelete(Class<?> modelClass, long id) {
		analyzeAssociations(modelClass);
		int rowsAffected = deleteCascade(modelClass, id);
		rowsAffected += mDatabase.delete(getTableName(modelClass), "id = " + id, null);
		getForeignKeyTableToDelete().clear();
		return rowsAffected;
	}

analyzeAssociations()方法解析关联关系，并保存关联的表；
getForeignKeyTableToDelete().clear();删除关联表中的相关数据。

依旧是调用SQLiteDatabase的delete方法。值得注意的是这个方法可以实现级联删除，当该条数据被删除所有被引用的数据也将被删除(All the referenced data such as foreign key value will be removed too)。

---

END

以上就是我对LitePal框架的一些理解，写的不对的地方欢迎留言指正啦~~~