Laravel MPDF 加载多个 Blade 视图生成 PDF 文档
在实际业务开发中,我们经常会遇到需要生成 PDF 文档的需求,比如打印多份不同类型的单据、合并多个模块的内容生成完整报告等。Laravel 生态中常用的 MPDF 扩展可以很好地支持 PDF 生成,并且支持加载 Blade 视图渲染内容。本文将介绍如何在 Laravel 项目中,使用 MPDF 加载多个 Blade 视图,合并生成一份完整的 PDF 文档。
环境准备
首先确保已经安装了 Laravel 项目,并且已经通过 Composer 安装了 MPDF 扩展,安装命令如下:
composer require mpdf/mpdf
安装完成后,不需要额外的配置文件,直接在业务逻辑中实例化 MPDF 对象即可使用。
创建多个 Blade 视图
我们先创建两个不同内容的 Blade 视图,分别用于展示用户基本信息和订单详情,后续会将这两个视图的内容合并到同一个 PDF 中。
第一个视图:resources/views/pdf/user_info.blade.php,用于展示用户基本信息:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>用户基本信息</title>
<style>
.user-container {
width: 100%;
padding: 20px;
}
.user-title {
font-size: 20px;
font-weight: bold;
margin-bottom: 15px;
text-align: center;
}
.user-item {
margin: 8px 0;
font-size: 14px;
}
</style>
</head>
<body>
<div class="user-container">
<div class="user-title">用户基本信息</div>
<div class="user-item">用户ID:{{ $user['id'] }}</div>
<div class="user-item">用户名称:{{ $user['name'] }}</div>
<div class="user-item">用户手机号:{{ $user['phone'] }}</div>
<div class="user-item">注册时间:{{ $user['created_at'] }}</div>
</div>
</body>
</html>第二个视图:resources/views/pdf/order_info.blade.php,用于展示订单详情:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>订单详情</title>
<style>
.order-container {
width: 100%;
padding: 20px;
margin-top: 30px;
}
.order-title {
font-size: 20px;
font-weight: bold;
margin-bottom: 15px;
text-align: center;
}
.order-table {
width: 100%;
border-collapse: collapse;
font-size: 14px;
}
.order-table th, .order-table td {
border: 1px solid #333;
padding: 8px;
text-align: center;
}
.order-table th {
background-color: #f5f5f5;
}
</style>
</head>
<body>
<div class="order-container">
<div class="order-title">订单详情</div>
<table class="order-table">
<thead>
<tr>
<th>订单号</th>
<th>商品名称</th>
<th>数量</th>
<th>单价</th>
<th>总金额</th>
</tr>
</thead>
<tbody>
@foreach($orders as $order)
<tr>
<td>{{ $order['order_no'] }}</td>
<td>{{ $order['goods_name'] }}</td>
<td>{{ $order['num'] }}</td>
<td>{{ $order['price'] }}</td>
<td>{{ $order['total'] }}</td>
</tr>
@endforeach
</tbody>
</table>
</div>
</body>
</html>编写合并生成 PDF 的业务逻辑
接下来我们在控制器中编写逻辑,分别渲染两个 Blade 视图得到 HTML 内容,然后将这些内容合并,通过 MPDF 生成一份完整的 PDF 文档。
示例控制器方法代码如下:
<?php
namespace App\Http\Controllers;
use Mpdf\Mpdf;
class PdfController extends Controller
{
public function generateMultiViewPdf()
{
// 模拟用户数据
$user = [
'id' => 1001,
'name' => '张三',
'phone' => '13800138000',
'created_at' => '2024-01-15 10:30:00'
];
// 模拟订单数据
$orders = [
[
'order_no' => 'ORD20240301001',
'goods_name' => '无线蓝牙耳机',
'num' => 2,
'price' => 299.00,
'total' => 598.00
],
[
'order_no' => 'ORD20240301002',
'goods_name' => '手机充电器',
'num' => 1,
'price' => 89.00,
'total' => 89.00
]
];
// 渲染第一个用户视图,得到HTML内容
$userHtml = view('pdf.user_info', compact('user'))->render();
// 渲染第二个订单视图,得到HTML内容
$orderHtml = view('pdf.order_info', compact('orders'))->render();
// 合并多个视图的HTML内容,可以根据需要添加分页符等
$combinedHtml = $userHtml . '<pagebreak />' . $orderHtml;
// 实例化MPDF对象,可配置页面大小、方向等参数
$mpdf = new Mpdf([
'mode' => 'utf-8',
'format' => 'A4',
'orientation' => 'P', // P为纵向,L为横向
'margin_left' => 10,
'margin_right' => 10,
'margin_top' => 10,
'margin_bottom' => 10
]);
// 写入合并后的HTML内容
$mpdf->WriteHTML($combinedHtml);
// 输出PDF,'I'表示在浏览器中直接显示,'D'表示下载,'F'表示保存到服务器
return $mpdf->Output('多视图合并PDF.pdf', 'I');
}
}上述代码中,我们首先准备了模拟的用户和订单数据,然后分别调用 Blade 视图的 render() 方法,将视图渲染为纯 HTML 字符串。接着使用 MPDF 支持的 <pagebreak /> 标签在两个视图内容之间添加分页符,避免内容重叠。之后实例化 MPDF 对象,配置基本的页面参数,调用 WriteHTML() 方法写入合并后的 HTML,最后通过 Output() 方法输出 PDF 文档。
路由配置与测试
在 routes/web.php 中添加对应的访问路由:
Route::get('/generate-multi-pdf', [PdfController::class, 'generateMultiViewPdf']);启动 Laravel 服务后,访问 http://ipipp.com/generate-multi-pdf(如果是本地开发环境则替换为对应的本地地址),即可在浏览器中看到生成的包含用户信息和订单详情的多页 PDF 文档。
注意事项
- MPDF 对 CSS 的支持有一定限制,复杂的 CSS 样式可能无法正常渲染,建议尽量使用简单的行内样式或者通用的 CSS 属性。
- 如果多个视图中有同名的 CSS 类,可能会出现样式冲突,建议在编写视图样式时尽量使用独特的类名,或者对特定视图的样式添加前缀。
- 如果需要加载更多视图,只需按照同样的思路渲染视图、合并 HTML 内容即可,MPDF 会自动处理分页和布局。
- 如果需要保存到服务器指定路径,可以将
Output()方法的第二个参数改为'F',第一个参数传入完整的文件保存路径即可。