Flutter使用sqflite處理數據表變更的方法詳解

更新時間：2023年04月03日 08:50:16 作者：島上碼農

了解過數據庫的同學應該會知道，數據表結構是可能發(fā)生改變的。所以本文為大家介紹了Flutter?使用?sqflite?處理數據表變更的版本升級處理方法，感興趣的可以了解一下

前言

上一篇我們介紹了使用 sqflite 這個數據庫工具在 Flutter 的應用中建立本地數據庫的實例應用。了解過數據庫的同學應該會知道，數據表結構是可能發(fā)生改變的。但是 App 的版本會有碎片化的存在，如果數據表結構發(fā)生了改變，就需要對舊版本 App 的數據表結構進行同步，否則會導致程序運行錯誤。典型的例子就是數據表增加了字段，但是舊版 App的數據表沒有同步，這樣會導致程序讀不到對應的字段而出錯。解決這種情況就需要使用數據表的版本管理。

sqflite 版本管理

我們使用 sqflite 創(chuàng)建數據庫的時候，有個 version 參數，就是用于定義當前的數據庫版本。

Future<Database> _initDB(String filePath) async {
    final dbPath = await getDatabasesPath();
    final path = join(dbPath, filePath);
    return await openDatabase(path, version: 1, onCreate: _createDB);
}

同時 sqflite 提供了一個方法來獲取當前數據庫的版本。

var version = await db.getVersion();

有了這個，我們就可以判斷當前本地的數據庫版本是不是最新版本了。在 sqflite 中，提供了版本升級的處理方法，當檢測到 version 參數比當前的數據庫版本高時，就可以執(zhí)行 onUpgrade 方法，在這個方法里可以處理數據表升級操作，比如增加/刪除字段，更改字段默認值等。

var db = await openDatabase(path,
        version: latestVersion, onCreate: _createDB, onUpgrade: _updateDB);

備忘錄實例 - 增加標簽

還是以我們上一篇的備忘錄為例，我們假設需要給備忘錄增加一個標簽字段，界面如下所示。

這個時候我們就需要更改備忘錄數據表，增加一個標簽字段。由于 SQLite 無法存儲數組，我們可以將多個標簽轉換為特殊符號分隔的字符串，比如這里使用的是豎線“|”。增加數據表的字段的數據庫版本升級代碼如下。

Future<void> _updateDB(Database db, int oldVersion, int newVersion) async {
    try {
      await db.execute('ALTER TABLE memo ADD COLUMN tags TEXT');
    } on DatabaseException catch (e) {
      if (e.isDuplicateColumnError()) {
        // 忽略該異常，該列已經存在
      } else {
        rethrow;
      }
    }
    await db.setVersion(newVersion);
  }

這里之所以捕獲異常，是因為添加字段操作不允許添加已有的字段，如果發(fā)生了重復字段異常處理我們忽略這個異常，已讓程序能夠正常運行。這里需要注意，在創(chuàng)建數據表的時候也需要更改SQL，增加 tags 字段（upgrade方法只對舊版本的做升級處理，不會更改現(xiàn)有版本的數據表）。

Future<void> _createDB(Database db, int version) async {
    await db.execute('''
      CREATE TABLE memo (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        title TEXT,
        content TEXT,
        tags TEXT,
        created_time INTEGER,
        modified_time INTEGER
      )
    ''');
  }

接下來是備忘錄的代碼實現(xiàn)，我們用 InputChip定義了一個標簽組件，以支持能夠通過刪除圖標刪掉標簽。

class Tag extends StatelessWidget {
  final String text;
  final VoidCallback onDeleted;

  const Tag({Key? key, required this.text, required this.onDeleted})
      : super(key: key);

  @override
  Widget build(BuildContext context) {
    return InputChip(
      label: Text(text),
      onDeleted: onDeleted,
    );
  }
}

在添加備忘錄的頁面中，在表單區(qū)增加了如下內容，一個 Wrap 組件來顯示多個標簽，然后一個輸入框來添加標簽。

Column(
    crossAxisAlignment: CrossAxisAlignment.start,
    children: [
      Wrap(
        alignment: WrapAlignment.start,
        spacing: 4.0,
        runSpacing: 4.0,
        children: [
          for (final tag in _tags)
            Tag(
              text: tag,
              onDeleted: () => _removeTag(tag),
            )
        ],
      ),
      TextField(
        controller: _tagController,
        decoration: InputDecoration(
          labelText: '添加標簽',
          suffixIcon: IconButton(
            icon: const Icon(Icons.add),
            onPressed: _addTag,
          ),
        ),
        onSubmitted: (_) => _addTag(),
      ),
    ],
  ),

當添加標簽時，就往標簽數組里增加標簽字符串元素，刪除標簽時就移除該標簽。這里注意，為了避免標簽重復，添加標簽時需要檢查當前標簽是否已經存在。

void _addTag() {
  final newTag = _tagController.text.trim();
  if (newTag.isNotEmpty && !_tags.contains(newTag)) {
    setState(() {
      _tags.add(newTag);
      _tagController.clear();
    });
  }
}

之后就是更改我們的保存?zhèn)渫浀姆椒ā?/p>

Future<int> _saveMemo(BuildContext context) async {
  var createdTimestamp = DateTime.now().millisecondsSinceEpoch ~/ 1000;
  var modifiedTimestamp = createdTimestamp;
  var memoMap = {
    'title': _title,
    'content': _content,
    'created_time': createdTimestamp,
    'modified_time': modifiedTimestamp,
    'tags': _tags.isNotEmpty ? _tags.join('|') : '',
  };
  // 保存?zhèn)渫?
  var id = await insertMemo(memoMap);
  return id;
}

運行效果

運行效果如下，完整代碼已經上傳到：本地存儲相關代碼。

總結

本篇介紹了 Flutter 使用 sqflite 處理數據表變更的版本升級處理方法。當我們使用數據庫在 App 里存儲本地結構化數據的時候，不可避免會遇到新增字段、刪除字段等的處理嗎，這個時候就需要進行數據庫版本升級操作。在 sqflite 中，會自動根據本地的數據庫版本和當前的數據庫版本進行對比，如果本地版本低于當前的數據庫版本就會調用 onUpgrade 方法處理版本升級，比如字段變更，數據遷移等。同時，大家做本地數據庫的時候，務必注意不同版本之間的兼容，一方面是盡可能地保持數據表不變更，另一方面是做好不同版本的升級和數據遷移工作。

到此這篇關于Flutter使用sqflite處理數據表變更的方法詳解的文章就介紹到這了,更多相關Flutter sqflite處理數據表變更內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: