Flutter數據庫封裝

SQLite

如果您正在編寫一個需要持久化且查詢大量本地設備數據的 app,可考慮采用數據庫,而不是本地文件夾或關鍵值庫。總的來說,相比于其他本地持久化方案來說,數據庫能夠提供更為迅速的插入、更新、查詢功能。

Flutter應用程序中可以通過 sqflite package 來使用 SQLite 數據庫。本文將通過使用 sqflite 來演示插入,讀取,更新,刪除各種數據。

如果你對于 SQLite 和 SQL 的各種語句還不熟悉,請查看 SQLite 官方的教程 SQLite 教程,在查看本文之前需要掌握基本的SQL語句。

添加sqflite依賴

dependencies:
  flutter:
    sdk: flutter
  sqflite:
  path:

封裝

MessageDB

MessageDB以單例實現,提供以下功能。

  • 數據庫初始化
  • 表初始化
  • 數據庫打開關閉
  • 是持有表對象【SessionListTable、SessionChatTable、】
class MessageDB {
  // 單例公開訪問點
  factory MessageDB() => _sharedInstance();

  static MessageDB get instance => _sharedInstance();

  // 靜態私有成員,沒有初始化
  static MessageDB _instance;

  // 私有構造函數
  MessageDB._() {
    // 具體初始化代碼
  }

  // 靜態、同步、MessageDB
  static MessageDB _sharedInstance() {
    if (_instance == null) {
      _instance = MessageDB._();
    }
    return _instance;
  }

  /// init db
  Future<Database> database;
  final SessionListTable sessionListTable = SessionListTable();
  final SessionChatTable sessionChatTable = SessionChatTable();

  initDB() async {
    try {
      String uid = UserManager.instance.userInfo.uid;
      database = openDatabase(
        // Set the path to the database.
        // 需要升級可以直接修改數據庫名稱
        join(await getDatabasesPath(), 'message_database_v1_$uid.db'),
        // When the database is first created, create a table to store dogs.
        onCreate: (db, version) {
          // Run the CREATE TABLE statement on the database.
          try {
            Batch batch = db.batch();
            _createTable().forEach((element) {
              batch.execute(element);
            });
            batch.commit();
          } catch (err) {
            throw (err);
          }
        },
        onUpgrade: (Database db, int oldVersion, int newVersion) {
          try {
            Batch batch = db.batch();
            _createTable().forEach((element) {
              batch.execute(element);
            });
            batch.commit();
          } catch (err) {
            throw (err);
          }
        },
        // Set the version. This executes the onCreate function and provides a
        // path to perform database upgrades and downgrades.
        version: 1,
      );
      sessionListTable.database = database;
      sessionChatTable.database = database;
    } catch (err) {
      throw (err);
    }
  }

  /// close db
  closeDB() async {
    await database
      ..close();
  }

  /// create table
  List<String> _createTable() {
    return [sessionListTable.createTable(), sessionChatTable.createTable()];
  }
}

SessionTableListener

SessionTableListener作為抽象類,提供以下接口。

abstract class SessionTableListener {
  Future<Database> database;

  createTable();

  insertList(List values);

  queryListMaxVersionId({num id});

  queryList({num id});

  deleteItem(num id);
}

SessionListTable和SessionChatTable繼承SessionTableListener實現對表數據的增刪查改操作。

SessionListTable實現如下。

class SessionListTable implements SessionTableListener {

  @override
  Future<Database> database;

  final String sessionListTable = 'session_list';

  @override
  createTable() {
    return "CREATE TABLE IF NOT EXISTS $sessionListTable ("
        "peer_id INTEGER PRIMARY KEY,"
        " last_msg_id INTEGER,"
        " unread_count INTEGER,"
        " version_id INTEGER,"
        " update_time INTEGER,"
        " last_msg TEXT,"
        " contact_type INTEGER,"
        " contact_user TEXT,"
        " unread_gift_count INTEGER,"
        " del_status INTEGER,"
        " top_weight INTEGER,"
        " sort_key INTEGER,"
        " stick INTEGER)";
  }

  ///插入會話列表
  @override
  insertList(List values) async {
    // Get a reference to the database.
    final Database db = await database;

    // Insert the Dog into the correct table. You might also specify the
    // `conflictAlgorithm` to use in case the same maps is inserted twice.
    //
    // In this case, replace any previous data.
    try {
      Batch batch = db.batch();
      values.forEach((element) {
        Map<String, dynamic> values = Map<String, dynamic>();
        values['peer_id'] = element['peer_id'];
        values['last_msg_id'] = element['last_msg_id'];
        values['unread_count'] = element['unread_count'];
        values['version_id'] = element['version_id'];
        values['update_time'] = element['update_time'];
        values['last_msg'] = element['last_msg'];
        values['contact_type'] = element['contact_type'];
        values['contact_user'] = element['contact_user'];
        values['unread_gift_count'] = element['unread_gift_count'];
        values['del_status'] = element['del_status'];
        values['top_weight'] = element['top_weight'];
        values['sort_key'] = element['sort_key'];
        values['stick'] = element['stick'];

        batch.insert(
          sessionListTable,
          values,
          conflictAlgorithm: ConflictAlgorithm.replace,
        );
      });
      await batch.commit();
    } catch (err) {
      throw err;
    }
  }

