Android SQLite (二.資料庫建立，升級及降級)

SQLite · 發表 2018-10-16 20:47:23

摘要：上篇文章簡介和常用語法介紹了SQLite資料庫的基本資訊和一些常用的語法操作，本篇文章主要介紹Android開發過程中SQLite資料庫的建立使用和常見問題處理。一.SQLiteOpenHelper介紹對於Android平臺來說，我們可以使用系統提供的A...

上篇文章簡介和常用語法介紹了SQLite資料庫的基本資訊和一些常用的語法操作，本篇文章主要介紹Android開發過程中SQLite資料庫的建立使用和常見問題處理。

一.SQLiteOpenHelper介紹

對於Android平臺來說，我們可以使用系統提供的API輕鬆實現對SQLite資料庫的操作

Android提供SQLiteOpenHelper類以便我們建立操作資料庫。通常情況下我們會新建一個SQLiteOpenHelper的子類作為一個數據庫的操作類。

資料庫操作類示例 :

DatabaseHelper

public class DatabaseHelper extends SQLiteOpenHelper {

/**
* 資料庫名稱
*/
private static final String DATABASE_NAME = "account.db";
/**
* 資料庫版本-升級用
*/
private static final int DATABASE_VERSION = 1;

public DatabaseHelper(Context context) {
//CursorFactory設定為null,使用預設值
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}

/**
* 資料庫第一次建立時呼叫
*/
@Override
public void onCreate(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS account " +
"(userId VERCHAR PRIMARY KEY,userName VERCHAR,totalAccount INTEGER)");
}

/**
* @param db資料庫實際操作類
* @param oldVersion 舊版本
* @param newVersion 新版本
*/
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {

}
}

二.資料庫建立-構造方法

資料庫的建立以及版本，是由SQLiteOpenHelper的構造方法引數決定的。

SQLiteOpenHelper 有三個構造構造方法：

/**
* @param context 用來開啟或者建立資料庫
* @param name 資料庫檔名稱或者傳null為一個記憶體資料庫
* @param factory 用來建立cursor物件或者傳null使用預設的
* @param version 資料庫版本號 (從1開始);如果資料庫版本比當前版舊，onUpgrade方法會被呼叫來更新資料庫，
如果比當前新onDowngrade方法會被呼叫來降級資料庫
*/
public SQLiteOpenHelper(Context context, String name, CursorFactory factory, int version) {
this(context, name, factory, version, null);
}

/**
* @param errorHandler DatabaseErrorHandler資料庫損壞時回撥.
*/
public SQLiteOpenHelper(Context context, String name, CursorFactory factory, 
int version, DatabaseErrorHandler errorHandler) {
this(context, name, factory, version, 0, errorHandler);
}

/**
* @param minimumSupportedVersion 支援呼叫onUpgrade更新到version版本的最版本號，
如果當前版本比最小支援的版本還下資料庫就會刪除然後重新建立version版本的資料庫。
在刪除前onBeforeDelete會被呼叫我們可以在此方法中做一些處理。minimumSupportedVersion 預設為0
* @hide
*/
public SQLiteOpenHelper(Context context, String name, CursorFactory factory,
int version, int minimumSupportedVersion, DatabaseErrorHandler errorHandler) {
if (version < 1) throw new IllegalArgumentException("Version must be >= 1, was " + 
version);

mContext = context;
mName = name;
mFactory = factory;
mNewVersion = version;
mErrorHandler = errorHandler;
mMinimumSupportedVersion = Math.max(0, minimumSupportedVersion);
}

最終都會呼叫第三個構造方法，方法中判斷如果version 小於1會丟擲異常，所以Android SQLite資料庫版本必須從1開始。實際上最後一個構造方法被@hide註解了，所以一般情況下在子類中我們是沒有辦法主動呼叫的，只能呼叫前兩個構造方法，minimumSupportedVersion 也始終是0。

三.資料庫首次建立回撥-onCreate方法

