Flutter文件下载至下载文件夹插件downloadsfolder的使用

Flutter Download Folder Plugin 是一个用于获取不同平台上的下载文件夹路径，并执行与文件下载相关的操作的插件。

支持平台

插件功能介绍

获取下载目录路径

getDownloadDirectoryPath 函数通过平台特定的通道来获取当前平台的下载文件夹路径。

将文件复制到下载文件夹

copyFileIntoDownloadFolder 函数允许将文件复制到下载文件夹中，指定文件名并确保名称唯一以避免覆盖现有文件。

打开下载文件夹

openDownloadFolder 函数根据平台差异打开设备的下载文件夹。对于Android和iOS，它使用平台特定的通道；对于macOS和Windows，则是获取下载文件夹的路径后进行打开操作。

安装配置

在 pubspec.yaml 文件中添加 downloadsfolder 依赖：

dependencies:
  downloadsfolder: ^1.1.0

配置项

Android

• 对于API 29及以上版本的Android设备，copyFileIntoDownloadFolder 方法会使用MediaStore保存文件以绕过存储权限限制。
• 对于API 28及以下版本的设备，请确保已在 AndroidManifest.xml 中的应用元素下添加了 WRITE_EXTERNAL_STORAGE 权限：

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

iOS

为了启用 openDownloadFolder 功能，需要在 Info.plist 文件中添加如下键值对：

<key>UISupportsDocumentBrowser</key>
<true/>

macOS

进入项目文件夹下的 macOS/Runner/DebugProfile.entitlements 文件（对于发布版则为 'YOUR_PROJECT_NAME'Profile.entitlements），并添加以下键：

<key>com.apple.security.files.downloads.read-write</key>
<true/>

使用示例代码

下面是一个完整的演示demo，展示了如何使用这个插件的功能：

import 'dart:io';
import 'package:flutter/material.dart';
import 'package:downloadsfolder/downloadsfolder.dart';
import 'package:file_picker/file_picker.dart';
import 'package:permission_handler/permission_handler.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: MyApp(),
    );
  }
}

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

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

class _MyAppState extends State<MyApp> {
  String? _downloadsfolderPath;
  File? _pickedFile;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Plugin example app'),
      ),
      body: Column(
        children: [
          ElevatedButton(
            onPressed: _getDownloadPath,
            child: const Center(
              child: Text('Get Download Path'),
            ),
          ),
          if (_downloadsfolderPath != null)
            Center(
              child: Text('Downloads Folder Path: $_downloadsfolderPath\n'),
            ),
          ElevatedButton(
            onPressed: _pickAFile,
            child: const Center(
              child: Text('Pick a File'),
            ),
          ),
          if (_pickedFile != null)
            Center(
              child: Text('Picked File Path: ${_pickedFile!.path}\n'),
            ),
          if (_pickedFile != null)
            ElevatedButton(
              onPressed: _saveFile,
              child: const Center(
                child: Text('Save Picked File into Downloads Folder'),
              ),
            ),
          ElevatedButton(
            onPressed: _openDownloadFolder,
            child: const Center(
              child: Text('Show Download Folder'),
            ),
          ),
        ],
      ),
    );
  }

  Future<void> _getDownloadPath() async {
    Directory downloadsfolderPath;
    try {
      downloadsfolderPath = await getDownloadDirectory();
      if (!mounted) return;

      setState(() {
        _downloadsfolderPath = downloadsfolderPath.path;
      });
    } on PlatformException {
      if (!mounted) return;
      setState(() {
        _downloadsfolderPath = 'Failed to get folder path.';
      });
    }
  }

  Future<void> _pickAFile() async {
    FilePickerResult? result = await FilePicker.platform.pickFiles();

    if (!mounted) return;

    if (result != null) {
      File file = File(result.files.single.path!);
      setState(() {
        _pickedFile = file;
      });
    } else {
      ScaffoldMessenger.of(context).showSnackBar(
        const SnackBar(
          content: Text('No File Has been selected'),
        ),
      );
    }
  }

  Future<void> _saveFile() async {
    bool storagePermissionGranted = true;

    if (Platform.isAndroid || Platform.isIOS) {
      storagePermissionGranted = await Permission.storage.isGranted;

      if (!storagePermissionGranted) {
        final status = await Permission.storage.request();
        storagePermissionGranted = status.isGranted;
      }
    }

    if (!storagePermissionGranted) {
      if (!mounted) return;
      ScaffoldMessenger.of(context).showSnackBar(
        const SnackBar(
          content: Text('Failed to copy file. Storage permission is required.'),
        ),
      );
      return;
    }

    bool? success = await copyFileIntoDownloadFolder(
      _pickedFile!.path,
      basenameWithoutExtension(_pickedFile!.path),
      desiredExtension: extension(_pickedFile!.path),
    );

    if (!mounted) return;

    ScaffoldMessenger.of(context).showSnackBar(
      SnackBar(
        content: Text(success == true ? 'File copied successfully.' : 'Failed to copy file.'),
        action: success == true
            ? SnackBarAction(
                label: 'Show Download Folder',
                onPressed: _openDownloadFolder,
              )
            : null,
      ),
    );
  }

  Future<void> _openDownloadFolder() => openDownloadFolder();
}

这段代码创建了一个简单的Flutter应用程序界面，用户可以点击按钮获取下载文件夹路径、选择文件、将所选文件保存到下载文件夹以及显示下载文件夹。