Flutter文件保存插件cr_file_saver的使用

Flutter文件保存插件cr_file_saver的使用

Cleveroad引入了Flutter文件保存插件

特性

• 请求WriteExternalStoragePermission（如果需要）。
• 将文件保存到Android设备的下载目录或iOS设备的Document文件夹。
• 通过标准文件保存对话框保存文件。

未来特性

• 将文件保存到特定目录。

设置

在你的Flutter项目的pubspec.yaml文件中，添加以下依赖：

dependencies:
  ...
  cr_file_saver: ^0.0.2

Android:

如果你使用的是Android 9及以下版本，在项目清单中添加以下权限：

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

iOS:

在ios文件夹中，转到ios/Runner/info.plist并添加以下键值对：

<key>LSSupportsOpeningDocumentsInPlace</key>
<true/>
<key>UIFileSharingEnabled</key>
<true/>

在你的Dart文件中添加以下导入：

import 'package:cr_file_saver/cr_file_saver.dart';

使用

CRFileSaver有几种静态方法可以使用：

• requestWriteExternalStoragePermission：检查权限并在需要时请求它。
• saveFile：使用提供的文件路径和所需文件名简单地保存文件。
• saveFileWithDialog：通过标准文件保存对话框保存文件。注意，如果Android设备API级别为30或更高，则此方法将抛出NoResolvedActivityException异常。

完整示例代码

import 'dart:developer';
import 'dart:io';

import 'package:cr_file_saver/file_saver.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';

import 'package:path_provider/path_provider.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  static const _tempFileName = 'TempFile.pdf';
  static const _testFileName = 'TestFile.pdf';
  static const _testWithDialogFileName = 'TestFileWithDialog.pdf';

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: FutureBuilder<bool>(
            future: _checkIsTempFileExists(),
            builder: (context, payload) {
              return Column(
                children: [
                  OutlinedButton(
                    onPressed: _createTempPressed,
                    child: const Text('创建临时文件'),
                  ),
                  OutlinedButton(
                    onPressed: _onCheckPermissionPressed,
                    child: const Text('检查权限'),
                  ),
                  if (payload.data == true) ...[
                    OutlinedButton(
                      onPressed: _onSaveFilePressed,
                      child: const Text('保存文件'),
                    ),
                    OutlinedButton(
                      onPressed: _onSaveWithDialogPressed,
                      child: const Text('使用对话框保存文件'),
                    ),
                  ],
                ],
              );
            },
          ),
        ),
      ),
    );
  }

  /// 在临时目录中创建一个示例文件以进行操作
  void _createTempPressed() async {
    final folder = await getTemporaryDirectory();
    final filePath = '${folder.path}/$_tempFileName';
    final file = File(filePath);
    final raf = await file.open(mode: FileMode.writeOnlyAppend);
    await raf.writeString('string\n');
    await raf.close();

    log('创建临时文件: ${file.path}');
    setState(() {});
  }

  /// 检查权限并在需要时请求它
  void _onCheckPermissionPressed() async {
    final granted = await CRFileSaver.requestWriteExternalStoragePermission();

    log('requestWriteExternalStoragePermission: $granted');
  }

  /// 将创建的文件从临时目录保存到Android的下载文件夹或iOS的Documents文件夹
  void _onSaveFilePressed() async {
    final folder = await getTemporaryDirectory();
    final filePath = '${folder.path}/$_tempFileName';
    try {
      final file = await CRFileSaver.saveFile(
        filePath,
        destinationFileName: _testFileName,
      );
      log('保存到 $file');
    } on PlatformException catch (e) {
      log('文件保存错误: ${e.code}');
    }
  }

  /// 将创建的文件从临时目录保存到Android的下载文件夹或iOS的Documents文件夹，并使用原生对话框
  void _onSaveWithDialogPressed() async {
    final folder = await getTemporaryDirectory();
    final filePath = '${folder.path}/$_tempFileName';
    String? file;

    try {
      file = await CRFileSaver.saveFileWithDialog(SaveFileDialogParams(
        sourceFilePath: filePath,
        destinationFileName: _testWithDialogFileName,
      ));
      log('保存到 $file');
    } catch (error) {
      log('错误: $error');
    }
  }

  Future<bool> _checkIsTempFileExists() async {
    final folder = await getTemporaryDirectory();
    final filePath = '${folder.path}/$_tempFileName';
    final file = File(filePath);

    return file.exists();
  }
}