laravel 和 dompdf:使用图像和 css 生成 pdf 文档的分步指南
创建 pdf 文档是 web 应用程序中的常见需求,尤其是生成发票、收据、证书、票据和各种报告。在这个综合教程中,我们将深入研究如何使用 laravel 和 dompdf 生成带有图像和 css 的 pdf 文档。我们将介绍配置选项、设计注意事项、输出大小、性能和数据库查询。此外,我们还将讨论处理分页符、使用 base64 加载图像等的提示和技巧。
先决条件
在我们开始之前,请确保您已安装以下软件:
- php >=8.2
- 作曲家2+
- laravel 10+
介绍
dompdf 是一个流行的 php 库,允许您从 html 内容生成 pdf 文档。它支持 css 样式、图像和各种配置选项。通过将 dompdf 与 laravel 集成,您可以使用 blade 模板和 laravel 的强大功能轻松创建复杂的 pdf 文档。
其他流行的 pdf 库包括 tcpdf、fpdf 和 snappy。
然而,dompdf 由于其易于集成和强大的功能集而被广泛使用。
在本教程中,我们将逐步介绍设置 laravel 项目、配置 dompdf、创建处理 pdf 生成的控制器、为 pdf 内容设计 blade 模板、添加路由和优化性能的过程。我们还将讨论高级配置选项,并提供生成高质量 pdf 文档的提示和技巧。
假设
本教程假设您对 laravel 和 php 有基本的了解。如果您是 laravel 新手,请考虑阅读官方 laravel 文档来熟悉该框架。否则,您可以按照 laravel bootcamp 开始使用 laravel。
第 1 步:设置 laravel 项目
首先,如果你还没有 laravel 项目,请创建一个新的 laravel 项目,或者使用现有的项目,当然,如果你已经有 laravel 项目,你可以跳过这一步。
<a style="color:#f60; text-decoration:underline;" href="https://www.codesou.cn/" target="_blank">composer</a> create-project --prefer-dist laravel/laravel pdf-tutorial cd pdf-tutorial
接下来,安装dompdf:
composer require barryvdh/laravel-dompdf
发布配置文件:
php artisan vendor:publish --provider="barryvdhdompdfserviceprovider"
第2步:配置dompdf
打开config/dompdf.php 文件。配置文件包含用于自定义 pdf 输出的各种选项。在这里您可以设置各种选项,包括默认纸张尺寸、方向、字体等。
- 纸张尺寸: 您可以设置默认纸张尺寸。
'default_paper_size' => 'a4',
- 方向: 设置默认方向(纵向或横向)。
'orientation' => 'portrait',
- 字体: 您可以指定默认字体并添加自定义字体。
'default_font' => 'serif',
第三步:创建控制器
创建一个控制器来处理 pdf 生成:
php artisan make:controller pdfcontroller
在 app/http/controllers/pdfcontroller.php 中,添加以下代码:
<?php namespace apphttpcontrollers; use illuminatehttprequest; use pdf; class pdfcontroller extends controller { public function generatepdf() { $data = [ 'title' => 'laravel pdf example', 'date' => date('m/d/y'), ]; $pdf = pdf::loadview('mypdf', $data); return $pdf->download('document.pdf'); } }
第 4 步:创建刀片模板
为 pdf 内容创建 blade 模板:
touch resources/views/mypdf.blade.php
在 mypdf.blade.php 中添加以下内容:
<title>laravel pdf example</title><style> body { font-family: 'arial, sans-serif'; } .container { margin: 0 auto; padding: 20px; } .header { text-align: center; margin-bottom: 20px; } .content { font-size: 12px; } </style><div class="container"> <div class="header"> <h1>{{ $title }}</h1> <p>date: {{ $date }}</p> </div> <div class="content"> <p>this is an example of a pdf document generated using laravel and dompdf.</p> </div> </div>
第5步:添加路由
在routes/web.php中添加处理pdf生成的路由:
use apphttpcontrollerspdfcontroller; route::get('generate-pdf', [pdfcontroller::class, 'generatepdf']);
第 6 步:添加图像
您可以通过将图像嵌入为 base64 编码字符串或使用 url 来将图像添加到 pdf。
图像可以使用base64编码直接嵌入到blade模板中。例如,要嵌入来自公共/图像的图像,您可以这样做:
<img src="data:image/png;base64,%7B%7B%20base64_encode(file_get_contents(public_path('images/logo.png')))%20%7D%7D" alt="logo">
或直接从网址:
<img src="%7B%7B%20asset('images/logo.png')%20%7D%7D" alt="logo">
第 7 步:优化性能
数据库查询
处理大型数据集(例如 1,000 多条记录)时,使用分页或分块来管理内存使用:
$data = db::table('users')->paginate(50); $pdf = pdf::loadview('mypdf', ['data' => $data]);
输出尺寸
为了减少输出大小,请尽量减少使用大量图像,并尽可能选择矢量图形。另外,使用高效的 css。
分页符
确保内容结构良好,适合分页。使用 css 处理分页符:
.page-break { page-break-after: always; }
在你的 blade 模板中:
<div class="page-break"></div>
步骤8:高级配置
更高级的配置请参考dompdf文档。您可以自定义几乎所有内容,从边距到字体加载方式。
使用自定义字体
要使用自定义字体,首先将它们添加到您的项目中并配置 dompdf 以使用它们:
'custom_font_dir' => base_path('resources/fonts/'), 'custom_font_data' => [ 'custom-font' => [ 'r' => 'customfont-regular.ttf', 'b' => 'customfont-bold.ttf', ] ],
在您的 blade 模板中:
<style> body { font-family: 'custom-font', sans-serif; } </style>
结论
按照此分步指南,您可以使用 laravel 和 dompdf 生成复杂的 pdf 文档,并包含图像和 css 样式。本教程涵盖了基本的配置选项、设计注意事项、性能优化。您可以扩展此基础,为您的 laravel 应用程序构建强大的文档生成系统。
潜在系列和存储库
本教程是使用 laravel 生成 pdf 系列的一部分。可以在此处找到包含各种文档模板(发票、收据、证书、票据等)的完整存储库。请随意贡献并扩大收藏。
快乐编码!