Flutter文档打印插件printing的使用

Flutter的printing插件允许应用程序生成和打印文档到与Android或iOS兼容的打印机。以下是关于如何安装、配置和使用该插件的详细指南，以及一个完整的示例demo。

安装

1. 添加依赖

   在项目的pubspec.yaml文件中添加printing插件：

   dependencies:
     printing: ^5.9.3 # 请根据最新版本进行调整
     pdf: ^3.8.4      # PDF创建所需的包
   

2. 导入库

   在Dart文件中导入必要的库：

   import 'package:pdf/pdf.dart';
   import 'package:pdf/widgets.dart' as pw;
   import 'package:printing/printing.dart';
   

3. 启用Swift（仅iOS）

   修改ios/Podfile文件以支持Swift：

   target 'Runner' do
     use_frameworks!
   end
   

4. macOS应用的打印权限

   添加以下内容到macos/Runner/Release.entitlements和macos/Runner/DebugProfile.entitlements文件中：

   <key>com.apple.security.print</key>
   <true/>
   

5. Web平台设置PDF.js库

   如果需要手动指定PDF.js库版本，在web/index.html文件中添加以下脚本：

   <script>
     var dartPdfJsVersion = "3.2.146";
   </script>
   

   或者指定自定义加载路径：

   <script>
     var dartPdfJsBaseUrl = "https://cdnjs.cloudflare.com/ajax/libs/pdf.js/3.2.146/";
   </script>
   

6. Windows/Linux平台设置PDFium版本

   修改CMakeLists.txt文件中的PDFium版本和架构：

   set(PDFIUM_VERSION "4929" CACHE STRING "" FORCE)
   set(PDFIUM_ARCH "x64" CACHE STRING "" FORCE)
   

示例代码

下面是一个完整的Flutter应用程序示例，展示了如何使用printing插件来创建和预览PDF文档：

import 'dart:typed_data';

import 'package:flutter/material.dart';
import 'package:pdf/pdf.dart';
import 'package:pdf/widgets.dart' as pw;
import 'package:printing/printing.dart';

Future<void> main() async {
  runApp(const MyApp('Printing Demo'));
}

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

  final String title;

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text(title)),
        body: PdfPreview(
          build: (format) => _generatePdf(format, title),
        ),
      ),
    );
  }

  Future<Uint8List> _generatePdf(PdfPageFormat format, String title) async {
    final pdf = pw.Document(version: PdfVersion.pdf_1_5, compress: true);
    final font = await PdfGoogleFonts.nunitoExtraLight();

    pdf.addPage(
      pw.Page(
        pageFormat: format,
        build: (context) {
          return pw.Column(
            children: [
              pw.SizedBox(
                width: double.infinity,
                child: pw.FittedBox(
                  child: pw.Text(title, style: pw.TextStyle(font: font)),
                ),
              ),
              pw.SizedBox(height: 20),
              pw.Flexible(child: pw.FlutterLogo()),
            ],
          );
        },
      ),
    );

    return pdf.save();
  }
}

解释

• PdfPreview：用于预览和打印PDF文档的Widget。
• _generatePdf：生成PDF文档的方法，返回一个包含PDF数据的Uint8List。
• PdfDocument：通过pw.Document()创建一个新的PDF文档。
• PdfPage：为PDF文档添加页面，可以设置页面格式和构建页面内容。
• PdfGoogleFonts.nunitoExtraLight()：从pdf_google_fonts包中加载字体。

打印现有PDF文件

如果您想打印已经存在的PDF文件，可以使用以下代码：

final pdf = await rootBundle.load('assets/document.pdf');
await Printing.layoutPdf(onLayout: (_) => pdf.buffer.asUint8List());

分享PDF文件

您还可以将生成的PDF文件分享给其他应用程序：

await Printing.sharePdf(bytes: await doc.save(), filename: 'my-document.pdf');

HTML转PDF

要将HTML内容转换为PDF并打印，您可以使用htmltopdfwidgets包：

import 'package:htmltopdfwidgets/htmltopdfwidgets.dart';

await Printing.layoutPdf(onLayout: (PdfPageFormat format) async {
  const body = '''
    <h1>Heading Example</h1>
    <p>This is a paragraph.</p>
    <img src="image.jpg" alt="Example Image" />
    <blockquote>This is a quote.</blockquote>
    <ul>
      <li>First item</li>
      <li>Second item</li>
      <li>Third item</li>
    </ul>
  ''';

  final pdf = pw.Document();
  final widgets = await HTMLToPdf().convert(body);
  pdf.addPage(pw.MultiPage(build: (context) => widgets));
  return await pdf.save();
});

总结

通过以上步骤和示例代码，您可以轻松地在Flutter应用程序中实现文档的生成、预览和打印功能。希望这些信息对您有所帮助！如果有任何问题或需要进一步的帮助，请随时提问。