Flutter文件MD5校验插件md5_file_checksum的使用

Notice

该项目已归档，作者不会再对其进行更新。通过一些性能测试对比了该实现与使用Flutter 3和Dart 2.17的纯Dart实现，两种方法的结果相近且在同一数量级内。因此，作者认为不再需要使用原生实现来计算文件校验和。

一个Dart实现可以如下所示：

Future<String?> getFileChecksum(String filePath) async {
  final file = File(filePath);
  if (!file.existsSync()) return null;
  try {
    final stream = file.openRead();
    final hash = await md5.bind(stream).first;
    // 注意：您可能不需要将其转换为base64
    return base64.encode(hash.bytes);
  } catch (exception) {
    return null;
  }
}

md5_file_checksum

md5_file_checksum 是一个用于计算文件的MD5哈希校验和的Flutter插件，它使用平台原生实现。

它是 md5_plugin 的改进版本。

Usage

要使用此插件，您可以按照以下步骤操作：

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

   dependencies:
     md5_file_checksum: ^latest_version # 替换为最新版本号
   

2. 然后在您的Dart代码中导入包并调用 getFileChecksum 方法：

   import 'package:md5_file_checksum/md5_file_checksum.dart';
   
   try {
     final fileChecksum = await Md5FileChecksum.getFileChecksum(filePath: "your_file_path");
     print('File checksum: $fileChecksum');
   } catch (exception) {
     print('Unable to generate file checksum: $exception');
   }
   

Result

Support this project

如果您觉得这个项目对您有帮助，可以通过 Buy Me A Coffee 支持作者。

Other projects

查看作者的所有项目：All my projects

Credits

创建者：@albemala (Twitter)

示例代码

下面是一个完整的示例demo，展示了如何使用 md5_file_checksum 插件来计算文件的MD5校验和，并将其显示在一个简单的Flutter应用中。

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:md5_file_checksum/md5_file_checksum.dart';
// 假设Assets.file1是你的资源文件路径，这里为了简化示例，直接使用字符串表示
// 实际使用时，应根据实际情况调整这部分代码

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> {
  String _fileChecksum = "---";

  @override
  void initState() {
    super.initState();
    _init();
  }

  Future<void> _init() async {
    try {
      // 这里假设copyAssetFileToTempDirectory是一个自定义函数，用于将资源文件复制到临时目录
      // 并返回临时文件路径。实际使用时，请根据需要替换或实现该功能。
      final tempFilePath = "path_to_your_temp_file"; // 替换成实际的文件路径
      final fileChecksum = await Md5FileChecksum.getFileChecksum(filePath: tempFilePath) ?? "---";

      if (!mounted) return;
      setState(() {
        _fileChecksum = fileChecksum;
      });
    } catch (_) {}
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Text('File checksum: $_fileChecksum'),
        ),
      ),
    );
  }
}

请注意，上述代码中的 copyAssetFileToTempDirectory 和 "path_to_your_temp_file" 需要根据实际情况进行调整。如果您正在处理的是资产文件（assets），请确保正确设置 pubspec.yaml 中的资源路径，并实现一个函数将这些资源文件复制到应用程序可以访问的位置。