作者 | 弗拉德

來源 | 弗拉德

sqflite

資料持久化是在移動端開發中必不可少的技術手段。我們總是有一些使用者資訊，應用資源，列表資料等需要儲存起來，這裡我們主要來講基於SQLite資料庫的資料儲存。

SQLite，是一款輕型的資料庫。它的設計目標是嵌入式的，而且已經在很多嵌入式產品中使用了它，它佔用資源非常的低，在嵌入式裝置中，可能只需要幾百K的記憶體就夠了。

Flutter已經幫助我們封裝了操作SQLite的庫，它就是：[sqflite] pub.dev/packages/sqflite

整合sqflite庫

使用sqflite第三方庫需要我們在pubspec.yaml檔案先新增庫的名字和版本號

在dependencies欄位下新增：


sqflite: ^1.1.3

這裡以1.1.3為例

新增完成後儲存一下，VSCode預設會執行pub get幫我們把需要的庫下載下來，同樣我們也可以在專案根目錄下執行pub get來手動拉取需要的庫。

1. 建立本地資料檔案


static  Future<SqfliteManager> _initDataBase() async {

SqfliteManager manager = SqfliteManager();

String dbPath = await  getDatabasesPath() + "/$sqlName";

if (manager.db == null) {

manager.db = await  openDatabase(

dbPath,

version: 1,

onCreate: (db, version) async {

/// 如果不存在 當前的表 就建立需要的表

if (await manager.isTableExit(db, tableName) == false) {

await db.execute(CREATE_DATA_TABLE);

}

},

);

}

return manager;

}

首先我們透過getDatabasesPath()函式獲取到本地儲存資料庫檔案的路徑，在此路徑後面拼接上我們的資料庫檔名字，就是儲存資料庫檔案的路徑。在iOS中該路徑在沙河路徑下的Documents資料夾內，在Android中時預設資料庫目錄。

之後我們宣告一個Database物件，用來儲存資料庫操作物件


Database db;

先判斷此物件是否存在，如果不存在我們呼叫openDatabase來建立

這裡傳入前面獲取到的資料庫地址，版本號，和onCreate回撥函式。

在onCreate回撥內部判斷是否存在我們需要使用的表名字，如果不存就執行建立資料庫表的sql語句。

除了onCreate回撥，還有onUpgrade、onDowngrade、onOpen等回撥。另外一個引數singleInstance它表示當傳入相同的資料庫路徑是否返回同一個的例項物件，預設是true

2. 插入資料

鑑於sqflite幫我們做了很多工作，所以在使用基本的增、刪、改、查也很簡單


/// 插入資料

Future<int> insertData(Map<String, dynamic> value) async {

return  await db.insert(tableName, value);

}

只需要傳入表名字和要插入的資料就行

我們再來看一下insert函式的其他引數


Future<int> insert(String table, Map<String, dynamic> values,

{String nullColumnHack, ConflictAlgorithm conflictAlgorithm});

nullColumnHack 是在傳入的插入資料是空的時候起到作用的

如果插入資料為空：

若不新增nullColumnHack則sql語句最終的結果將會類似insert into tableName()values()，這是不允許的。

若新增上nullColumnHack則sql語句將會變成insert into tableName (nullColumnHack)values(null)，這是可以的。

conflictAlgorithm 是一個列舉，當插入的資料出現衝突或錯誤時，我們該使用哪種策略，有以下幾個值


enum  ConflictAlgorithm {

rollback,

abort,

fail,

ignore,

replace,

}

3. 刪除資料

刪除資料的程式碼如下


/// 刪除一條資料

Future<int> deleteData(int id) async {

return  await db.delete(tableName, where: "id = ?", whereArgs: [id]);

}

來看一下詳細的delete函式都有哪些引數:


Future<int> delete(String table, {String where, List<dynamic> whereArgs});

table是要刪除資料所在的表的名字例如：testTable
where是一個字串，表示的是要刪除的表達語句例如：“id = ?”
whereArgs是一個陣列，是用來補充where語句裡面的?引數的例如：[2]

當我們傳入上面示例引數後，要標的意思就是：要刪除testTable 表內 id = 2 的資料

4. 更新資料

刪除資料程式碼如下


Future<int> updateData(Map<String, dynamic> value, int id) async {

return  await db.update(

tableName,

value,

where: "id = ?",

whereArgs: [id],

);

}

詳細的update函式如下


Future<int> update(String table, Map<String, dynamic> values,

{String where,

List<dynamic> whereArgs,

ConflictAlgorithm conflictAlgorithm});

跟insert函式的引數基本一致，這裡就不贅述了

5. 查詢資料

直接來看查詢語句的引數


Future<List<Map<String, dynamic>>> query(

String table, /// 表名字 是必傳引數

{bool distinct, // 是否包含重複資料

List<String> columns, // 需要查詢的列

String where, // 查詢條件

List<dynamic> whereArgs, // 查詢條件引數

String groupBy, //按列分組 列的名字

String having, // 給分組設定條件

String orderBy, // 按列排序 asc/desc

int limit, // 限制查詢結果數量

int offset}); // 從第幾條開始查詢

查詢語句的引數比較豐富，基本可以滿足我們一些複雜場景的查詢需求

好了，關於sqflite的使用就總結這些了。

想體驗以上的示例的執行效果，可以到[我的Github倉庫] github.com/Johnson8888/learn_flutter 專案flutter_app->lib->routes->sqflite_page.dart檢視，並且可以下載下來執行並體驗。

【Flutter 3-4】Flutter進階教程——資料持久化sqfl