Laravel-PDF 使用教程

1、项目介绍

Laravel-PDF 是一个用于在 Laravel 应用中创建 PDF 文件的开源包。它通过 Chromium（通过 Browsershot）生成 PDF 文件，提供了简单易用的接口来创建和管理 PDF 文件。

2、项目快速启动

安装

首先，在你的 Laravel 项目中安装 Laravel-PDF 包：

composer require spatie/laravel-pdf

配置

安装完成后，发布配置文件：

php artisan vendor:publish --provider="Spatie\LaravelPdf\PdfServiceProvider" --tag="config"

使用示例

创建一个 Blade 视图文件 resources/views/pdfs/invoice.blade.php，并在其中编写 PDF 内容。

然后，在你的控制器中使用以下代码生成 PDF：

use Spatie\LaravelPdf\Facades\Pdf;

class DownloadInvoiceController extends Controller
{
    public function __invoke(Invoice $invoice)
    {
        return Pdf::view('pdfs.invoice', ['invoice' => $invoice])
                  ->format('a4')
                  ->name('your-invoice.pdf')
                  ->download();
    }
}

3、应用案例和最佳实践

应用案例

• 生成发票：使用 Laravel-PDF 生成电子发票，并提供下载功能。
• 报告生成：动态生成各种报告，并以 PDF 格式提供给用户。

最佳实践

• 使用 Blade 视图：利用 Blade 模板引擎编写 PDF 内容，便于维护和样式调整。
• 格式化 PDF：使用 format 方法设置 PDF 页面格式，如 A4、Letter 等。
• 命名文件：使用 name 方法为生成的 PDF 文件命名，便于用户识别。

4、典型生态项目

• Browsershot：Laravel-PDF 底层依赖 Browsershot 包，用于通过 Chromium 生成 PDF。
• Dompdf：另一个流行的 Laravel PDF 生成包，适用于需要更多自定义和控制的情况。

通过以上步骤和示例，你可以快速上手并在 Laravel 应用中使用 Laravel-PDF 包生成 PDF 文件。