資料庫首次建立的時候onCreate方法會被執行。表的建立和初始化需要在方法中進行。這個是抽象方法，實體類中必須實現。實現很簡單就是做一些建立表的操作。

示例：

/**
* 資料庫第一次建立時呼叫
*/
@Override
public void onCreate(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS account " +
"(userId VERCHAR PRIMARY KEY,userName VERCHAR,totalAccount INTEGER)");
}

四.資料庫的升級-onUpgrade方法

/**
* @param db The database.
* @param oldVersion 舊資料庫版本
* @param newVersion 新資料庫版本
*/
public abstract void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion);

當資料庫升級時（當前資料庫版本大於已建立的資料庫版本）會執行此方法，首次建立時不會執行。這是個抽象方法，在我們的實體類中必須實現。我們可以在這個方法中根據資料庫版本做一些刪除表，建立表，新增表字段或者重命名錶等操作保證資料庫與最新版本資料庫同步。

常用資料庫升級操作：

資料庫的升級一般有三種方式如下：

1.onCreate方法始終保證是最新的，在onUpgrade方法中刪除所有已存在表，在呼叫onCreate中建立表的方法重新建立所有表，保證表是最新的。（當然如果你想儲存資料也可以先將資料儲存到記憶體再插入，如果表很多或者資料量很大的是不建議怎麼操作的，非常影響效能）

2.onCreate方法始終保證是最新的，再onUpgrade方法中根據版本號判斷執行建立新表或者更新欄位等操作

版本號需要判斷上下限：

上限（為了再從當前版本x更新到新版本y時不重複執行更新操作）：假如我們要升級到新版本x，是我們的當前版本x，需要小於當前版本號x。

下限：如果是建立新表下限就是當前版本之前的所有版本，如果是更新表字段或者重命名錶下限是表建立的版本需要大於等於 下限版本

舉個栗子：
2.1. 在上面的示例我們建立了版本1資料庫，onCreate方法建立了表account，現在需要在表account中新增欄位subAccountId並新增一個表subAccount。

按照上面的方式我們需要更新表版本號為假設為2（可以為更大的，不要求連續，連續方便之後的版本更新迭代），在onCreate方法中修改原來建立表account的SQL新增欄位subAccountId，同時新增建立表subAccount的SQL並執行。

然後在onUpgrade中判斷oldVersion版本號大於等於原版本1小於現版本2，執行新增欄位和新增表SQL。

具體程式碼如下：

public class DatabaseHelper extends SQLiteOpenHelper {

/**
* 資料庫名稱
*/
private static final String DATABASE_NAME = "account.db";
/**
* 資料庫版本-升級用
*/
private static final int DATABASE_VERSION = 2;

public DatabaseHelper(Context context) {
//CursorFactory設定為null,使用預設值
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}

/**
* 資料庫第一次建立時呼叫
*/
@Override
public void onCreate(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS account " +
"(userId VERCHAR PRIMARY KEY,userName VERCHAR,totalAccount INTEGER," +
"subAccountId VARCHAR default '')");

db.execSQL("CREATE TABLE IF NOT EXISTS subAccount " +
"(userId VERCHAR PRIMARY KEY,subAccountId VERCHAR,totalAccount INTEGER)");
}

/**
* @param db資料庫實際操作類
* @param oldVersion 舊版本
* @param newVersion 新版本
*/
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
if (oldVersion >= 1 && oldVersion < 2) {
db.execSQL("ALTER TABLE account ADD COLUMN subAccountId VARCHAR default ''");
db.execSQL("CREATE TABLE IF NOT EXISTS subAccount " +
"(userId VERCHAR PRIMARY KEY,subAccountId VERCHAR,totalAccount INTEGER)");
}
}

}

2.2 假設這個時候，還需要升級資料庫到版本3，在表subAccount 中新增個欄位userName。

