Flutter图片压缩插件simple_native_image_compress的使用

简介

simple_native_image_compress 是一个基于 Rust 编写的简单原生图片压缩库，适用于 Flutter。它利用了 flutter_rust_bridge、image、cargokit、exif-rs 和 anyhow。

为什么选择这个插件？

1. Dart 中的图片压缩速度较慢，即使使用 isolate。
2. 其他原生库不支持 Windows 和 Linux 的图片压缩。

功能概述

• 如果提供了一个图片文件路径，它会调整大小并返回 Jpeg/WebP 图片作为 Uint8List。
• 不支持 Web 端（WASM），因为开发者使用 Angular 而非 Flutter 开发 Web 应用。

支持的输出格式

• Jpeg
• WebP（仅无损）
• AVIF（仅有损，可设置压缩速度）

采样滤波器类型

• Nearest：最近邻
• Triangle：线性滤波（默认）
• CatmullRom：三次滤波
• Gaussian：高斯滤波
• Lanczos3：Lanczos 滤波，窗口为 3

更多关于采样滤波器的信息可以参考 image crate doc。

示例代码

以下是一个完整的示例应用，展示了如何使用 simple_native_image_compress 插件进行图片压缩和保存。

import 'dart:io';
import 'package:flutter/material.dart';
import 'package:simple_native_image_compress/simple_native_image_compress.dart';
import 'package:image_picker/image_picker.dart';
import 'package:file_picker/file_picker.dart';
import 'package:flutter_avif/flutter_avif.dart';

Future<void> main() async {
  await NativeImageCompress.init();
  runApp(const MaterialApp(home: MyApp()));
}

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  Duration _duration = const Duration();
  final _picker = ImagePicker();
  Uint8List? _bytes;
  final _compressFormat = CompressFormat.avif;

  Future<void> _compressImage() async {
    String filePath = '';
    if (Platform.isMacOS) {
      final res = await FilePicker.platform.pickFiles(type: FileType.image, allowMultiple: false);
      if (res == null || res.files.isEmpty) return;
      filePath = res.files[0].path!;
    } else {
      final file = await _picker.pickImage(source: ImageSource.gallery);
      if (file == null) return;
      filePath = file.path;
    }
    try {
      final startTime = DateTime.now();
      final bytes = await ImageCompress.contain(
        filePath: filePath,
        compressFormat: _compressFormat,
        samplingFilter: FilterType.lanczos3,
      );
      final endTime = DateTime.now();
      setState(() {
        _bytes = bytes;
        _duration = endTime.difference(startTime);
      });
    } catch (e) {
      if (!mounted) return;
      showDialog<void>(
        context: context,
        builder: (_) => AlertDialog(
          title: const Text('Error Occured', style: TextStyle(color: Colors.red)),
          content: Text(e.toString()),
          actions: [
            Center(
              child: TextButton(
                style: TextButton.styleFrom(foregroundColor: Colors.white, backgroundColor: Colors.blue),
                onPressed: Navigator.of(context).pop,
                child: const Text('Ok'),
              ),
            ),
          ],
        ),
      );
    }
  }

  Future<void> _saveImage() async {
    if (Platform.isMacOS) return;
    String? outputFilePath = await FilePicker.platform.saveFile(dialogTitle: 'Please select an output file location', type: FileType.image);
    if (outputFilePath == null) return;
    final tempFile = File(outputFilePath);
    await tempFile.create(recursive: true);
    RandomAccessFile raf = tempFile.openSync(mode: FileMode.write);
    try {
      raf.writeFromSync(_bytes!);
    } catch (e) {
      rethrow;
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Plugin example app')),
      body: SafeArea(
        child: Column(
          children: [
            const SizedBox(height: 20),
            ElevatedButton(onPressed: _compressImage, child: const Text('Choose an image')),
            const SizedBox(height: 20),
            Text('(${kDebugMode ? 'DEBUG' : 'RELEASE'}) mode time taken: ${_duration.inMilliseconds} ms'),
            const SizedBox(height: 10),
            Expanded(
              child: _bytes != null
                  ? InkWell(
                      onSecondaryTap: _saveImage,
                      child: _compressFormat == CompressFormat.avif
                          ? AvifImage.memory(_bytes!, fit: BoxFit.contain)
                          : Image.memory(_bytes!))
                  : Container(),
            ),
          ],
        ),
      ),
    );
  }
}

默认值

• 宽度和高度的默认值是 1024 px
• Jpeg/AVIF 质量的默认值是 80（WebP 质量无效）
• 采样滤波器的默认值是 FilterType.Triangle
• AVIF 压缩速度的默认值是 10

通过以上内容，您可以快速上手使用 simple_native_image_compress 插件进行图片压缩，并根据需要调整参数以满足您的需求。