[Android] 一种移动APP中DAO访问的设计思路

今天把之前项目中关于SQLite的使用进行一个总结，相关的基本的概念性的东西就不说了。此处主要理一下，在一个APP中DB访问这一层的一种设计思路。直接上代码，先来一个直观的感觉。

一种设计思路

public class DBUtils extends SQLiteOpenHelper {
    private static final String TAG = "DBUtils";
    private static int version = 1;
    private static DBUtils instance = null;
    private static HashMap<String, String> tables = null;
    private static String DB_NAME = "test.db";
    private static final String DROP_TABLE_SQL = "DROP TABLE IF EXISTS %1$s";

    interface IUser {
        public static final String TABLE_NAME = "user";
        public static final String COLUMN_ID = "id";
        public static final String COLUMN_NAME = "name";
        public static final String COLUMN_EMAIL = "email";

        public static final String CREATE_TABLE_SQL = "CREATE TABLE IF NOT EXISTS %1$s("
                + COLUMN_ID
                + " INTEGER PRIMARY KEY AUTOINCREMENT,"
                + COLUMN_NAME
                + " TEXT,"
                + COLUMN_EMAIL           
                + " TEXT" + ")";
    }

    public static DBUtils getInstance(Context context) {
        if (instance == null) {
            instance = new DBUtils(context);
        }
        if (tables == null) {
            tables = new HashMap<String, String>();
            tables.put(IUser.TABLE_NAME, IUser.CREATE_TABLE_SQL);
        }
        return instance;
    }

    private DBUtils(Context context) {
        super(context, DB_NAME, null, version);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        try {
            db.beginTransaction();
            for (String str : tables.keySet()) {
                db.execSQL(tables.get(str));
            }
            db.setTransactionSuccessful();
        } catch (Exception e) {
            Log.i(TAG, "Create table error");
        } finally {
            db.endTransaction();
        }       
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        dropAllTables();
        onCreate(db);
    }
    public void dropAllTables() {
        SQLiteDatabase db = instance.getWritableDatabase();
        try {
            for (String tableName : tables.keySet()) {
                db.execSQL(String.format(DROP_TABLE_SQL, tableName));
            }
            db.setTransactionSuccessful();
        } catch (Exception e) {
            Log.i(TAG, "Create table error");
        } finally {
            db.endTransaction();
        }     
    }

    public void addUser(User user) {
        ContentValues values = new ContentValues();
        values.put(IUser.COLUMN_NAME, user.getName());
        values.put(IUser.COLUMN_EMAIL, user.getEmail());
        SQLiteDatabase db = instance.getWritableDatabase();
        db.insert(IUser.TABLE_NAME, null, values);
    }

    public void deleteByEmail(String email) {
        SQLiteDatabase db = instance.getWritableDatabase();
        db.delete(IUser.TABLE_NAME, "\"" + IUser.COLUMN_EMAIL + " = ? " + "\"", new String[] {email});
    }

    public void updateUserById (int id) {
        ContentValues values = new ContentValues();
        values.put(IUser.COLUMN_NAME, "userName");
        values.put(IUser.COLUMN_EMAIL, "userEmail");
        SQLiteDatabase db = instance.getWritableDatabase();
        db.update(IUser.TABLE_NAME, values, "id = ?", new String [] {id});
    }

}

相关解释

我们在做DAO层是这样考虑的，所有的与数据库相关的操作全部整合在在这一个类中。刚开始，不是很理解为什么这样做。可能是因为之前做Web做了蛮长时间，一直觉得不适应，始终觉得应该是为每一个相应的model定义一个DAO访问类，虽然在我们的另一个项目中也是这样做的。但后来觉得，不应该把做Web的思路带到做移动APP中来，做Web时，每一个model都有对应的表，都会做数据的持久化，写入到数据库中，但做移动APP的开发，SQLite是用来做数据的缓存的。并不是每一个model都需要做缓存。当然如果一个APP要缓存的数据非常多，那就不能采用这种设计方式了。否则这个类以后代码将会非常多，很难维护。但对于一个小型的APP，这种设计是完全可以搞定的。
代码中的private static int version = 1是定义数据库的版本号，在做数据库的升级时会使用到这个属性。
采用IUser这种方式来定义一个表的相关属性，表名，表中的字段，建表语句全部都以这个接口的属性这种形式存在。如果有多张表，类中就有多个这种形式的接口。
整个类是采用单例的设计，实际上此处的单例还可以优化，可参看另一篇文章。在初始化本类实例的时候，也会对属性tables进行初始化。tables是一个HashMap，其key是表名，value是对应的建表的语句。这样便于在创建表和删除表时进行管理。
属性DB_NAME指整个APP的DB名称，与其物理文件是对应的。
在类的onCreate方法里面，执行创建表的操作。
onUpgrade方法会在数据库升级时触发。这个里面很常见的一个操作是先清空表，再重新新建表。
SQLite 的基本操作

关于SQLIte的基本操作，网上一搜就一大堆。有过数据库开发经验的人可以说是马上就上手。不想做过多的说明。总结几点(没有测试，只做思路说明)：插入

采用ContentValues，每一个ContentValues实例实际上就是对应表里面的一条数据。如下操作：

public void addUser(User user) {
    ContentValues values = new ContentValues();
    values.put(IUser.COLUMN_NAME, user.getName());
    values.put(IUser.COLUMN_EMAIL, user.getEmail());
    SQLiteDatabase db = instance.getWritableDatabase();
    db.insert(IUser.TABLE_NAME, null, values);
}

删除

public void deleteByEmail(String email) {
    SQLiteDatabase db = instance.getWritableDatabase();
    db.delete(IUser.TABLE_NAME, "\"" + IUser.COLUMN_EMAIL + "= ? " + "\"", new String[] {email});
}

如果是删除一整张表中的数据就用

instance.getWritableDatabase().delete(IUser.TABLE_NAME, null, null);

更新

实际上和插入的操作差不多。

ContentValues values = new ContentValues();
values.put(IUser.COLUMN_NAME, "userName");
values.put(IUser.COLUMN_EMAIL, "userEmail");
SQLiteDatabase db = instance.getWritableDatabase();
db.update(IUser.TABLE_NAME, values, "id = ?", new String [] {id});

查询

查询操作实际上就是利用Cursor.
Cursor localCursor = instance.getReadableDatabase().query(IUser.TABLE_NAME, null, "email = ?", new String[] { email }, null, null, null);
然后再就是移动Cursor，取值。

说明

在SQLite的使用过程中，没有必要每一次在操作完数据库后就关闭数据库连接，否则会造成莫名的Exception.通常应用中操作数据库都是采用新开一个线程来执行，有可能有两个线程都在操作数据库。第一个线程操作完后若关闭了数据库连接，第二个线程还正在操作数据库，就会出问题了。当然关闭数据库连接出现的Exception并不局限于这种情况，但是我们在使用时，没有手动关闭数据库连接是不会有问题，一旦手动关闭就会出现一些莫名其妙的问题。其中缘由还需Rearch。

今天无意中发现了这篇博客，可能和之前碰到的关闭数据库连接会产生Crash有些关系，先记录在这, 抽时间研究一下［2015-06-03］

fred-ye / summary

[Android] 一种移动APP中DAO访问的设计思路 #28

一种设计思路

SQLite 的基本操作

说明