Android SQL 超實用設計

 最近由於工作原因，經常需要保存用戶數據，其中涉及創建表格、增刪改查操作。雖然 SQLiteDatabase 提供 insert 、delete、update、query 方法，但每次都要小心翼翼傳入參數，對於頻繁操作數據數據比較容易出錯，影響工作效率。現在我重新學習項目中數據庫設計的方法，其中把每一張表字段寫在一個bean，通過繼承基礎 BaseDao ，調用公共的數據庫指令。 這樣做的好處很明顯：①邏輯清晰，方便以后數據的增添；②操作規范，不用每次打開數據庫或者關閉數據庫，避免忘記關閉數據庫等誤操作。

     現在自己寫了一個學生信息的 Demo ,SQL 操作示意圖如下，有興趣的朋友可以看看。

 

代碼詳解

1、布局文件相當簡單，設置創建數據庫、更新數據庫和增刪改查操作，代碼如下所示：

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

    <Button
        android:id="@+id/createDatabase"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:background="@color/colorBackGround"
        android:text="創建數據庫" />

    <Button
        android:id="@+id/updateDatabase"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="5dp"
        android:background="@color/colorBackGround"
        android:text="更新數據庫" />

    <Button
        android:id="@+id/insert"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="5dp"
        android:background="@color/colorBackGround"
        android:text="插入數據" />

    <Button
        android:id="@+id/update"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="5dp"
        android:background="@color/colorBackGround"
        android:text="更新數據" />

    <Button
        android:id="@+id/query"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="5dp"
        android:background="@color/colorBackGround"
        android:text="查詢數據" />

    <Button
        android:id="@+id/delete"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="5dp"
        android:background="@color/colorBackGround"
        android:text="刪除數據" />
</LinearLayout>

布局很簡單，頁面如下所示

2、自定義一個繼承 SQLiteOpenHelper 的類 SQLiteHelper，重寫 onCreate(SQLiteDatabase sqLiteDatabase) 和 onUpgrade(SQLiteDatabase sqLiteDatabase, int oldVersion, int newVersion) 方法。其中當調用 SQLiteHelper 的 getReadableDatabase() 或者 getWritableDatabase() 時，如果沒有創建數據庫，則自動創建數據庫；接着調用 onCreate(SQLiteDatabase sqLiteDatabase) 方法，一般在這里創建數據庫表，當有版本更新時，走 onUpgrade(SQLiteDatabase sqLiteDatabase, int oldVersion, int newVersion) 方法，更新最新的數據庫表。

/**
 * Created by LCS on 2016/11/1.
 */
public class SQLiteHelper extends SQLiteOpenHelper {

    private static final String TAG = "LCS_SQLiteHelper";
    private static final String db_name = "sql.db";//數據庫名稱
    private static final SQLiteDatabase.CursorFactory factory = null;//暫時用不到
    private static final int version = 1;//版本號，方便以后項目更新用戶數據庫
    private static SQLiteHelper sqLiteHelper = null;//實例化 SQLiteHelper 對象

    //創建班級通訊錄
    private static final String create_class_address = SQLInstruction.createClassAddress();
    /**
     * 構造函數
     * @param context
     */
    public SQLiteHelper(Context context){
        super(context, db_name, factory, version);
    }

    /**
     * 獲取實例
     * @param context
     * @return
     */
    public static SQLiteHelper getInstance(Context context){

        if(sqLiteHelper == null){
            sqLiteHelper = new SQLiteHelper(context);
        }
        return sqLiteHelper;
    }

    /**
     * 第一次創建數據庫，調用此方法
     * @param sqLiteDatabase
     */
    @Override
    public void onCreate(SQLiteDatabase sqLiteDatabase) {

        //創建班級通訊錄表
        sqLiteDatabase.execSQL(create_class_address);
        Log.d(TAG,"create db");
    }

    /**
     * 更新數據庫
     * @param sqLiteDatabase
     * @param oldVersion
     * @param newVersion
     */
    @Override
    public void onUpgrade(SQLiteDatabase sqLiteDatabase, int oldVersion, int newVersion) {

        if(version > 1){
            sqLiteDatabase.execSQL(create_class_address);
            Log.d(TAG,"upgrade db");
        }
    }
}

3、先構建數據庫連接管理器類 ConnectionProvider，這是真正執行數據庫語句的位置。其中 execute(String sql) 可以執行數據庫增加、刪除和更新操作，query(String sql) 執行查找操作。被執行的的數據庫指令為 Stiing 類型，我們只需要檢查此語句正確性 ( 推薦使用 SQLite3 可視化工具 )，傳入給對應的方法即可，是不是很方便？

/**
 * Created by lcs on 2016/11/2.
 * 連接管理器，數據庫語句真正執行位置
 */
public class ConnectionProvider {
    private SQLiteDatabase db;
    private SQLiteHelper sqLiteHelper;
    private Context context;
    private static ConnectionProvider provider;