onCreate方法裡修改就不說了建立表subAccount 加上userName欄位就行。onUpgrade方法中怎麼判斷版本號，按照上面的說明可知上限是小於3，下限則是大於等於表建立的版本 ，subAccount 表建立的版本是2所以需要大於等於2 ，而不是大於等於初始版本。

具體程式碼如下：

/**
* 資料庫版本-升級用
* 版本2：新增資料庫subAccount 
*/
private static final int DATABASE_VERSION = 3;

public DatabaseHelper(Context context) {
//CursorFactory設定為null,使用預設值
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}

/**
* 資料庫第一次建立時呼叫
*/
@Override
public void onCreate(SQLiteDatabase db) {
createAccountTable(db);
createSubAccountTable(db);
}

/**
* 建立subAccount表（最好封裝下，保證onCreate和onUpgrade方法中建立的都是最新表）
*/
private void createSubAccountTable(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS subAccount " +
"(userId VERCHAR PRIMARY KEY,subAccountId VERCHAR,totalAccount INTEGER," +
"userName VARCHAR default '')");
}

private void createAccountTable(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS account " +
"(userId VERCHAR PRIMARY KEY,userName VERCHAR,totalAccount INTEGER," +
"subAccountId VARCHAR default '')");
}

/**
* @param db資料庫實際操作類
* @param oldVersion 舊版本
* @param newVersion 新版本
*/
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
if (oldVersion >= 1 && oldVersion < 2) {
db.execSQL("ALTER TABLE account ADD COLUMN subAccountId VARCHAR default ''");
createSubAccountTable(db);
}

if (oldVersion >= 2 && oldVersion < 3) {
db.execSQL("ALTER TABLE subAccount ADD COLUMN userName VARCHAR default ''");
}
}
}

升級測試說明：

直接安裝版本3資料庫的APP——走onCreate方法建立最新表

安裝版本2--升級版本3APP——onUpgrade只會走升級subAccount 表的邏輯

安裝版本1--升級版本3APP——onUpgrade只會走升級account 表的邏輯和建立表subAccount 的邏輯，建立表subAccount 和onCreate中執行的是同義SQL，建立的都是最新表。

這種方式更新資料庫一定要注意表的建立版本，所以必要的註釋還是要詳細點。

3.第三種方式和第二種基本是一樣，只是在onUpgrade方法中一步步往上升級，已上面2.2例子說明，初始版本為1，升級到版本3，先升級到版本2再升級到版本3這樣就不需要判斷oldVersion 版本號的上下限了。

使用這種方式升級，onCreate中可以是最新表建立（3.1示例），也可以只進行最初版本的表建立然後呼叫onUpgrade方法升級資料庫（3.2示例）

3.1 onCreate中最新的資料表，onUpgrade方法中根據版本號一步步往上升級

程式碼如下：

/**
* 資料庫名稱
*/
private static final String DATABASE_NAME = "account.db";

/**
* 資料庫版本-升級用
*/
private static final int DATABASE_VERSION = 3;

public DatabaseHelper3(Context context) {
//CursorFactory設定為null,使用預設值
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}

/**
* 資料庫第一次建立時呼叫
*/
@Override
public void onCreate(SQLiteDatabase db) {
createAccountTable(db);
createSubAccountTable(db);
}

private void createSubAccountTable(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS subAccount " +
"(userId VERCHAR PRIMARY KEY,subAccountId VERCHAR,totalAccount INTEGER," +
"userName VARCHAR default '')");
}

private void createAccountTable(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS account " +
"(userId VERCHAR PRIMARY KEY,userName VERCHAR,totalAccount INTEGER," +
"subAccountId VARCHAR default '')");
}

/**
* @param db資料庫實際操作類
* @param oldVersion 舊版本
* @param newVersion 新版本
*/
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
int version = oldVersion;
if (version == 1){
db.execSQL("ALTER TABLE account ADD COLUMN subAccountId VARCHAR default ''");
db.execSQL("CREATE TABLE IF NOT EXISTS subAccount " +
"(userId VERCHAR PRIMARY KEY,subAccountId VERCHAR,totalAccount INTEGER)");
version = 2;
}
if (version == 2){
db.execSQL("ALTER TABLE subAccount ADD COLUMN userName VARCHAR default ''");
}
}

