Flutter PDF处理插件pdf_handler的使用

Flutter PDF处理插件pdf_handler的使用

特性

  • 选择PDF文件
  • 查看PDF文件
  • 压缩PDF文件

开始使用

我们使用了多个包来执行所需的操作。


使用方法

该插件可以用于上传、查看和压缩PDF文件。

选择PDF文件

File pdfFile = await pdfHandler.selectPdf();

查看PDF

Navigator.push(
  context,
  MaterialPageRoute(
    builder: (context) => PdfPreviewScreen(
      pdfFilePath: compressedPdfFile!.path,
    ),
  ),
);

压缩PDF

compressedPdfFile = await pdfHandler.compressPdf(pdfFile!, 100 * 1024);

完整示例代码

以下是一个完整的示例代码,展示如何使用pdf_handler插件实现PDF文件的选择、压缩和预览功能。

文件路径:example/lib/main.dart

import 'dart:io';

import 'package:flutter/material.dart';
import 'package:pdf_handler/pdf_handler.dart';
import 'package:pdf_handler/pdf_preview.dart'; // 引入预览页面组件

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'PDF Handler Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  PDFHandler pdfHandler = PDFHandler(); // 初始化PDFHandler实例

  bool isProcessing = false; // 控制加载状态
  File? pdfFile; // 保存选择的PDF文件
  File? compressedPdfFile; // 保存压缩后的PDF文件

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text('PDF Handler'), // 设置标题
      ),
      body: Container(
        padding: const EdgeInsets.all(24), // 设置内边距
        alignment: Alignment.center, // 居中对齐
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center, // 主轴居中
          crossAxisAlignment: CrossAxisAlignment.center, // 次轴居中
          children: [
            // 如果选择了PDF文件,则显示文件路径
            if (pdfFile != null) ...[
              Text('Original File path - \n${pdfFile?.path}'), // 显示原文件路径
              const SizedBox(height: 16), // 添加间距
              ElevatedButton(
                onPressed: () async { // 压缩按钮点击事件
                  try {
                    isProcessing = true; // 设置为加载状态
                    setState(() {}); // 更新UI
                    compressedPdfFile = await pdfHandler.compressPdf(
                      pdfFile!,
                      100 * 1024, // 目标压缩大小(单位:字节)
                    );
                    isProcessing = false; // 压缩完成,恢复非加载状态
                    setState(() {}); // 更新UI
                  } catch (exp) {
                    debugPrint('exp - $exp'); // 打印异常信息
                  }
                },
                child: isProcessing // 根据加载状态显示按钮文本或加载指示器
                    ? const SizedBox(
                        height: 16,
                        width: 16,
                        child: CircularProgressIndicator(strokeWidth: 2),
                      )
                    : const Text('Compress PDF'),
              ),
              ElevatedButton(
                onPressed: () {
                  // 跳转到原文件预览页面
                  Navigator.push(
                    context,
                    MaterialPageRoute(
                      builder: (context) => PdfPreviewScreen(
                        pdfFilePath: pdfFile!.path, // 传递原文件路径
                      ),
                    ),
                  );
                },
                child: const Text('View original PDF'),
              ),
            ],
            // 如果压缩后的PDF文件存在,则显示压缩后文件的预览按钮
            if (compressedPdfFile != null) ...[
              ElevatedButton(
                onPressed: () {
                  // 跳转到压缩后文件的预览页面
                  Navigator.push(
                    context,
                    MaterialPageRoute(
                      builder: (context) => PdfPreviewScreen(
                        pdfFilePath: compressedPdfFile!.path, // 传递压缩后文件路径
                      ),
                    ),
                  );
                },
                child: const Text('View compressed PDF'),
              ),
            ],
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () async {
          // 点击浮动按钮选择PDF文件
          pdfFile = await pdfHandler.selectPdf();
          setState(() {}); // 更新UI
        },
        tooltip: 'Upload Pdf', // 提示文字
        child: const Icon(Icons.upload_file), // 图标
      ),
    );
  }
}

更多关于Flutter PDF处理插件pdf_handler的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter PDF处理插件pdf_handler的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


pdf_handler 是一个用于在 Flutter 应用中处理 PDF 文件的插件。它提供了多种功能,如读取 PDF 文件、提取文本、添加注释、合并 PDF 文件等。以下是如何在 Flutter 项目中使用 pdf_handler 插件的基本步骤和示例代码。

1. 添加依赖

首先,在 pubspec.yaml 文件中添加 pdf_handler 插件的依赖:

dependencies:
  flutter:
    sdk: flutter
  pdf_handler: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

2. 导入插件

在你的 Dart 文件中导入 pdf_handler 插件:

import 'package:pdf_handler/pdf_handler.dart';

3. 基本用法

3.1 读取 PDF 文件

你可以使用 PdfHandler 来读取 PDF 文件,并提取其中的文本内容。

void readPdf() async {
  PdfHandler pdfHandler = PdfHandler();

  // 加载 PDF 文件
  final pdfFile = await pdfHandler.loadPdf('assets/example.pdf');

  // 提取文本
  final text = await pdfHandler.extractText(pdfFile);
  
  print('Extracted Text: $text');
}

3.2 合并 PDF 文件

pdf_handler 还支持将多个 PDF 文件合并为一个。

void mergePdfs() async {
  PdfHandler pdfHandler = PdfHandler();

  // 加载多个 PDF 文件
  final pdfFile1 = await pdfHandler.loadPdf('assets/example1.pdf');
  final pdfFile2 = await pdfHandler.loadPdf('assets/example2.pdf');

  // 合并 PDF 文件
  final mergedPdf = await pdfHandler.mergePdfs([pdfFile1, pdfFile2]);

  // 保存合并后的 PDF 文件
  await pdfHandler.savePdf(mergedPdf, 'merged.pdf');
}

3.3 添加注释

你可以在 PDF 文件中添加注释或标记。

void addAnnotation() async {
  PdfHandler pdfHandler = PdfHandler();

  // 加载 PDF 文件
  final pdfFile = await pdfHandler.loadPdf('assets/example.pdf');

  // 添加注释
  final annotatedPdf = await pdfHandler.addAnnotation(pdfFile, 'This is a note', position: const Offset(100, 100));

  // 保存带有注释的 PDF 文件
  await pdfHandler.savePdf(annotatedPdf, 'annotated.pdf');
}

4. 处理权限

在某些情况下,你可能需要访问设备的文件系统来加载或保存 PDF 文件。确保在 AndroidManifest.xmlInfo.plist 中配置了必要的权限。

Android

AndroidManifest.xml 中添加以下权限:

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

iOS

Info.plist 中添加以下权限:

<key>NSDocumentsFolderUsageDescription</key>
<string>We need access to save PDF files.</string>

5. 错误处理

在处理 PDF 文件时,可能会遇到各种错误,如文件不存在、格式不支持等。确保在代码中适当地处理这些错误。

void handleError() async {
  PdfHandler pdfHandler = PdfHandler();

  try {
    final pdfFile = await pdfHandler.loadPdf('assets/non_existent.pdf');
    final text = await pdfHandler.extractText(pdfFile);
    print('Extracted Text: $text');
  } catch (e) {
    print('Error: $e');
  }
}
回到顶部