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

human_file_size 是一个强大且可定制的包，用于将文件大小转换为人类可读的形式。它提供了 humanFileSize() 函数和扩展方法 num.humanFileSize() 来简化文件大小的格式化。

使用方法

基本用法

最简单的用法如下：

import 'package:human_file_size/human_file_size.dart';

void main() {
  print(humanFileSize(0)); // 输出: 0 b
  print(humanFileSize(0.75)); // 输出: 6 b
  print(humanFileSize(8)); // 输出: 8 B
  print(humanFileSize(1000 * 1.2)); // 输出: 1.2 KB
  print(humanFileSize(1000 * 1000 * 1000 * 3)); // 输出: 3 GB

  // 使用扩展方法
  print(10.humanFileSize()); // 输出: 10 B
  print(51.22.humanFileSize()); // 输出: 51.22 B
  print(1234.humanFileSize()); // 输出: 1.234 KB
}

指定输入单位

默认情况下，humanFileSize() 将大小视为字节（inputUnit: Unit.byte）。你可以通过传递不同的值来指定其他单位：

print(humanFileSize(1000, inputUnit: Unit.bit)); // 输出: 1 Kb
print(humanFileSize(1000, inputUnit: Unit.kilobit)); // 输出: 1 Mb

自定义单位转换

默认情况下，humanFileSize() 会转换为最大的可能单位（unitConversion: const BestFitUnitConversion()）。你可以通过传递不同的值来自定义单位转换：

print(humanFileSize(
  1000,
  unitConversion: SpecificUnitConversion(unit: Unit.bit),
)); // 输出: 8000 b

自定义数量显示模式

默认情况下，humanFileSize() 使用简单的数量显示模式（quantityDisplayMode: const SimpleQuantityDisplayMode()）。你可以通过传递不同的值来自定义数量显示模式：

print(humanFileSize(
  1.234,
  quantityDisplayMode: IntlQuantityDisplayMode(
    numberFormat: NumberFormat.decimalPattern('pl'),
  ),
)); // 输出: 1,234 B

指定数值系统

你可以通过传递 numeralSystem 来指定使用二进制或十进制数值系统：

print(humanFileSize(
  1024,
  unitConversion: const BestFitUnitConversion(
    numeralSystem: BinaryNumeralSystem(),
  ),
)); // 输出: 1 KiB

自定义单位样式

默认情况下，humanFileSize() 使用短大写单位样式（unitStyle: const ShortUppercaseUnitStyle()）。你可以通过传递不同的值来自定义单位样式：

print(humanFileSize(1, inputUnit: Unit.gigabit)); // 输出: Gb
print(humanFileSize(
  1,
  inputUnit: Unit.gigabit,
  unitStyle: const ShortLowercaseUnitStyle(),
)); // 输出: gb
print(humanFileSize(
  1,
  inputUnit: Unit.gigabit,
  unitStyle: const LongLowercaseUnitStyle(),
)); // 输出: gbit
print(humanFileSize(
  1,
  inputUnit: Unit.gigabit,
  unitStyle: const LongUppercaseUnitStyle(),
)); // 输出: Gbit

自定义输出格式

你可以通过传递 outputFormatter 来自定义输出格式：

print(humanFileSize(1)); // 输出: 1 B
print(humanFileSize(
  1,
  outputFormatter: const SimpleOutputFormatter(includeSpace: false),
)); // 输出: 1B
print(humanFileSize(
  1,
  outputFormatter: const SimpleOutputFormatter(unitFirst: true),
)); // 输出: B 1

处理特殊值

human_file_size 可以处理负数、无穷大和 NaN 等特殊情况：

print(humanFileSize(1000 * -2)); // 输出: -2 KB
print(humanFileSize(double.infinity, inputUnit: Unit.gigabyte)); // 输出: ∞ GB
print(humanFileSize(double.negativeInfinity, inputUnit: Unit.kilobit)); // 输出: -∞ Kb
print(humanFileSize(double.nan, inputUnit: Unit.exabit)); // 输出: NaN Eb

文件大小比较

你还可以进行文件大小的比较：

final byteCount = BigInt.from(50);

print(byteCount >= Unit.kilobit.bytes); // 输出: false
print(byteCount >= Unit.bit.bytes); // 输出: true

完整示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 human_file_size 插件：

import 'package:flutter/material.dart';
import 'package:human_file_size/human_file_size.dart';
import 'package:intl/intl.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('human_file_size 示例'),
        ),
        body: FileSizeExample(),
      ),
    );
  }
}

class FileSizeExample extends StatelessWidget {
  final List<double> sizes = [0, 0.75, 8, 1000 * 1.2, 1000 * 1000 * 1000 * 3];

  @override
  Widget build(BuildContext context) {
    return ListView.builder(
      itemCount: sizes.length,
      itemBuilder: (context, index) {
        double size = sizes[index];
        String formattedSize = humanFileSize(size);
        String formattedSizeWithCustomUnit = humanFileSize(
          size,
          inputUnit: Unit.bit,
        );
        String formattedSizeWithCustomStyle = humanFileSize(
          size,
          unitStyle: const LongLowercaseUnitStyle(),
        );

        return ListTile(
          title: Text('原始大小: $size 字节'),
          subtitle: Column(
            crossAxisAlignment: CrossAxisAlignment.start,
            children: [
              Text('格式化大小: $formattedSize'),
              Text('自定义单位: $formattedSizeWithCustomUnit'),
              Text('自定义样式: $formattedSizeWithCustomStyle'),
            ],
          ),
        );
      },
    );
  }
}

这个示例代码创建了一个简单的 Flutter 应用，展示了如何使用 human_file_size 插件对不同大小的文件进行格式化，并显示结果。你可以根据需要进一步自定义和扩展这个示例。