  ///查詢會話列表最大的version id
  @override
  queryListMaxVersionId({num id}) async {
    final Database db = await database;
    List<Map> maps = await db.query(sessionListTable, orderBy: 'version_id DESC', limit: 1);
    if (maps.length>0) {
      return maps[0]['version_id'];
    }
    else {
      return 0;
    }
  }

  ///查詢所有的會話列表
  @override
  queryList({num id}) async {
    // Get a reference to the database.
    final Database db = await database;

    //聯系人類型 0 普通 1 打招呼 100 系統
    // Query the table for all The maps.
    final List<Map<String, dynamic>> maps = await db.query(sessionListTable,
        where: 'del_status = ? AND contact_type != ?',
        whereArgs: [0, 100],
        orderBy: 'sort_key DESC');

    return maps;
  }

  ///會話刪除
  @override
  deleteItem(num id) async {
    // Get a reference to the database.
    final Database db = await database;

    await db.delete(sessionListTable, where: 'peer_id = ?', whereArgs: [id]);
  }

  ///所有會話未讀數
  querySessionAllUnRead() async {
    // Get a reference to the database.
    final Database db = await database;

    //聯系人類型 0 普通 1 打招呼 100 系統
    final List<Map<String, dynamic>> maps = await db.query(sessionListTable,
        columns: ['unread_count'],
        where: 'unread_count > ? AND contact_type != ?',
        whereArgs: [0, 100]);
    int count = maps.fold(0, (previousValue, element) => previousValue+element['unread_count']);
    return count;
  }

  ///所有會話標記已讀
  updateSessionMarkAllRead() async {
    // Get a reference to the database.
    final Database db = await database;

    await db.update(sessionListTable, {'unread_count':0});
  }

  ///會話標記已讀
  updateSessionMarkRead(num id) async {
    // Get a reference to the database.
    final Database db = await database;

    await db.update(sessionListTable, {'unread_count':0}, where: 'peer_id = ?', whereArgs: [id]);
  }

}

問題

異步初始化數據庫

//初始化數據庫
MessageDB.instance.initDB();

登錄成功之后,初始化數據庫為異步操作。同時會拉取會話列表,這時可能數據庫還未初始化完成。解決辦法,延遲2s后再拉取會話列表。

Future.delayed(Duration(seconds: 2), () {
      MessageDB.instance.sessionChatTable.queryList(id: _peerUser.id)
});

數據庫升級

升級表或字段,修改version,會調用onUpgrade方法,可以在此處升級。

// Set the version. This executes the onCreate function and provides a
// path to perform database upgrades and downgrades.
version: 1,

如果業務比較簡單,本地數據不是很重要,服務端會同步數據。不如簡單粗暴,直接更改數據庫名稱,重新創建數據庫。

  database = openDatabase(
    // Set the path to the database.
    // 需要升級可以直接修改數據庫名稱
    join(await getDatabasesPath(), 'message_database_v1_$uid.db'),

v1改為v2

添加新的字段

  insertList(List values) async {
    // Get a reference to the database.
    final Database db = await database;

    // Insert the Dog into the correct table. You might also specify the
    // `conflictAlgorithm` to use in case the same maps is inserted twice.
    //
    // In this case, replace any previous data.
    try {
      Batch batch = db.batch();
      values.forEach((element) {
        Map<String, dynamic> values = Map<String, dynamic>();
        values['peer_id'] = element['peer_id'];
        values['last_msg_id'] = element['last_msg_id'];
        values['unread_count'] = element['unread_count'];
        values['version_id'] = element['version_id'];
        values['update_time'] = element['update_time'];
        values['last_msg'] = element['last_msg'];
        values['contact_type'] = element['contact_type'];
        values['contact_user'] = element['contact_user'];
        values['unread_gift_count'] = element['unread_gift_count'];
        values['del_status'] = element['del_status'];
        values['top_weight'] = element['top_weight'];
        values['sort_key'] = element['sort_key'];
        values['stick'] = element['stick'];

        batch.insert(
          sessionListTable,
          values,
          conflictAlgorithm: ConflictAlgorithm.replace,
        );
      });
      await batch.commit();
    } catch (err) {
      throw err;
    }
  }

不要把List values直接傳入table,如果map包含table不存在的數據,就會插入失敗。為了保證傳入的map包含的key都存在table的字段,對values的map需要的字段做一次解析,再傳入sql。

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,699評論 2 370