在Android开发中使用ORMLite--篇一

前言

在android开发中，数据需要本地存储，当需要进行一系列的操作时，当然是使用sqlite。标准做法是继承SQLiteOpenHelper，重写onCreate和onUpdate方法。存在比较大的问题是，sql语句需要自己写，比较复杂繁琐而且重复率高，于是找了一个orm框架在新写的app中进行试用。

准备

下载地址：http://ormlite.com/releases/

下载core和android两个jar包，并引入工程即可

开发

模型注解

首先定义一个最常见的人员模型

// tableName定义表名，缺省为类名
@DatabaseTable(tableName = "table_person")
public class Person{

    @DatabaseField(generatedId = true)
    private int id;

    // columnName定义字段名，缺省为变量名
    @DatabaseField(columnName = "first_name")
    private String firtName;

    @DatabaseField
    private String lastName;

    // 需要定义一个无参构造函数，ormlite用来查询时用反射构建对象
    public Person() {
    }

    // other constructors...

    // getters and setters...
}

@DatabaseField注解域说明如下：

官网原文

完成Helper

与原生的SQLiteOpenHelper相似，使用ORMLite需要继承OrmLiteSqliteOpenHelper，如下：

public class DBHelper extends OrmLiteSqliteOpenHelper {

    private DBHelper(Context context) {
        super(context, TABLE_NAME, null, VERSION);
    }

    // 创建表在这里就非常简单了，使用TableUtils的createTable方法即可，不需要写CREATE TABLE等等的sql语句。
    @Override
    public void onCreate(SQLiteDatabase database, ConnectionSource connectionSource) {
        try {
            TableUtils.createTable(connectionSource, Person.class);
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

    // 重写onUpdate方法
    @Override
    public void onUpgrade(SQLiteDatabase database,
                        ConnectionSource connectionSource, int oldVersion, int newVersion) {
        try {
            // 删除旧表再新建表，也可以对表进行相应的更新操作
            TableUtils.dropTable(connectionSource, Person.class, true);
            onCreate(database, connectionSource);
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

获取Dao

对于orm来说，dao是用于数据库操作的通常做法。在Helper中加入如下代码：

// 声明静态实例
private static DBHelper instance;
// 声明dao
private Dao<Person, Integer> personDao;

/**
 * 单例获取该Helper
 *
 * @param context
 * @return
 */
public static synchronized DBHelper getHelper(Context context) {
    context = context.getApplicationContext();
    if (instance == null) {
        synchronized (DatabaseHelper.class) {
            if (instance == null)
                instance = new DatabaseHelper(context);
        }
    }
    return instance;
}  

// 获取某个dao，有多个表的情况，可能需要写多个获取dao的方法
public Dao<Person, Integer> getPersonDao() throws SQLException {
    if (personDao == null) {
        personDao = getDao(Person.class);
    }
    return personDao;
}

// 释放资源
@Override
public void close() {
    super.close();
    personDao = null;
}

// 另外也可以有通用方法
public synchronized Dao getDao(Class clazz) throws SQLException {
    Dao dao = null;
    String className = clazz.getSimpleName();  

    if (daos.containsKey(className)) {
        dao = daos.get(className);
    }
    if (dao == null) {
        dao = super.getDao(clazz);
        daos.put(className, dao);
    }
    return dao;
}

单独创建dao类

public class PersonDao {

    private Context context;

    public PersonDao(Context context) {
        this.context = context;
    }

    public void add(Person person) {
        try {
            DBHelper.getHelper(context).getPersonDao().create(person);
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

使用

准备好后，使用起来也非常方便

// 获取helper
DBHelper helper = DBHelper.getHelper(getContext());
// 构造
Person xiaoming = new Person();
xiaoming.setFirstName("Ming");
xiaoming.setLastName("Xiao");
// 保存
helper.getPersonDao().create(xiaoming);