Flutter大文件处理插件large_file_handler的使用

Flutter大文件处理插件large_file_handler的使用

大文件处理插件Large File Handler

Large File Handler Plugin 设计用于高效地处理大文件，例如允许从网络下载大文件或将文件从Flutter应用的资源复制到设备的本地文件系统。这在你需要在插件的原生部分访问大文件时非常有用。

特性

• 可以将任何资源从你的Flutter项目复制到本地文件系统。
• 可以从网络下载文件到本地文件系统。
• 支持跨平台（Android和iOS）。
• 支持带或不带进度跟踪的文件复制。

安装

要安装此插件，请在pubspec.yaml文件的依赖项部分添加以下行：

dependencies:
  large_file_handler: ^0.3.1

然后运行：

flutter pub get

使用资源

1. 在pubspec.yaml中注册资源

确保资源文件已注册到你的Flutter应用中。在pubspec.yaml文件中添加以下行：

flutter:
  assets:
    - assets/example.json

2. 将资源复制到本地文件系统

不带进度跟踪

使用插件将资源文件复制到设备上的本地路径：

import 'package:large_file_handler/large_file_handler.dart';

Future<void> copyAssetToLocal() async {
  String status;
  try {
    const assetName = 'example.json';
    const targetPath = 'example.json';

    await LargeFileHandler().copyAssetToLocalStorage(assetName: assetName, targetPath: targetPath);
    status = '文件成功复制到 $targetPath';
  } on PlatformException catch (e) {
    status = '复制资源失败: ${e.message}';
  }
}

带进度跟踪

你还可以使用流来跟踪资源文件复制的进度：

import 'package:large_file_handler/large_file_handler.dart';

Future<void> copyAssetToLocalWithProgress() async {
  String status;
  try {
    const assetName = 'example.json';
    const targetPath = 'example.json';

    final progressStream = LargeFileHandler().copyAssetToLocalStorageWithProgress(assetName: assetName, targetPath: targetPath);
    progressStream.listen((progress) {
      print('进度: $progress%');
    });
  } on PlatformException catch (e) {
    status = '复制资源失败: ${e.message}';
  }
}

使用网络

1. 将资源上传到网络存储

确保资源文件已上传到网络或云存储。

2. 将资源下载到本地文件系统

不带进度跟踪

使用插件将资源文件下载到设备上的本地路径：

import 'package:large_file_handler/large_file_handler.dart';

Future<void> copyCloudToLocal() async {
  String status;
  try {
    const url = 'https://cloud/example.json';
    const targetPath = 'example.json';

    await LargeFileHandler().copyNetworkAssetToLocalStorage(assetUrl: url, targetPath: targetPath);
    status = '文件成功下载到 $targetPath';
  } on PlatformException catch (e) {
    status = '下载资源失败: ${e.message}';
  }
}

带进度跟踪

你还可以使用流来跟踪资源文件下载的进度：

import 'package:large_file_handler/large_file_handler.dart';

Future<void> copyCloudToLocalWithProgress() async {
  String status;
  try {
    const url = 'https://cloud/example.json';
    const targetPath = 'example.json';

    final progressStream = LargeFileHandler().copyNetworkAssetToLocalStorageWithProgress(assetUrl: url, targetPath: targetPath);
    progressStream.listen((progress) {
      print('下载进度: $progress%');
    });
  } on PlatformException catch (e) {
    status = '下载资源失败: ${e.message}';
  }
}

支持的平台

• Android
• iOS

许可证

该插件发布于MIT许可证。详情请参阅LICENSE文件。

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'dart:async';
import 'package:flutter/services.dart';
import 'package:large_file_handler/large_file_handler.dart';

void main() {
  runApp(const MaterialApp(
    home: MyApp(),
  ));
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _statusMessage = '准备复制资源...';
  StreamSubscription<int>? _progressSubscription;

  [@override](/user/override)
  void initState() {
    super.initState();
    checkAndCopyAsset();
  }

  Future<void> checkAndCopyAsset() async {
    const assetName = 'example.json';
    const targetPath = 'example1.json';

    // 检查文件是否已经存在
    bool fileExists = await LargeFileHandler().fileExists(targetPath: targetPath);

    if (fileExists) {
      // 如果文件存在，弹出对话框询问是否覆盖
      bool? shouldOverwrite = await showDialog<bool>(
        context: context,
        builder: (BuildContext context) {
          return AlertDialog(
            title: const Text('文件已存在'),
            content: const Text('目标路径下已存在文件。是否覆盖？'),
            actions: <Widget>[
              TextButton(
                onPressed: () => Navigator.of(context).pop(false), // 不覆盖
                child: const Text('否'),
              ),
              TextButton(
                onPressed: () => Navigator.of(context).pop(true), // 覆盖
                child: const Text('是'),
              ),
            ],
          );
        },
      );

      if (shouldOverwrite == false || shouldOverwrite == null) {
        setState(() {
          _statusMessage = '操作取消，文件已存在。';
        });
        return; // 如果用户拒绝覆盖，则停止操作
      }
    }

    // 如果文件不存在或用户同意覆盖，则继续复制
    copyAssetToLocalWithProgress(assetName: assetName, targetPath: targetPath);
  }

  Future<void> copyAssetToLocalWithProgress(
      {required String assetName, required String targetPath}) async {
    try {
      Stream<int> progressStream = LargeFileHandler().copyAssetToLocalStorageWithProgress(
        assetName: assetName,
        targetPath: targetPath,
      );

      _progressSubscription = progressStream.listen(
        (progress) {
          setState(() {
            _statusMessage = '正在复制资源... $progress%';
          });
        },
        onDone: () {
          setState(() {
            _statusMessage = '文件成功复制到 $targetPath';
          });
        },
        onError: (error) {
          setState(() {
            _statusMessage = '复制资源失败: $error';
          });
        },
      );
    } on PlatformException catch (e) {
      setState(() {
        _statusMessage = '复制资源失败: ${e.message}';
      });
    }
  }

  [@override](/user/override)
  void dispose() {
    _progressSubscription?.cancel();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('插件示例应用'),
      ),
      body: Center(
        child: Text(_statusMessage),
      ),
    );
  }
}