Flutter PDF处理插件pdfrx的使用

pdfrx 是一个基于 PDFium 构建的丰富且快速的PDF查看器实现。该插件支持 Android、iOS、Windows、macOS、Linux 和 Web 平台。

交互式演示

你可以通过以下链接访问使用 Flutter Web 构建的 演示站点。

多平台支持

• Android
• iOS
• Windows
• macOS
• Linux (甚至 Raspberry PI)
• Web (*使用 PDF.js)

示例代码

下面的代码片段展示了如何在Flutter中显示资源文件夹中的PDF文件：

import 'package:flutter/material.dart';
import 'package:pdfrx/pdfrx.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Pdfrx example',
      home: MainPage(),
    );
  }
}

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

  @override
  State<MainPage> createState() => _MainPageState();
}

class _MainPageState extends State<MainPage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        leading: IconButton(
          icon: const Icon(Icons.menu),
          onPressed: () {
            // Toggle left pane visibility
          },
        ),
        title: const Text('Pdfrx example'),
      ),
      body: PdfViewer.asset(
        'assets/hello.pdf', // 确保在 pubspec.yaml 中添加了 assets/hello.pdf
      ),
    );
  }
}

完整示例

以下是一个更完整的示例，包括密码保护的PDF文件处理：

import 'package:flutter/material.dart';
import 'package:pdfrx/pdfrx.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Pdfrx example',
      home: MainPage(),
    );
  }
}

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

  @override
  State<MainPage> createState() => _MainPageState();
}

class _MainPageState extends State<MainPage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        leading: IconButton(
          icon: const Icon(Icons.menu),
          onPressed: () {
            // Toggle left pane visibility
          },
        ),
        title: const Text('Pdfrx example'),
      ),
      body: PdfViewer.asset(
        'assets/password_protected_sample.pdf',
        passwordProvider: () => 'test', // 提供密码以打开受保护的PDF文件
      ),
    );
  }
}

开始使用

安装

在你的 pubspec.yaml 文件中添加以下依赖项并执行 flutter pub get：

dependencies:
  pdfrx: ^1.0.101

Windows注意事项

确保你的Windows安装启用了开发者模式。构建过程内部使用符号链接，这需要启用开发者模式。如果没有启用，你可能会遇到类似此问题的错误。

打开PDF文件

PdfViewer 支持以下方法来打开PDF文件：

• PdfViewer.asset: 打开Flutter资源中的PDF文件。
• PdfViewer.file: 从文件系统打开PDF文件（macOS可能被App Sandbox阻止）。
• PdfViewer.uri: 从URI（如 https://... 或相对路径）打开PDF文件（Web和macOS可能被CORS或App Sandbox阻止）。

处理受密码保护的PDF文件

PdfViewer.asset(
  'assets/test.pdf',
  passwordProvider: () => 'password',
)

更多自定义和注意事项，请参阅使用PasswordProvider处理受密码保护的PDF文件。

自定义功能

你可以通过配置 PdfViewerParams 来自定义行为和查看器的外观。

文本选择

启用文本选择功能：

PdfViewer.asset(
  'assets/test.pdf',
  params: PdfViewerParams(
    enableTextSelection: true,
  ),
)

更多文本选择自定义，请参阅文本选择。

其他功能支持

• PDF链接处理
• 文档大纲（书签）
• 文本搜索

查看器自定义

• 页面布局（水平滚动视图/面对页面）
• 显示滚动缩略图
• 暗夜模式支持
• 文档加载指示器
• 使用Widget Overlay进行查看器自定义

额外自定义

• 双击缩放
• 在页面底部添加页码
• 使用Widget Overlay进行每页自定义
• 使用Canvas进行每页自定义

其他小部件

PdfDocumentViewBuilder/PdfPageView

PdfPageView 是另一个仅显示单个页面的PDF小部件。它接受 PdfDocument 和页码来显示文档中的页面。

PdfDocumentViewBuilder 用于安全地管理 PdfDocument 实例，并接受一个 builder 参数来创建子小部件。

典型用法如下：

PdfDocumentViewBuilder.asset(
  'asset/test.pdf',
  builder: (context, document) => ListView.builder(
    itemCount: document?.pages.length ?? 0,
    itemBuilder: (context, index) {
      return Container(
        margin: const EdgeInsets.all(8),
        height: 240,
        child: Column(
          children: [
            SizedBox(
              height: 220,
              child: PdfPageView(
                document: document,
                pageNumber: index + 1,
                alignment: Alignment.center,
              ),
            ),
            Text(
              '${index + 1}',
            ),
          ],
        ),
      );
    },
  ),
),

PdfDocument管理

PdfDocumentViewBuilder 可以接受来自 PdfViewer 的 PdfDocumentRef 以安全地共享同一个 PdfDocument 实例。更多信息请参阅 example/viewer/lib/thumbnails_view.dart。

低级PDF API

• 易于使用的Flutter小部件：
  • PdfViewer
  • PdfDocumentViewBuilder
  • PdfPageView
• 易于使用的PDF API：
  • PdfDocument
• PDFium绑定：
  • 不推荐，但你可以导入 package:pdfrx/src/pdfium/pdfium_bindings.dart

希望这些信息能帮助你更好地理解和使用 pdfrx 插件！如果你有任何问题或需要进一步的帮助，请随时提问。