Flutter数据存储管理插件storage_hub的使用

Flutter数据存储管理插件storage_hub的使用

这个Flutter插件可以将文件存储在设备上，并在触发时分块上传到您的存储。

添加依赖

首先，在项目中添加storage_hub依赖：

$ flutter pub add storage_hub

这将在您的包的pubspec.yaml文件中添加一行（并运行隐式的flutter pub get）：

dependencies:
    storage_hub: ^0.0.5

或者，您的编辑器可能支持flutter pub get。查阅您的编辑器文档以了解更多信息。

导入插件

现在可以在Dart代码中导入：

import 'package:storage_hub/storage_hub.dart';

如何使用

初始化插件

在主函数中初始化插件：

void main() {
    if (!StorageHub.isConfigured) {
        StorageHub.configure(
            apiKey: 'YOUR_API_KEY',
            chunkSize: 128 * 1024,
            retryCount: 10,
            baseUrl: 'BASE_URL_OF_YOUR_HUB',
            portUrl: 'PART_URL_OF_YOUR_UPLOAD_REQUEST_TO_OBTAIN_SESSION',
            putUrl: 'PART_URL_FOR_UPLOAD_WITH_SESSION',
        );
    }

    runApp(const MyApp());
}

添加文件

根据需要添加文件：

bool result = await StorageHub.addFile(
        filePath: '/data/0/a_folder/another_folder/',
        fileName: 'my_picture.jpg',
        totalBytes: 25234, // 文件的总字节数
        metadata: {
            "someCustomKey": "someCustomValue",
            "anotherKey": "anotherValue",
        },
    );

获取文件列表

获取已添加的文件列表：

List<FileDefinition> myFiles = StorageHub.fileList; // 返回存储在RAM中的文件列表

或者查询文件列表：

List<FileDefinition> myFiles = await StorageHub.getFileList(); // 返回数据库中的文件列表

删除文件

如果需要删除文件：

bool deleted = await StorageHub.deleteFile(id: 123); // 您可以从FileDefinition列表中获得id

触发同步

最后，您可以触发同步操作：

StorageHub.triggerSync();

这将运行一个进程，依次开始或恢复您的文件列表中的上传任务。

StorageHub会从列表中移除已上传的文件。

StorageHub会更新FileDefinition的状态和已上传的字节数。

StorageHub会排队任何失败的操作以便重试。

定义

• StorageHub.isSyncing 是一个bool值，当有上传操作时返回true。
• StorageHub.syncingFile 是一个FileDefinition?值，如果存在正在上传的文件，则返回该文件。
• StorageHub.progress 是一个double值，返回操作的上传进度，范围在0到1之间。
• StorageHub.fileList 是一个List<FileDefinition>，由您添加的文件组成。

方法

• StorageHub.addFile() 是一个异步方法，用于添加文件 接受：String filePath，String fileName，int totalBytes，Map<String,dynamic>? metadata 和 String? time 返回：bool，如果添加操作成功则返回true。

• StorageHub.deleteFile() 是一个异步方法，用于删除文件 接受：String id 返回：bool，如果删除操作成功则返回true。

• StorageHub.getFileList() 是一个异步方法，用于获取您的文件列表 返回：List<FileDefinition>

• StorageHub.triggerSync() 是一个无返回值的方法，用于触发上传操作。

枚举

• SyncStatus 是一个枚举，表示文件的状态。

模型

• FileDefinition 是文件的模型。

示例代码

以下是一个完整的示例代码：

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

void main() {
  if (!StorageHub.isConfigured) {
    StorageHub.configure(
        apiKey: 'YOUR_API_KEY',
        chunkSize: 128 * 1024,
        retryCount: 10,
        baseUrl: 'BASE_URL_OF_YOUR_HUB',
        portUrl: 'PART_URL_OF_YOUR_UPLOAD_REQUEST_TO_OBTAIN_SESSION',
        putUrl: 'PART_URL_FOR_UPLOAD_WITH_SESSION',
    );
  }

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}