Flutter文件保存插件simple_file_saver的使用

发布于 1周前 作者 yuanlaile 来自 Flutter

Flutter文件保存插件simple_file_saver的使用

simple_file_saver 是一个Flutter插件,允许你将文件保存到公共或共享目录,如Android中的下载文件夹和iOS中的文件应用。

使用方法

要在项目中使用此插件,请在 pubspec.yaml 文件中添加 simple_file_saver 作为依赖项:

dependencies:
  simple_file_saver: ^最新版本号

记得替换 ^最新版本号 为实际的最新版本号。可以通过访问 simple_file_saver on pub.dev 获取最新版本信息。

示例代码

下面是一个完整的示例Demo,展示了如何使用 simple_file_saver 插件来保存文件、从网络链接下载文件以及从资源文件保存PDF文档。

主要功能演示

import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:simple_file_saver/simple_file_saver.dart';

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

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Simple File Saver Demo'),
        ),
        body: Builder(
          builder: (context) => Center(
            child: Column(
              mainAxisSize: MainAxisSize.min,
              children: <Widget>[
                // 示例1:直接保存文本文件到默认位置
                ElevatedButton(
                  onPressed: () async {
                    final result = await SimpleFileSaver.saveFile(
                      fileInfo: FileSaveInfo.fromBytes(
                        bytes: utf8.encode('This file is saved to the default directory'),
                        basename: 'default_save',
                        extension: 'txt',
                      ),
                    );
                    showSnackBar(context, 'File saved to path: $result');
                  },
                  child: const Text('Save text file to default location'),
                ),
                
                const SizedBox(height: 20),
                
                // 示例2:让用户选择保存位置
                ElevatedButton(
                  onPressed: () async {
                    final result = await SimpleFileSaver.saveFile(
                      fileInfo: FileSaveInfo.fromBytes(
                        bytes: utf8.encode('This file is saved to the user picked directory'),
                        basename: 'user_pick_save',
                        extension: 'txt',
                      ),
                      saveAs: true,
                    );
                    showSnackBar(context, 'File saved to path: $result');
                  },
                  child: const Text('Save text file and choose location'),
                ),
                
                const SizedBox(height: 20),
                
                // 示例3:从网络下载图片
                SimpleFileSaver.downloadLinkBuilder(
                  fileInfo: FileSaveInfo.fromUrl(
                    url: 'https://picsum.photos/id/237/200/300',
                    basename: 'test_image_dl',
                    extension: 'jpg',
                  ),
                  builder: (_, startDownload) => ElevatedButton(
                    onPressed: startDownload,
                    child: const Text('Download image from web'),
                  ),
                ),
                
                const SizedBox(height: 20),
                
                // 示例4:从assets保存PDF文件
                ElevatedButton(
                  onPressed: () async {
                    final byteData = await rootBundle.load("assets/sample.pdf");
                    final result = await SimpleFileSaver.saveFile(
                      fileInfo: FileSaveInfo.fromBytes(
                        bytes: byteData.buffer.asUint8List(),
                        basename: 'pdf_sample',
                        extension: 'pdf',
                      ),
                      saveAs: true,
                    );
                    showSnackBar(context, 'File saved to path: $result');
                  },
                  child: const Text('Save PDF from assets'),
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }

  void showSnackBar(BuildContext context, String message) {
    if (context.mounted) {
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text(message)));
    }
  }
}

请确保在 pubspec.yaml 中正确配置了 assets 路径,并且你的项目中有相应的PDF文件位于指定的路径下。这个示例展示了如何利用 simple_file_saver 插件实现不同类型的文件保存操作。


更多关于Flutter文件保存插件simple_file_saver的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter文件保存插件simple_file_saver的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,以下是一个关于如何在Flutter项目中使用simple_file_saver插件来保存文件的示例代码。这个插件允许你轻松地在设备上保存文件。

首先,确保你已经在pubspec.yaml文件中添加了simple_file_saver依赖:

dependencies:
  flutter:
    sdk: flutter
  simple_file_saver: ^x.y.z  # 请替换为最新版本号

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

接下来,下面是一个完整的示例代码,展示了如何使用simple_file_saver来保存一个文本文件:

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter File Saver Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: FileSaverExample(),
    );
  }
}

class FileSaverExample extends StatefulWidget {
  @override
  _FileSaverExampleState createState() => _FileSaverExampleState();
}

class _FileSaverExampleState extends State<FileSaverExample> {
  final _controller = TextEditingController();
  final _fileNameController = TextEditingController();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('File Saver Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            TextField(
              controller: _fileNameController,
              decoration: InputDecoration(
                labelText: 'File Name',
              ),
            ),
            SizedBox(height: 16),
            TextField(
              controller: _controller,
              maxLines: 10,
              decoration: InputDecoration(
                labelText: 'File Content',
              ),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: _saveFile,
              child: Text('Save File'),
            ),
          ],
        ),
      ),
    );
  }

  void _saveFile() async {
    String fileName = _fileNameController.text;
    String content = _controller.text;

    if (fileName.isEmpty || content.isEmpty) {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text('Please enter both file name and content.')),
      );
      return;
    }

    try {
      FileSaver fileSaver = FileSaver();
      String filePath = await fileSaver.saveFile(
        fileName: fileName,
        content: content,
      );

      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text('File saved at: $filePath')),
      );
    } catch (e) {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text('Failed to save file: ${e.message}')),
      );
    }
  }

  @override
  void dispose() {
    _controller.dispose();
    _fileNameController.dispose();
    super.dispose();
  }
}

代码解释:

  1. 依赖添加:在pubspec.yaml文件中添加simple_file_saver依赖。
  2. UI构建:使用MaterialAppScaffold来构建UI,包括两个TextField(一个用于文件名,一个用于文件内容)和一个ElevatedButton用于触发保存操作。
  3. 保存文件逻辑:在_saveFile方法中,使用FileSaver实例的saveFile方法来保存文件。如果文件名或内容为空,显示一个SnackBar提示用户。保存成功后,显示保存路径,如果失败,显示错误信息。
  4. 资源清理:在dispose方法中释放TextEditingController资源。

这个示例代码展示了如何使用simple_file_saver插件在Flutter应用中保存文件。你可以根据需要进一步定制和扩展这个示例。

回到顶部