Flutter笔记管理插件nas_note的使用

Flutter笔记管理插件nas_note的使用

nas_note 是一个用于安全记笔记的 Flutter 插件，支持 SQLite 存储，并且兼容移动设备（iOS 和 Android）以及桌面平台（Windows、Linux 和 macOS）。以下是关于如何使用该插件的详细说明。

特性

• 创建、读取、更新和删除笔记
• 跨平台支持（iOS、Android、Windows、Linux、macOS）
• 简单直观的 API
• SQLite 存储，基于 sqflite 和 sqflite_common_ffi

开始使用

首先，在你的 Flutter 项目中添加 nas_note 插件：

在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  nas_note: ^0.0.1

然后运行以下命令以安装依赖：

flutter pub get

使用示例

以下是一个完整的示例代码，展示如何使用 nas_note 插件来管理笔记。

import 'package:flutter/material.dart';
import 'package:nas_note/database_helper.dart';
import 'package:nas_note/note.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: NoteManagementScreen(),
    );
  }
}

class NoteManagementScreen extends StatefulWidget {
  @override
  _NoteManagementScreenState createState() => _NoteManagementScreenState();
}

class _NoteManagementScreenState extends State<NoteManagementScreen> {
  late Future<List<Note>> _notesFuture;

  @override
  void initState() {
    super.initState();
    // 初始化数据库工厂
    DatabaseHelper.instance.initializeDatabaseFactory();
    // 获取所有笔记
    _notesFuture = DatabaseHelper.instance.getAllNotes();
  }

  Future<void> _addNote() async {
    final newNote = Note(
      title: '我的新笔记',
      description: '这是我的第一条笔记',
      date: DateTime.now().toIso8601String(),
    );
    await DatabaseHelper.instance.addNote(newNote);
    setState(() {
      _notesFuture = DatabaseHelper.instance.getAllNotes(); // 刷新笔记列表
    });
  }

  Future<void> _updateNote() async {
    final updatedNote = Note(
      id: 1, // 假设要更新的笔记 ID 为 1
      title: '更新后的笔记',
      description: '这条笔记已经被更新了',
      date: DateTime.now().toIso8601String(),
    );
    await DatabaseHelper.instance.updateNote(updatedNote);
    setState(() {
      _notesFuture = DatabaseHelper.instance.getAllNotes(); // 刷新笔记列表
    });
  }

  Future<void> _deleteNote() async {
    await DatabaseHelper.instance.deleteNote(1); // 删除 ID 为 1 的笔记
    setState(() {
      _notesFuture = DatabaseHelper.instance.getAllNotes(); // 刷新笔记列表
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('笔记管理'),
      ),
      body: FutureBuilder<List<Note>>(
        future: _notesFuture,
        builder: (context, snapshot) {
          if (snapshot.connectionState == ConnectionState.waiting) {
            return Center(child: CircularProgressIndicator());
          } else if (snapshot.hasError) {
            return Center(child: Text('加载失败: ${snapshot.error}'));
          } else {
            final notes = snapshot.data!;
            return ListView.builder(
              itemCount: notes.length,
              itemBuilder: (context, index) {
                final note = notes[index];
                return ListTile(
                  title: Text(note.title),
                  subtitle: Text(note.description),
                  onTap: () {
                    // 点击笔记可以进行更多操作
                  },
                );
              },
            );
          }
        },
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _addNote,
        child: Icon(Icons.add),
      ),
    );
  }
}

代码详解

1. 初始化数据库

   await DatabaseHelper.instance.initializeDatabaseFactory();
   

   在使用任何数据库功能之前，必须调用此方法来初始化数据库工厂。

2. 创建笔记

   final newNote = Note(
     title: '我的新笔记',
     description: '这是我的第一条笔记',
     date: DateTime.now().toIso8601String(),
   );
   await DatabaseHelper.instance.addNote(newNote);
   

   创建一个 Note 对象并将其保存到数据库中。

3. 获取所有笔记

   _notesFuture = DatabaseHelper.instance.getAllNotes();
   

   调用 getAllNotes() 方法从数据库中获取所有笔记，并通过 FutureBuilder 将其显示在界面上。

4. 更新笔记

   final updatedNote = Note(
     id: 1,
     title: '更新后的笔记',
     description: '这条笔记已经被更新了',
     date: DateTime.now().toIso8601String(),
   );
   await DatabaseHelper.instance.updateNote(updatedNote);
   

   更新指定 ID 的笔记信息。

5. 删除笔记

   await DatabaseHelper.instance.deleteNote(1);