    public ConnectionProvider(Context context){
        this.context = context;
/*        //初始化
        initProvider();*/
    }
    //初始化
    private void initProvider() {
        if(sqLiteHelper == null){
            sqLiteHelper = SQLiteHelper.getInstance(context);
            db = null;
        }
        if(db == null){
            db = sqLiteHelper.getWritableDatabase();
        }
    }

    /**
     * 真正執行數據庫操作
     * @param sql
     */
    public synchronized void execute(String sql){
        //打開數據庫
        openDB();
        db.execSQL(sql);
        //關閉數據庫
        closeDB(db);
    }

    /**
     * 真正執行數據庫操作
     * @param sql
     */
    public synchronized Cursor query(String sql){
        //打開數據庫
        openDB();
        return db.rawQuery(sql,null);
    }

    /**
     * 打開數據庫
     */
    private void openDB() {
        try {
            initProvider();
        }catch (Exception e){
            e.printStackTrace();
        }
    }

    /**
     * 關閉數據庫
     * @param db
     */
    private void closeDB(SQLiteDatabase db) {
        try {
            sqLiteHelper = null;
            db.releaseReference();
        }catch (Exception e){
            e.printStackTrace();
        }
    }

    /**
     * 獲取 ConnectionProvider 實例
     * @return
     */
    public static ConnectionProvider getInstance(Context context){
        if(provider == null){
            provider = new ConnectionProvider(context);
        }
        return provider;
    }
}

4、構建基礎 Dao。BaseDao 很簡單，但很重要。當以后有操作數據庫需求，只需要定義 某某 Dao 繼承 BaseDao，即可調用公共的數據庫操作。

/**
 * 基礎 Dao
 * Created by lcs on 2016/11/2.
 */
public abstract class BaseDao <T>{
    private Context context;
    private ConnectionProvider provider;

    public BaseDao(Context context){
        this.context = context;
        this.provider = ConnectionProvider.getInstance(context);
    }

    /**
     * 執行 SQL 語句
     */
    public synchronized void execute(String sql){
        provider.execute(sql);
    }

    /**
     * 執行 SQL 語句
     */
    public synchronized Cursor query(String sql){
        return provider.query(sql);
    }

    /**
     * 是否有結果集
     * @param c
     * @return
     */
    protected synchronized boolean hasResult(Cursor c){
        boolean has=false;
        if(c.moveToFirst()&&c.getCount()>0){
            has=true;
        }
        return has;
    }

}

5、創建學生信息 bean 。其中 StudentInfoBean 為需要存儲進數據庫的字段信息

/**
 * Created by user on 2016/11/2.
 * 學生信息
 */
public class StudentInfoBean {
    private String name = "";//姓名
    private String id = "";//學號
    private String age = "";//年齡
    private String tall = "";//身高

    public String getName() {
        return name;
    }

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

    public String getId() {
        return id;
    }

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

    public String getAge() {
        return age;
    }

    public void setAge(String age) {
        this.age = age;
    }

    public String getTall() {
        return tall;
    }

    public void setTall(String tall) {
        this.tall = tall;
    }
}

6、創建學生 Dao。其中 StudentDao 繼承 BaseDao，在通過學號 id 查找和刪除學生信息方法中，其實也可以傳入其他學生信息進行查找，例如學生 name 、age 等。還有通過 id 可能查到多條記錄，規范寫法應該寫成返回 StudentInfoBean 的 List 。

/**
 * Created by lcs on 2016/11/2.
 * 學生信息的 Dao
 */
public class StudentDao extends BaseDao {

    public StudentDao(Context context) {
        super(context);
    }

    /**
     * 增加一條學生記錄
     * @param studentInfoBean
     * @return
     */
    public boolean addStudent(StudentInfoBean studentInfoBean){
        boolean flag = false;
        if(studentInfoBean != null){
            flag = true;
            execute(SQLInstruction.addStudent(studentInfoBean));
            return flag;
        }else {
            return flag;
        }
    }

    /**
     * 通過學號 id 刪除學生信息
     * @param id
     * @return
     */
    public boolean deleteStudentById(String id){
        boolean flag = false;
        if(id != "" && !id.isEmpty()){
            flag = true;
            execute(SQLInstruction.deleteStudentById(id));
            return flag;
        }else {
            return flag;
        }
    }

    /**
     * 更新指定列學生信息
     * @param column
     * @param old_value
     * @param new_value
     * @return
     */
    public boolean updateStudent(String column ,String old_value,String new_value){
        boolean flag = false;
        if(column != "" && !column.isEmpty()){
            execute(SQLInstruction.updateStudent(column,old_value,new_value));
            flag = true;
            return flag;
        }else {
            return flag;
        }
    }

    /**
     * 通過學號 id 查詢學生信息
     * @param id
     * @return
     */
    public StudentInfoBean queryStudent(String id){
        StudentInfoBean studentInfoBean = new StudentInfoBean();
        if(id != "" && !id.isEmpty()){
            Cursor cursor = query(SQLInstruction.queryStudentById(id));
            if(hasResult(cursor)){
                studentInfoBean.setName(cursor.getString(cursor.getColumnIndex("NAME")));
                studentInfoBean.setAge(cursor.getString(cursor.getColumnIndex("AGE")));
                studentInfoBean.setTall(cursor.getString(cursor.getColumnIndex("TALL")));
                cursor.moveToNext();
            }
            cursor.close();
        }
        return studentInfoBean;
    }
}

