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

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

标题

stash_sqlite

内容

A stash storage extension for sqlite using the drift package

示例代码

import 'package:stash/stash_api.dart';
import 'package:stash_sqlite/stash_sqlite.dart';

class Task {
  final int id;
  final String title;
  final bool completed;

  Task({required this.id, required this.title, this.completed = false});

  /// Creates a [Task] from json map
  factory Task.fromJson(Map<String, dynamic> json) => Task(
      id: json['id'] as int,
      title: json['title'] as String,
      completed: json['completed'] as bool);

  /// Creates a json map from a [Task]
  Map<String, dynamic> toJson() => <String, dynamic>{
        'id': id,
        'title': title,
        'completed': completed,
      };

  @override
  String toString() {
    return 'Task $id, "$title" is ${completed ? "completed" : "not completed"}';
  }
}

void main() async {
  // Temporary directory
  final dirPath = Directory.systemTemp;
  // Temporary database file for a shared store
  final file = File('${dirPath.path}/stash_sqlite.sdb');

  // Creates a store
  final store = await newSqliteLocalVaultStore(file: file);

  // Creates a vault from the previously created store
  final vault = await store.vault&lt;Task&gt;(
      name: 'vault', 
      fromEncodable: (json) =&gt; Task.fromJson(json),
      eventListenerMode: EventListenerMode.synchronous)
    ..on&lt;VaultEntryCreatedEvent&lt;Task&gt;&gt;().listen(
        (event) =&gt; print('Key "${event.entry.key}" added to the vault'));

  // Adds a task with key 'task1' to the vault
  await vault.put(
      'task k', Task(id: 1, title: 'Run vault store example', completed: true));
  // Retrieves the value from the vault
  print(await vault.get('task k'));
  // Closes the vault
  vault.close();
}

使用说明

1. 添加依赖项到 pubspec.yaml 文件中，替换 x.x.x 为最新版本的 stash_sqlite：

   dependencies:
     stash_sqlite: ^x.x.x
   

2. 运行以下命令安装依赖项：

   dart pub get
   

3. 开始开发时导入库：

   import 'package:stash/stash_api.dart';
   import 'package:stash_sqlite/stash_sqlite.dart';
   

示例代码

• Vault 示例

  import 'dart:io';
  
  import 'package:stash/stash_api.dart';
  import 'package:stash_sqlite/stash_sqlite.dart';
  
  class Task {
    final int id;
    final String title;
    final bool completed;
  
    Task({required this.id, required this.title, this.completed = false});
  
    /// Creates a [Task] from json map
    factory Task.fromJson(Map<String, dynamic> json) => Task(
        id: json['id'] as int,
        title: json['title'] as String,
        completed: json['completed'] as bool);
  
    /// Creates a json map from a [Task]
    Map<String, dynamic> toJson() => <String, dynamic>{
          'id': id,
          'title': title,
          'completed': completed,
        };
  
    @override
    String toString() {
      return 'Task $id, "$title" is ${completed ? "completed" : "not completed"}';
    }
  }
  
  void main() async {
    // Temporary directory
    final dirPath = Directory.systemTemp;
    // Temporary database file for a shared store
    final file = File('${dirPath.path}/stash_sqlite.sdb');
  
    // Creates a store
    final store = await newSqliteLocalVaultStore(file: file);
  
    // Creates a vault from the previously created store
    final vault = await store.vault&lt;Task&gt;(
        name: 'vault', 
        fromEncodable: (json) =&gt; Task.fromJson(json),
        eventListenerMode: EventListenerMode.synchronous)
      ..on&lt;VaultEntryCreatedEvent&lt;Task&gt;&gt;().listen(
          (event) =&gt; print('Key "${event.entry.key}" added to the vault'));
  
    // Adds a task with key 'task1' to the vault
    await vault.put(
        'task1', Task(id: 1, title: 'Run vault store example', completed: true));
    // Retrieves the value from the vault
    print(await vault.get('task1'));
    // Closes the vault
    vault.close();
  }
  

• Cache 示例

  import 'dart:io';
  
  import 'package:stash/stash_api.dart';
  import 'package:stash_sqlite/stash_sqlite.dart';
  
  class Task {
    final int id;
    final String title;
    final bool completed;
  
    Task({required this.id, required this.title, this.completed = false});
  
    /// Creates a [Task] from json map
    factory Task.fromJson(Map<String, dynamic> json) => Task(
        id: json['id'] as int,
        title: json['title'] as String,
        completed: json['completed'] as bool);
  
    /// Creates a json map from a [Task]
    Map<String, dynamic> toJson() =>
        <String, dynamic>{'id': id, 'title': title, 'completed': completed};
  
    @override
    String toString() {
      return 'Task $id, "$title" is ${completed ? "completed" : "not completed"}';
    }
  }
  
  void main() async {
    // Temporary directory
    final dirPath = Directory.systemTemp;
    // Temporary database file for a shared store
    final file = File('${dirPath.path}/stash_sqlite.sdb');
  
    // Creates a store
    final store = await newSqliteLocalCacheStore(file: file);
  
    // Creates a cache with a capacity of 10 from the previously created store
    final cache = await store.cache<Task>(
        name: 'cache1',
        fromEncodable: (json) => Task.fromJson(json),
        maxEntries: 10,
        eventListenerMode: EventListenerMode.synchronous)
      ..on<CacheEntryCreatedEvent<Task>>().listen(
          (event) => print('Key "${event.entry.key}" added to the cache'));
  
    // Adds a task with key 'task1' to the cache
    await cache.put(
        'task1', Task(id: 1, title: 'Run cache store example', completed: true));
    // Retrieves the value from the cache
    print(await cache.get('task1'));
    // Closes the cache
    cache.close();
  }