Flutter文件大小格式化插件proper_filesize的使用

描述

proper_filesize 是一个自包含的Dart库，用于在字节和人类可读的文件大小之间无缝转换。它能够轻松地将原始字节值转换为人类可读的文件大小（如 “1.2 KB” 或 “3.5 MB”），反之亦然。这对于在用户界面中显示文件大小、处理文件上传、处理数据存储信息等非常理想。支持二进制（KiB, MiB, GiB）和公制（KB, MB, GB）单位。

特性

• 将字节转换为人类可读的字符串（例如，1024 bytes 转换为 "1 KiB"）。
• 将人类可读的字符串转换为字节（例如，"1.2 GB" 转换为 1200000000 bytes）。
• 支持二进制和公制单位（KB, KiB, MB, MiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB 等）。
• 可定制的小数精度。
• 支持短格式和长格式类型（例如，“KB” 对比 “kilobyte”）。

安装

将 proper_filesize 添加为项目的依赖项。可以通过以下命令轻松完成：

dart pub add proper_filesize

或者手动添加到项目的 pubspec.yaml 文件中：

dependencies:
  proper_filesize: ^1.0.2

然后运行：

dart pub get

使用方法

首先，导入库：

import 'package:proper_filesize/proper_filesize.dart';

解析文件大小字符串为数值

将人类可读的文件大小字符串（如 “1.2 KB”, “3.5 MB”, “1.5 GiB”）转换为其对应的字节数值。

import 'package:proper_filesize/proper_filesize.dart';

void main() {
  String metricFilesize = "1.2 EB";
  int metricBytes = FileSize.parse(metricFilesize).size.toInt();
  print("$metricFilesize is $metricBytes bytes");
  // 输出：1.2 EB is 1200000000000000000 bytes

  String binaryFilesize = "1.2 EiB";
  int binaryBytes = FileSize.parse(binaryFilesize).size.toInt();
  print("$binaryFilesize is $binaryBytes bytes");
  // 输出：1.2 EiB is 1383505805528216320 bytes

  String longFormatFilesize = "1.45 gibibytes";
  int longFormatBytes = FileSize.parse(longFormatFilesize).size.toInt();
  print("$longFormatFilesize is $longFormatBytes bytes");
  // 输出：1.45 gibibytes is 1556488978432 bytes
}

将数值转换为文件大小字符串

将字节数值转换为人类可读的文件大小字符串。

import 'package:proper_filesize/proper_filesize.dart';

void main() {
  int bytes = 1243560000;

  // 使用公制单位 (KB, MB, GB)
  String metricFilesize = FileSize.fromBytes(bytes).toString(
    unit: Unit.auto(size: bytes, baseType: BaseType.metric),
  );
  print("$bytes bytes is $metricFilesize"); 
  // 输出：1243560000 bytes is 1.244 GB

  // 使用二进制单位 (KiB, MiB, GiB)
  String binaryFilesize = FileSize.fromBytes(bytes).toString();
  print("$bytes bytes is $binaryFilesize"); 
  // 输出：1243560000 bytes is 1.158 GiB
}

更多示例

自定义小数精度

控制输出中的小数位数。

import 'package:proper_filesize/proper_filesize.dart';

void main() {
  final int bytes = 1243560000;
  
  // 生成带有2位小数的二进制单位字符串
  final String binaryFilesize2Decimals =
      FileSize.fromBytes(bytes).toString(decimals: 2);
  print(
    "$bytes bytes is $binaryFilesize2Decimals",
  ); // 输出：1243560000 bytes is 1.16 GiB
}

使用长格式类型

以完整形式显示单位（例如，“kilobyte”而不是“KB”）。

import 'package:proper_filesize/proper_filesize.dart';

void main() {
  final int bytes = 1243560000;

  // 生成带有完整单位名称（“gigabyte”）的公制单位字符串
  final String metricFilesizeLong = FileSize.fromBytes(bytes).toString(
    unit: Unit.auto(size: bytes, baseType: BaseType.metric),
    formatType: FormatType.long,
  );
  print(
    "$bytes bytes is $metricFilesizeLong",
  ); // 输出：1243560000 bytes is 1.244 gigabytes

  // 生成带有完整单位名称（“gibibyte”）的二进制单位字符串
  final String binaryFilesizeLong = FileSize.fromBytes(bytes).toString(
    unit: Unit.auto(size: bytes, baseType: BaseType.binary),
    formatType: FormatType.long,
  );
  print(
    "$bytes bytes is $binaryFilesizeLong",
  ); // 输出：1243560000 bytes is 1.158 gibibytes
}

显式指定单位

直接转换不同的单位。

import 'package:proper_filesize/proper_filesize.dart';

void main() {
  const num terabyteSize = 20.59;
  final String explicitUnitConversionStr =
      FileSize.fromUnit(size: terabyteSize, unit: Unit.terabyte)
          .toString(unit: Unit.gibibyte);
  print(
    "$terabyteSize terabytes is $explicitUnitConversionStr",
  ); // 输出：20.59 terabytes is 19175.932 GiB

  const num gigabytesize = 401.26;
  final num explicitUnitConversion =
      FileSize.fromUnit(size: gigabytesize, unit: Unit.gigabyte)
          .toSize(unit: Unit.mebibyte);
  print(
    "$gigabytesize gigabytes is $explicitUnitConversion mebibytes",
  ); // 输出：401.26 gigabytes is 382671.3562011719 mebibytes
}

API文档

有关所有类和方法的详细信息，请参阅 API文档。

贡献

欢迎贡献！无论是提交错误报告、功能请求还是代码贡献，请随时在 GitHub 上提出问题或提交拉取请求。