7、看到現在，不知道你會不會覺得很奇怪，為什么還沒有涉及真正數據庫操作語句？那是因為我們把所有數據庫語句放在一個類中 SQLInstruction。為方便調用，將每一個數據庫操作方法設置為 static。看到這里，你是否發現如此設計數據庫操作好處呢？

/**
 * Created by user on 2016/11/1.
 * 數據庫語句
 */
public class SQLInstruction {

    /**
     * 創建班級通訊錄表
     *
     * @return
     */
    public static String createClassAddress() {
        StringBuffer sql = new StringBuffer();
        sql.append("create table IF NOT EXISTS CLASS_ADDRESS("
                + "NAME String," + "ID int," +"AGE int,"
                + "TALL int," + "CLASS_NAME String" + " )");
        return sql.toString();
    }

    /**
     * 在數據庫添加一條學生記錄
     */
    public static String addStudent(StudentInfoBean student){
        StringBuffer sql = new StringBuffer("insert into CLASS_ADDRESS(")
                .append("NAME,")
                .append("ID,")
                .append("AGE,")
                .append("TALL")
                .append(") VALUES(");
        sql.append("'").append(student.getName()).append("',");
        sql.append("'").append(student.getId()).append("',");
        sql.append("'").append(student.getAge()).append("',");
        sql.append("'").append(student.getTall()).append("')");
        return sql.toString();
    }

    /**
     * 通過學號 id 刪除學生信息
     * @param id
     * @return
     */
    public static String deleteStudentById(String id){
        StringBuffer sql = new StringBuffer();
        sql.append("delete from CLASS_ADDRESS where ID = '");
        sql.append(id).append("'");
        return sql.toString();
    }

    /**
     * 更新指定列學生信息
     * @param column
     * @param old_value
     * @param new_value
     * @return
     */
    public static String updateStudent(String column ,String old_value,String new_value){
        StringBuffer sql = new StringBuffer();
        sql.append("update CLASS_ADDRESS set ");
        sql.append(column).append(" = ");
        sql.append("'").append(new_value).append("'");
        sql.append(" where ").append(column).append(" = ");
        sql.append("'").append(old_value).append("'");
        return sql.toString();
    }

    /**
     * 通過學號 id 查詢學生信息
     * @param id
     * @return
     */
    public static String queryStudentById(String id){
        StringBuffer sql = new StringBuffer();
        sql.append("select NAME,ID,AGE,TALL ");
        sql.append("from CLASS_ADDRESS where ID = '");
        sql.append(id).append("'");
        return sql.toString();
    }

}

8、進入最后一步操作，在 Activity 進行數據庫操作。

@Override
    public void onClick(View view) {
        StudentDao studentDao = null;
        switch (view.getId()){
            case R.id.createDatabase://創建數據庫
                SQLiteHelper sqLiteHelper = new SQLiteHelper(SQLiteActivity.this);
                SQLiteDatabase database_create = sqLiteHelper.getReadableDatabase();
                database_create.close();
                break;

            case R.id.updateDatabase://更新數據庫
                SQLiteHelper sqLiteHelper_update = new SQLiteHelper(SQLiteActivity.this);
                SQLiteDatabase database_update = sqLiteHelper_update.getWritableDatabase();
                database_update.close();
                break;

            case R.id.insert://插入兩條學生記錄
                if(studentDao == null){
                    studentDao = new StudentDao(SQLiteActivity.this);
                }
                boolean insert_result1 = studentDao.addStudent(studentInfoBean1);
                boolean insert_result2 = studentDao.addStudent(studentInfoBean1);
                Log.d(TAG,String.valueOf(insert_result1));
                Log.d(TAG,String.valueOf(insert_result2));
                break;

            case R.id.delete://通過學號 id 刪除學生信息
                if(studentDao == null){
                    studentDao = new StudentDao(SQLiteActivity.this);
                }
                boolean delete_result = studentDao.deleteStudentById("1000001");
                Log.d(TAG,String.valueOf(delete_result));
                break;

            case R.id.update://更新指定列學生信息
                if(studentDao == null){
                    studentDao = new StudentDao(SQLiteActivity.this);
                }
                boolean update_result = studentDao.updateStudent("NAME", "小明", "飛天");
                Log.d(TAG,String.valueOf(update_result));
                break;

            case R.id.query://通過學號 id 查詢學生信息
                if(studentDao == null){
                    studentDao = new StudentDao(SQLiteActivity.this);
                }
                StudentInfoBean studentInfoBean = studentDao.queryStudent("1000001");
                String age = studentInfoBean.getAge();
                String name = studentInfoBean.getName();
                String tall = studentInfoBean.getTall();
                Log.d(TAG,"age= " + age + "\nname = " + name + "\ntall= " + tall);
                break;
        }
    }

　　現在重新看 SQL 操作示意圖，應該會覺得好理解些吧！