Flutter文件属性获取插件flutter_file_attributes的使用

Flutter插件flutter_file_attributes用于获取文件和文件夹的属性。

使用方法

final _flutterFileAttributesPlugin = FlutterFileAttributes();
var fileAttributes = await _flutterFileAttributesPlugin.getFileAttriburtes(filePath);

TODO:

• ❌ 在Android平台上实现。
• ❌ 实现对文件夹属性的支持。

示例代码

以下是一个完整的示例代码，展示如何使用flutter_file_attributes插件来获取文件属性。

示例代码

import 'dart:convert';
import 'dart:io';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:file_picker/file_picker.dart';
import 'package:path_provider/path_provider.dart';
import 'package:path/path.dart';
import 'package:flutter/services.dart';
import 'package:flutter_file_attributes/flutter_file_attributes.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  String? filePath; // 文件路径
  Map _fileAttributes = {}; // 文件属性
  final _flutterFileAttributesPlugin = FlutterFileAttributes(); // 插件实例

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  // 获取文件属性的方法
  Future<void> getFileAttributes() async {
    if (filePath != null) { // 如果文件路径不为空
      Map fileAttributes = {}; // 初始化文件属性
      try {
        fileAttributes = await _flutterFileAttributesPlugin.getFileAttriburtes(filePath!); // 调用插件获取属性
      } on PlatformException catch (e) {
        if (kDebugMode) {
          print(e.message); // 打印异常信息
        }
      }
      if (!mounted) return; // 如果组件已卸载，返回

      setState(() {
        _fileAttributes = fileAttributes; // 更新UI
      });
    } else {
      if (kDebugMode) {
        print('Copy file first'); // 提示用户先复制文件
      }
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'), // 应用标题
        ),
        body: Text(getPrettyJSONString(_fileAttributes)), // 显示文件属性
        floatingActionButton: Row(
          mainAxisAlignment: MainAxisAlignment.spaceEvenly, // 按钮水平排列
          children: [
            ElevatedButton(
              onPressed: copyFileToDucmentDirectory, // 复制文件按钮
              child: const Text("Copy file"), // 按钮文字
            ),
            ElevatedButton(
              child: const Text('Get Attributes'), // 获取属性按钮
              onPressed: () {
                getFileAttributes(); // 调用获取属性方法
              },
            ),
          ],
        ),
      ),
    );
  }

  // 将文件复制到文档目录
  void copyFileToDucmentDirectory() async {
    var result = await FilePicker.platform.pickFiles(); // 打开文件选择器

    if (result == null || result.count < 1) return; // 如果用户未选择文件，返回

    var documentDirectory = await getApplicationDocumentsDirectory(); // 获取文档目录
    var newFile = await File(result.paths.first!) // 复制文件到文档目录
        .copy(join(documentDirectory.path, "main.db"));

    setState(() {
      filePath = newFile.path; // 更新文件路径
    });
  }

  // 格式化JSON字符串
  String getPrettyJSONString(jsonObject) {
    var encoder = const JsonEncoder.withIndent("     "); // 创建JSON编码器
    return encoder.convert(jsonObject); // 返回格式化的JSON字符串
  }
}