3.2 onCreate中建立最初版本的表然後呼叫onUpgrade方法傳入oldVersion為最初版本，onUpgrade方法中根據版本號一步步往上升級，需要判斷下版本號oldVersion>=newVersion時不做處理（即初始版本不處理）

程式碼如下：

/**
* 資料庫名稱
*/
private static final String DATABASE_NAME = "account.db";

/**
* 最初版本
*/
private static final int FIRST_DATABASE_VERSION = 1;

/**
* 資料庫版本-升級用
*/
private static final int DATABASE_VERSION = 3;

public DatabaseHelper2(Context context) {
//CursorFactory設定為null,使用預設值
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}

/**
* 資料庫第一次建立時呼叫
*/
@Override
public void onCreate(SQLiteDatabase db) {
db.execSQL("CREATE TABLE IF NOT EXISTS account " +
"(userId VERCHAR PRIMARY KEY,userName VERCHAR,totalAccount INTEGER)");
onUpgrade(db,FIRST_DATABASE_VERSION,DATABASE_VERSION);
}

/**
* @param db資料庫實際操作類
* @param oldVersion 舊版本
* @param newVersion 新版本
*/
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
if (oldVersion >= newVersion){
return;
}
int version = oldVersion;
if (version == 1){
db.execSQL("ALTER TABLE account ADD COLUMN subAccountId VARCHAR default ''");
db.execSQL("CREATE TABLE IF NOT EXISTS subAccount " +
"(userId VERCHAR PRIMARY KEY,subAccountId VERCHAR,totalAccount INTEGER)");
version = 2;
}
if (version == 2){
db.execSQL("ALTER TABLE subAccount ADD COLUMN userName VARCHAR default ''");
}
}

總結：

以上三種方式均可以實現資料庫版本的升級。

如果資料庫版本升級不需要儲存舊錶資料可以選擇方式1升級資料庫，刪除所有表重新建立。

如果資料庫版本升級需要儲存資料庫表資料，則可以選擇方式二或者方式三。

個人比較建議選擇方式二，新安裝APP建立資料庫不會做很多多餘的操作且邏輯也比較清晰。

當然大家可以根據各自的需求選擇，如果資料庫修改不是很頻繁而且修改較多的情況下，方式三也不失為一個好的選擇，程式碼邏輯很清晰。

五.資料庫降級-onDowngrade方法

public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {
throw new SQLiteException("Can't downgrade database from version " +
oldVersion + " to " + newVersion);
}

降級方法，當資料庫降級時（當前資料庫版本小於已建立的資料庫版本）執行此方法。
onDowngrade方法是有預設實現的，我們可以看到預設實現就是丟擲一個降級異常，所以如果我們不重寫此方法，APP 資料庫是沒法往下降級的，安裝的時候會直接崩潰。除非你解除安裝了重灌，這樣相當於首次建立資料庫，走onCreate方法。
我們可以根據實際需求來決定是否需要重寫onDowngrade方法，如果應用降級覆蓋安裝不涉及資料庫降級或者是不允許降級就不需要重寫此方法，強制使用者安裝最新的。如果有需要則可以重寫此方法，一般操作為刪除所有表再呼叫onCreate方法重寫建立表。SQLite資料庫表是不能刪減欄位的，這樣做舊版本表可能有冗餘欄位，但這不影響舊版本操作。

舉個栗子：

@Override
public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {
dropTable(db,"account");
dropTable(db,"subAccount");
}

/**
* 刪除表
* @param db資料庫
* @param tableName 表名
*/
public void dropTable(SQLiteDatabase db, String tableName) {
if (TextUtils.isEmpty(tableName)) {
return;
}
db.execSQL("drop table " + tableName);
}