Flutter PDF合并插件pdf_combiner的使用

PDF Combiner

这是一个用于合并和操作PDF文件的Flutter插件。它支持Android和iOS平台，允许合并多个PDF文件、从图像创建PDF以及从PDF中提取图像。

功能特性

合并多个PDF

将多个PDF文件合并为一个文档。

必需参数：

• inputPaths: 代表要合并的PDF文件路径的字符串列表。
• outputPath: 代表保存合并后的PDF文件目录的字符串。

MergeMultiplePDFResponse response = await PdfCombiner.mergeMultiplePDFs(
  inputPaths: filesPath, 
  outputPath: outputDirPath,
);

if (response.status == PdfCombinerStatus.success) {
  // response.response 包含输出路径作为String
  // response.message 包含成功消息作为String
}

从多张图片创建PDF

将一系列图像文件转换为单个PDF文档。

必需参数：

• inputPaths: 表示图像文件路径的字符串列表。
• outputPath: 表示生成的PDF应保存在哪个目录下的字符串。

可选参数：

• maxWidth（默认值：360）：压缩图像的最大宽度。
• maxHeight（默认值：360）：压缩图像的最大高度。
• needImageCompressor（默认值：true）：是否压缩图像。

PdfFromMultipleImageResponse response = await PdfCombiner.createPDFFromMultipleImages(
  inputPaths: imagePaths,
  outputPath: outputPath,
  maxWidth: 480, // 可选
  maxHeight: 640, // 可选
  needImageCompressor: false, // 可选
);

if (response.status == PdfCombinerStatus.success) {
  // response.response 包含输出路径作为String
  // response.message 包含成功消息作为String
}

从PDF创建图片

从PDF文件中提取图片。

必需参数：

• inputPath: 表示要从中提取图片的PDF文件路径的字符串。
• outputPath: 表示提取的图片应该保存在哪个目录下的字符串。

可选参数：

• maxWidth（默认值：360）：提取图像的最大宽度。
• maxHeight（默认值：360）：提取图像的最大高度。
• createOneImage（默认值：true）：是否创建一个来自PDF的单一合成图像。

ImageFromPDFResponse response = await PdfCombiner.createImageFromPDF(
  inputPath: pdfFilePath, 
  outputPath: outputPath,
  maxWidth: 720, // 可选
  maxHeight: 1080, // 可选
  createOneImage: false, // 可选
);

if (response.status == PdfCombinerStatus.success) {
  // response.response 包含输出路径列表作为List<String>
  // response.message 包含成功消息作为String
}

使用说明

此插件与file_picker或image_picker一起使用以选择文件。确保在调用插件之前使用permission_handler处理权限。

依赖项

• file_picker
• image_picker
• permission_handler

支持平台

该插件支持Android和iOS平台。

注意事项

无需额外配置Android或iOS。请确保添加了必要的文件选择和权限处理依赖项到您的项目中。

示例代码

以下是使用pdf_combiner插件的一个完整示例demo：

import 'package:flutter/material.dart';
import 'package:pdf_combiner_example/views/pdf_combiner_screen.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'PDF Combiner Example',
      home: PdfCombinerScreen(),
    );
  }
}

// 假设这是PdfCombinerScreen类的一部分，用于展示如何使用插件功能
class PdfCombinerScreen extends StatefulWidget {
  const PdfCombinerScreen({super.key});

  @override
  State<PdfCombinerScreen> createState() => _PdfCombinerScreenState();
}

class _PdfCombinerScreenState extends State<PdfCombinerScreen> {
  final List<String> _filesPath = []; // 存储选择的PDF文件路径
  final String _outputDirPath = ''; // 输出目录路径

  Future<void> _mergePdfs() async {
    try {
      MergeMultiplePDFResponse response = await PdfCombiner.mergeMultiplePDFs(
        inputPaths: _filesPath, 
        outputPath: _outputDirPath,
      );

      if (response.status == PdfCombinerStatus.success) {
        // 处理成功逻辑
      } else {
        // 处理失败逻辑
      }
    } catch (e) {
      // 错误处理
    }
  }

  // 其他方法如从图片创建PDF、从PDF创建图片等可以类似实现

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('PDF Combiner Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: _mergePdfs,
          child: const Text('Merge PDFs'),
        ),
      ),
    );
  }
}

在这个示例中，我们创建了一个简单的Flutter应用程序，其中包含一个按钮，当用户点击时会触发合并PDF的操作。你可以根据需要扩展这个例子来实现其他功能。