Flutter文件上传进度监控插件file_progress的使用

Flutter文件上传进度监控插件file_progress的使用

file_progress

Hello Devloper

这个包用于带进度地读取和写入文本文件。您可以显示带有进度的对话框,并且可以隐藏对话框。感谢您使用我的包!


使用示例

以下是一个完整的示例,展示如何在Flutter应用中使用file_progress插件来实现文件读取和写入的进度监控。

示例代码

import 'package:file_progress/file_progress.dart'; // 导入 file_progress 包
import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp()); // 启动应用
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'File Progress Demo', // 应用标题
      debugShowCheckedModeBanner: false, // 去掉调试标志
      theme: ThemeData(
        primarySwatch: Colors.blue, // 主题颜色
      ),
      home: const FlutterProgress(), // 主页面
    );
  }
}

class FlutterProgress extends StatefulWidget {
  const FlutterProgress({Key? key}) : super(key: key);

  [@override](/user/override)
  State<FlutterProgress> createState() => _FlutterProgressState(); // 创建状态类
}

class _FlutterProgressState extends State<FlutterProgress> {
  String dateRead = ''; // 用于存储读取的文件内容

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('测试文件进度'), // 设置标题
        centerTitle: true, // 标题居中
      ),
      body: Container(
        color: Colors.grey.shade300, // 背景色
        child: SingleChildScrollView(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center, // 子元素垂直居中
            children: [
              Row(
                mainAxisAlignment: MainAxisAlignment.center, // 子元素水平居中
                children: [
                  Padding(
                    padding: const EdgeInsets.all(8.0), // 设置内边距
                    child: FileProgressWidget(
                      progressType: ProgressType.loadDataFromFile, // 读取文件进度类型
                      filePath: 'C:\\Users\\Mohammed\\help.txt', // 文件路径(请根据实际情况修改)
                      onChangeProgress: (value) {
                        print(value); // 打印进度值
                      },
                      onDoneData: (value) {
                        print(value); // 打印完成后的数据
                        setState(() {
                          dateRead = value; // 更新UI
                        });
                      },
                      showProgress: true, // 是否显示进度条
                    ),
                  ),
                  Padding(
                    padding: const EdgeInsets.all(8.0),
                    child: FileProgressWidget(
                      progressType: ProgressType.saveDataToFile, // 写入文件进度类型
                      filePath: 'C:\\Users\\Mohammed\\newText.txt', // 文件路径(请根据实际情况修改)
                      onChangeProgress: (value) {
                        print(value); // 打印进度值
                      },
                      dataWrite: // 写入的文本内容
                          'Hello Developer\n此包用于带进度地读取和写入文本文件。\n您可以显示带有进度的对话框,并且可以隐藏对话框。\n感谢您使用我的包!',
                      showProgress: true, // 是否显示进度条
                    ),
                  ),
                ],
              ),
              Text(dateRead), // 显示读取的文件内容
            ],
          ),
        ),
      ),
    );
  }
}

更多关于Flutter文件上传进度监控插件file_progress的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter文件上传进度监控插件file_progress的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在Flutter中,file_progress 是一个用于监控文件上传进度的插件。它可以帮助你在文件上传过程中实时获取上传进度,并在UI中显示进度条或其他反馈信息。下面是如何使用 file_progress 插件的基本步骤:

1. 添加依赖

首先,你需要在 pubspec.yaml 文件中添加 file_progress 插件的依赖:

dependencies:
  flutter:
    sdk: flutter
  file_progress: ^0.1.0  # 请检查最新版本

然后运行 flutter pub get 来安装依赖。

2. 导入插件

在你的Dart文件中导入 file_progress 插件:

import 'package:file_progress/file_progress.dart';

3. 创建 FileProgress 实例

你需要创建一个 FileProgress 实例来监控文件上传的进度。

FileProgress fileProgress = FileProgress();

4. 开始上传文件并监控进度

假设你有一个文件上传的函数 uploadFile,你可以使用 fileProgress 来监控上传进度。

Future<void> uploadFile(File file) async {
  // 获取文件大小
  int fileSize = await file.length();

  // 开始上传
  Stream<int> uploadStream = yourUploadFunction(file);

  // 监控上传进度
  fileProgress.start(fileSize, uploadStream);

  // 监听进度变化
  fileProgress.progressStream.listen((progress) {
    print('Upload progress: $progress%');
  });

  // 等待上传完成
  await fileProgress.done;

  print('Upload completed!');
}

5. 在UI中显示进度

你可以使用 StreamBuilderValueListenableBuilder 来在UI中显示上传进度。

StreamBuilder<int>(
  stream: fileProgress.progressStream,
  builder: (context, snapshot) {
    if (snapshot.hasData) {
      return CircularProgressIndicator(value: snapshot.data / 100);
    } else {
      return CircularProgressIndicator();
    }
  },
)

6. 处理上传完成

你可以使用 fileProgress.done 来等待上传完成,并在上传完成后执行一些操作。

await fileProgress.done;
print('File upload completed!');

7. 错误处理

你还可以监听错误流来处理上传过程中可能发生的错误。

fileProgress.errorStream.listen((error) {
  print('Upload error: $error');
});

8. 取消上传

如果你想取消上传,可以调用 cancel 方法。

fileProgress.cancel();

完整示例

import 'package:flutter/material.dart';
import 'package:file_progress/file_progress.dart';
import 'dart:io';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: FileUploadPage(),
    );
  }
}

class FileUploadPage extends StatefulWidget {
  [@override](/user/override)
  _FileUploadPageState createState() => _FileUploadPageState();
}

class _FileUploadPageState extends State<FileUploadPage> {
  FileProgress fileProgress = FileProgress();

  Future<void> uploadFile(File file) async {
    int fileSize = await file.length();
    Stream<int> uploadStream = yourUploadFunction(file);

    fileProgress.start(fileSize, uploadStream);

    fileProgress.progressStream.listen((progress) {
      print('Upload progress: $progress%');
    });

    await fileProgress.done;
    print('Upload completed!');
  }

  Stream<int> yourUploadFunction(File file) async* {
    // 模拟上传过程
    for (int i = 0; i <= 100; i++) {
      await Future.delayed(Duration(milliseconds: 100));
      yield i;
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('File Upload Progress'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            StreamBuilder<int>(
              stream: fileProgress.progressStream,
              builder: (context, snapshot) {
                if (snapshot.hasData) {
                  return CircularProgressIndicator(value: snapshot.data / 100);
                } else {
                  return CircularProgressIndicator();
                }
              },
            ),
            ElevatedButton(
              onPressed: () async {
                File file = File('path_to_your_file');
                await uploadFile(file);
              },
              child: Text('Upload File'),
            ),
          ],
        ),
      ),
    );
  }
}
回到顶部