使用 laravel-dompdf 在 Laravel 中生成 PDF 文档
1. 项目介绍
laravel-dompdf 是一个 Laravel 包裹器,用于集成 DomPDF —— 一个 PHP 库,允许您将 HTML 内容转换为 PDF 文件。这个包简化了在 Laravel 应用程序中生成 PDF 的流程,提供了一系列定制选项以满足不同需求,如创建发票、报告或其他任何需要 PDF 输出的场景。
2. 项目快速启动
安装 Laravel 项目(如果你还没有)
composer create-project --prefer-dist laravel/laravel dompdf-project
cd dompdf-project
添加 laravel-dompdf 包
composer require barryvdh/laravel-dompdf
配置服务提供者和服务别名
在 config/app.php 文件中的 providers 数组里添加:
Barryvdh\DomPDF\ServiceProvider::class,
然后,在同文件的 aliases 数组里添加:
'PDF' => Barryvdh\DomPDF\Facade::class,
创建 PDF 控制器示例
php artisan make:controller PDFController
打开生成的控制器文件,例如 app/Http/Controllers/PDFController.php,并添加以下方法:
use Illuminate\Support\Facades\App;
use Barryvdh\DomPDF\Facade as PDF;
public function generatePDF()
{
$data = ['title' => 'Welcome to PDF Generation', 'content' => 'This is an example PDF generated with DomPDF and Laravel.'];
$pdf = PDF::loadView('pdf.view', $data);
return $pdf->stream();
}
创建视图文件,例如 resources/views/pdf/view.blade.php,填写 HTML 内容:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>{{ $title }}</title>
</head>
<body>
{{ $content }}
</body>
</html>
更新路由
在 routes/web.php 文件中定义路由:
Route::get('/generate-pdf', [PDFController::class, 'generatePDF']);
运行开发服务器
php artisan serve
现在访问 http://localhost:8000/generate-pdf ,浏览器将会流式传输生成的 PDF 文件。
3. 应用案例与最佳实践
- 模板设计:使用 Blade 模板创建复杂的 PDF 页面布局。
- 数据绑定:从数据库或其他数据源动态填充 PDF 内容。
- 自定义样式:通过 CSS 样式表控制 PDF 的外观。
- 字体管理:确保 PDF 正确显示特殊字体或图标库(如 FontAwesome)。
- 下载与邮件发送:将生成的 PDF 下载到本地或作为附件发送电子邮件。
4. 典型生态项目
- Mpdf:另一个流行的 PHP PDF 类库,支持 Unicode 和 UTF-8 字符集。
- TCPDF:提供了丰富的功能,包括 PDF/A 及 PDF/X 认证。
- Snappy:基于 WKHTMLtoPDF,用于将 HTML 转换成 PDF 或图片。
以上是 laravel-dompdf 的基本介绍及使用指南。通过结合这些工具和最佳实践,你可以灵活地构建出适应各种业务需求的 PDF 功能。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



