Flutter文件选择插件file_selector的使用

file_selector 是一个用于管理文件和与文件对话框交互的Flutter插件。本文将详细介绍如何使用该插件，包括安装、配置以及示例代码。

安装

要使用此插件，请在 pubspec.yaml 文件中添加 file_selector 作为依赖项：

dependencies:
  file_selector: ^latest_version

请确保替换 latest_version 为最新的版本号。你可以在 Pub 上查看最新版本。

平台支持

对于 macOS 用户，您还需要根据需求添加相应的权限（Entitlements）。例如，如果您只需要读取权限，则添加以下内容到 macos/Runner/DebugProfile/Runner.entitlements 和 macos/Runner/Release/Runner.entitlements 文件中：

<key>com.apple.security.files.user-selected.read-only</key>
<true/>

如果您需要读写权限，则使用以下代码：

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

使用示例

以下是几个简单的示例，展示了如何使用 file_selector 插件的功能。

打开单个文件

import 'package:file_selector/file_selector.dart';

void openSingleFile() async {
  const XTypeGroup typeGroup = XTypeGroup(
    label: 'images',
    extensions: <String>['jpg', 'png'],
  );
  final XFile? file = await openFile(acceptedTypeGroups: <XTypeGroup>[typeGroup]);
  if (file != null) {
    print('Selected file path: ${file.path}');
  } else {
    print('No file selected.');
  }
}

打开多个文件

import 'package:file_selector/file_selector.dart';

void openMultipleFiles() async {
  const XTypeGroup jpgsTypeGroup = XTypeGroup(
    label: 'JPEGs',
    extensions: <String>['jpg', 'jpeg'],
  );
  const XTypeGroup pngTypeGroup = XTypeGroup(
    label: 'PNGs',
    extensions: <String>['png'],
  );
  final List<XFile> files = await openFiles(acceptedTypeGroups: <XTypeGroup>[
    jpgsTypeGroup,
    pngTypeGroup,
  ]);
  if (files.isNotEmpty) {
    for (final file in files) {
      print('Selected file path: ${file.path}');
    }
  } else {
    print('No files selected.');
  }
}

保存文件

import 'package:file_selector/file_selector.dart';

void saveFile() async {
  const String fileName = 'suggested_name.txt';
  final FileSaveLocation? result = await getSaveLocation(suggestedName: fileName);
  if (result == null) {
    print('Operation was canceled by the user.');
    return;
  }

  final Uint8List fileData = Uint8List.fromList('Hello World!'.codeUnits);
  const String mimeType = 'text/plain';
  final XFile textFile = XFile.fromData(fileData, mimeType: mimeType, name: fileName);
  await textFile.saveTo(result.path);
  print('File saved to: ${result.path}');
}

获取目录路径

import 'package:file_selector/file_selector.dart';

void getDirectory() async {
  final String? directoryPath = await getDirectoryPath();
  if (directoryPath == null) {
    print('Operation was canceled by the user.');
    return;
  }
  print('Selected directory path: $directoryPath');
}

过滤文件类型

不同平台支持不同的类型组过滤选项。为了防止某些平台上出现 ArgumentError，请确保传递的 XTypeGroup 设置了覆盖所有目标平台的过滤器，或者根据 Platform 条件传递不同的 XTypeGroup。

示例：过滤文件类型

const XTypeGroup imagesTypeGroup = XTypeGroup(
  label: 'Images',
  extensions: <String>['jpg', 'png'],
  mimeTypes: <String>['image/jpeg', 'image/png'],
);

// For macOS and iOS, you might also want to include uniformTypeIdentifiers
if (Platform.isMacOS || Platform.isIOS) {
  imagesTypeGroup.uniformTypeIdentifiers = <String>['public.jpeg', 'public.png'];
}

final XFile? file = await openFile(acceptedTypeGroups: <XTypeGroup>[imagesTypeGroup]);

支持的功能

注：† 在 Android SDK 21（Lollipop）之前的版本不支持选择目录。

完整示例项目结构

为了让您更好地理解如何集成 file_selector 到您的项目中，这里提供了一个完整的示例项目的部分代码片段：

import 'package:flutter/material.dart';
import 'package:file_selector/file_selector.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'File Selector Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: const HomePage(),
      routes: <String, WidgetBuilder>{
        '/open/image': (BuildContext context) => const OpenImagePage(),
        '/open/images': (BuildContext context) => const OpenMultipleImagesPage(),
        '/open/text': (BuildContext context) => const OpenTextPage(),
        '/save/text': (BuildContext context) => SaveTextPage(),
        '/directory': (BuildContext context) => GetDirectoryPage(),
        '/multi-directories': (BuildContext context) => const GetMultipleDirectoriesPage()
      },
    );
  }
}

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('File Selector Demo')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () => Navigator.pushNamed(context, '/open/image'),
              child: const Text('Open Image'),
            ),
            ElevatedButton(
              onPressed: () => Navigator.pushNamed(context, '/open/images'),
              child: const Text('Open Multiple Images'),
            ),
            ElevatedButton(
              onPressed: () => Navigator.pushNamed(context, '/open/text'),
              child: const Text('Open Text File'),
            ),
            ElevatedButton(
              onPressed: () => Navigator.pushNamed(context, '/save/text'),
              child: const Text('Save Text File'),
            ),
            ElevatedButton(
              onPressed: () => Navigator.pushNamed(context, '/directory'),
              child: const Text('Get Directory Path'),
            ),
            ElevatedButton(
              onPressed: () => Navigator.pushNamed(context, '/multi-directories'),
              child: const Text('Get Multiple Directories Paths'),
            ),
          ],
        ),
      ),
    );
  }
}

通过以上步骤和示例代码，您可以轻松地将 file_selector 集成到您的 Flutter 应用程序中，并实现文件选择和保存功能。希望这些信息对您有所帮助！如果有任何问题或需要进一步的帮助，请随时提问。