Flutter SQLite数据库管理插件PSQLite的使用

PSQLite简介

PSQLite 是一个用于Dart中轻松操作SQLite数据库的包。以下是该包设计的对象结构：

• TableDb：定义数据库中的表，由多个ColumnDb对象组成，并包含表名。
• ColumnDb：定义数据库表的列，TableDb对象由多个ColumnDb对象构成。
• FieldTypeDb：定义数据库表中列值的类型。SQLite没有单独的布尔存储类，而是用整数0（假）和1（真）来表示布尔值。
• ObjectStored：所有打算存储在SQLite数据库中的对象都应扩展此类。
• PSQLite：封装了一个由TableDb和数据库名组成的数据库。
• FilterDb：定义过滤器以优化SQLite查询。
• ConditionDb：定义过滤条件的类型。

使用示例

创建User类

import 'package:psqlite/psqlite.dart';

class User extends ObjectStored {
  final String _id;
  String _name;
  String _lastName;
  int _age;

  User(this._id, this._name, this._lastName, this._age);

  User.fromJson(this._id, this._name, this._lastName, this._age);

  String getId() => _id;
  String getName() => _name;
  String getLastName() => _lastName;
  int getAge() => _age;

  void setName(String name) => _name = name;
  void setLastName(String lastName) => _lastName = lastName;
  void setAge(int age) => _age = age;

  @override
  String toString() =>
      'User{_id: $_id, _name: $_name, _lastName: $_lastName, _age: $_age}';

  @override
  Map<String, dynamic> toMap() {
    return {'id': _id, 'name': _name, 'lastName': _lastName, 'age': _age};
  }

  @override
  String getPrimaryKey() => _id;

  @override
  bool operator ==(Object other) {
    if (other is! User) return false;
    if (_id != other._id) return false;
    if (_name != other._name) return false;
    if (_lastName != other._lastName) return false;
    if (_age != other._age) return false;
    return true;
  }

  @override
  int get hashCode {
    var result = 17;
    result = 37 * result + _id.hashCode;
    result = 37 * result + _name.hashCode;
    result = 37 * result + _lastName.hashCode;
    result = 37 * result + _age.hashCode;
    return result;
  }
}

创建User Storage Service

import 'package:psqlite/psqlite.dart';
import 'user.dart';

enum UserColumnName { id, name, lastName, age }

class UserStorageService {
  static final shared = UserStorageService.init();
  late PSQLite _database;
  final _tableName = 'users';

  UserStorageService.init({bool mockedDatabase = false}) {
    List<ColumnDb> columns = [
      ColumnDb(
          name: UserColumnName.id.name,
          type: FieldTypeDb.text,
          isPrimaryKey: true),
      ColumnDb(name: UserColumnName.name.name, type: FieldTypeDb.text),
      ColumnDb(name: UserColumnName.lastName.name, type: FieldTypeDb.text),
      ColumnDb(name: UserColumnName.age.name, type: FieldTypeDb.integer)
    ];
    final table = TableDb.create(name: _tableName, columns: columns);
    _database = PSQLite(table: table, isMocked: mockedDatabase);
  }

  PSQLite getDatabase() => _database;

  Future<void> addUser(User user) async {
    await _database.insertElement(user);
  }

  Future<void> updateUser(User user) async {
    await _database.updateElement(user);
  }

  Future<bool> removeUser(User user) async {
    return await _database.deleteElement(user);
  }

  Future<User?> getUser(String id) async {
    final response = await _database.getElementBy(id);
    if (response != null) {
      return User(
          response[UserColumnName.id.name],
          response[UserColumnName.name.name],
          response[UserColumnName.lastName.name],
          response[UserColumnName.age.name]);
    }
    return null;
  }

  Future<List<User>> getListOfUsers({List<FilterDb> where = const []}) async {
    final maps = await _database.getElements(where: where);
    return List.generate(maps.length, (i) {
      return User(
          maps[i][UserColumnName.id.name],
          maps[i][UserColumnName.name.name],
          maps[i][UserColumnName.lastName.name],
          maps[i][UserColumnName.age.name]);
    });
  }

  Future<void> removeUsers(List<FilterDb> filters) async {
    await _database.deleteElements(where: filters);
  }

  Future<void> removeAll() async {
    await _database.clearTable();
  }
}

使用实例

创建User Storage Service

你可以创建单个对象：

final storageService = UserStorageService.init();

或者使用单例模式获取共享实例：

final storageService = UserStorageService.shared;

添加新用户到SQLite

final storageService = UserStorageService.init();
final user = User("1", "Liam", "Neeson", 18);
await storageService.addUser(user);

更新SQLite中存储的用户

final storageService = UserStorageService.init();
// 添加新用户部分
User user = User("1", "Liam", "Neeson", 18);
await storageService.addUser(user);
// 更新用户部分
user.setLastName(finalLastName);
await storageService.updateUser(user);

获取SQLite中存储的用户列表

final storageService = UserStorageService.init();
await storageService.getListOfUsers();

获取过滤后的用户列表

final storageService = UserStorageService.init();
List<FilterDb> filters = [
  FilterDb(UserColumnName.lastName.name, "Neeson", ConditionDb.equal),
  FilterDb(UserColumnName.age.name, 18, ConditionDb.greaterOrEqual)
];
final filteredUsers = await storageService.getListOfUsers(where: filters);

删除SQLite中存储的用户

final storageService = UserStorageService.init();
final user = User("1", "Liam", "Neeson", 18);
await storageService.removeUser(user);

删除SQLite中所有的用户

你可以通过调用removeAll方法或不带过滤参数调用removeUsers方法来删除所有用户。

final storageService = UserStorageService.init();
await storageService.removeAll();

或

final storageService = UserStorageService.init();
await storageService.removeUsers();

以上是关于如何在Flutter项目中使用PSQLite进行SQLite数据库管理的基本介绍和示例代码。希望这些信息能帮助你更好地理解和使用这个插件。