Flutter本地存储插件easy_storage的使用

概述

easy_storage 插件并不是用于Flutter本地存储，根据提供的内容，该插件主要是为了简化与 Firebase Storage 的交互，包括文件上传、删除、进度跟踪等操作。但按照您的要求，我们将基于此创建一个关于如何在 Flutter 中进行本地存储的指南，并提供完整的示例代码。

如果您确实需要了解 easy_storage 与 Firebase Storage 的交互，请参考原内容中的详细说明。这里我们假设您是想了解如何在 Flutter 应用中实现本地数据存储的功能。

对于Flutter本地存储，常用的方式有以下几种：

• SharedPreferences：适合存储简单的小型数据，如设置选项或用户偏好。
• SQLite：适合需要关系型数据库支持的应用场景。
• Hive：轻量级的NoSQL数据库，适合存储结构化数据。
• Path_provider + File I/O：适合存储大文件或者自定义格式的数据。

接下来，我们将以 shared_preferences 和 hive 为例来展示如何在Flutter项目中实现本地存储功能。

使用SharedPreferences进行简单的键值对存储

安装

首先，在pubspec.yaml文件中添加依赖：

dependencies:
  flutter:
    sdk: flutter
  shared_preferences: ^2.0.15

然后执行flutter pub get命令安装依赖。

示例代码

下面是一个简单的例子，演示了如何保存和读取字符串类型的值：

import 'package:flutter/material.dart';
import 'package:shared_preferences/shared_preferences.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'SharedPreferences Demo',
      home: SharedPreferencesDemo(),
    );
  }
}

class SharedPreferencesDemo extends StatefulWidget {
  @override
  _SharedPreferencesDemoState createState() => _SharedPreferencesDemoState();
}

class _SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
  final TextEditingController _controller = TextEditingController();
  String _savedValue = '';

  Future<void> _saveData(String value) async {
    final prefs = await SharedPreferences.getInstance();
    await prefs.setString('key', value);
    setState(() {
      _savedValue = value;
    });
  }

  Future<void> _loadData() async {
    final prefs = await SharedPreferences.getInstance();
    final value = prefs.getString('key') ?? '';
    setState(() {
      _savedValue = value;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('SharedPreferences Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: <Widget>[
            TextField(
              controller: _controller,
              decoration: InputDecoration(labelText: 'Enter something to save'),
            ),
            ElevatedButton(
              onPressed: () => _saveData(_controller.text),
              child: Text('Save Data'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _loadData,
              child: Text('Load Data'),
            ),
            SizedBox(height: 20),
            Text('Loaded Value: $_savedValue'),
          ],
        ),
      ),
    );
  }
}

使用Hive进行复杂数据结构的存储

安装

同样地，在pubspec.yaml文件中添加依赖：

dependencies:
  flutter:
    sdk: flutter
  hive: ^2.0.4
  hive_flutter: ^1.1.0
dev_dependencies:
  build_runner: ^2.1.7
  hive_generator: ^1.1.0

运行flutter pub get来安装这些包。同时还需要初始化Hive并打开Box，这通常放在应用启动时完成。

初始化Hive

在main.dart中添加如下代码：

import 'package:flutter/material.dart';
import 'package:hive_flutter/hive_flutter.dart';

Future<void> main() async {
  // Initialize Hive
  await Hive.initFlutter();

  // Open a box for storing data
  var box = await Hive.openBox('myBox');

  runApp(MyApp(box: box));
}

class MyApp extends StatelessWidget {
  final Box box;

  MyApp({required this.box});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Hive Demo',
      home: HomeScreen(box: box),
    );
  }
}

创建模型类（可选）

如果要存储更复杂的对象，可以创建一个模型类并注册它。例如：

part 'person.g.dart';

@HiveType(typeId: 0)
class Person {
  @HiveField(0)
  String name;

  @HiveField(1)
  int age;

  Person({required this.name, required this.age});
}

记得生成代码（使用build_runner）：

flutter pub run build_runner build

示例代码

接下来是具体的页面逻辑：

import 'package:flutter/material.dart';
import 'package:hive_flutter/hive_flutter.dart';

class HomeScreen extends StatefulWidget {
  final Box box;

  HomeScreen({required this.box});

  @override
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  final TextEditingController _nameController = TextEditingController();
  final TextEditingController _ageController = TextEditingController();

  void _addPerson() {
    final name = _nameController.text;
    final age = int.tryParse(_ageController.text) ?? 0;

    widget.box.put('person', {'name': name, 'age': age});
    
    // Clear text fields after saving
    _nameController.clear();
    _ageController.clear();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Hive Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _nameController,
              decoration: InputDecoration(labelText: 'Name'),
            ),
            TextField(
              controller: _ageController,
              keyboardType: TextInputType.number,
              decoration: InputDecoration(labelText: 'Age'),
            ),
            ElevatedButton(
              onPressed: _addPerson,
              child: Text('Add Person'),
            ),
            SizedBox(height: 20),
            ValueListenableBuilder(
              valueListenable: widget.box.listenable(),
              builder: (context, box, _) {
                final person = box.get('person');
                return Column(
                  children: [
                    if (person != null)
                      ListTile(
                        title: Text(person['name']),
                        subtitle: Text('${person['age']} years old'),
                      ),
                    if (person == null)
                      Text('No person added yet.'),
                  ],
                );
              },
            ),
          ],
        ),
      ),
    );
  }
}

以上就是利用shared_preferences和hive两个不同的方式来进行Flutter本地存储的例子。希望这对您有所帮助！如果有任何问题或需要进一步的帮助，请随时告诉我。