使用Laravel-snappy导出PDF

前言

论坛里有很多关于如何使用Laravel-snappy的文章,但是很多都停留在安装、基本示例,对于实际的应用既没有说明用法,也没有解答一些问题和疑惑,因此在此整理一下,权当做个记录吧。

附:

参考文章:
Laravel 使用 laravel-snappy 包 实现 HTML 转 PDF 和 PNG
laravel使用snappy生成pdf问题及过程(本地环境)
QSslSocket: cannot resolve CRYPTO_num_locks的解决方法
barryvdhlaravel-snappy

安装

以ubuntu为例

1.执行安装 wkhtmltopdf:

composer require h4cc/wkhtmltopdf-amd64 0.12.x
composer require h4cc/wkhtmltoimage-amd64 0.12.x

顾名思义,分别安装的是wkhtmltopdf和wkhtmltoimage。

2.复制wkhtmltopdf到ubuntu可执行命令的目录中

sudo cp vendor/h4cc/wkhtmltoimage-amd64/bin/wkhtmltoimage-amd64 /usr/local/bin/
sudo cp vendor/h4cc/wkhtmltopdf-amd64/bin/wkhtmltopdf-amd64 /usr/local/bin/
//并使其可执行:
sudo chmod +x /usr/local/bin/wkhtmltoimage-amd64 
sudo chmod +x /usr/local/bin/wkhtmltopdf-amd64

3.安装 laravel-snappy

composer require barryvdh/laravel-snappy

4.将 ServiceProvider 添加到 config/app.php 中的 providers 数组中

Barryvdh\Snappy\ServiceProvider::class

5.将 Facades 添加到 config/app.php 中的 aliases 数组中

'PDF' => Barryvdh\Snappy\Facades\SnappyPdf::class,
'SnappyImage' => Barryvdh\Snappy\Facades\SnappyImage::class,

6.执行生成配置文件

php artisan vendor:publish --provider="Barryvdh\Snappy\ServiceProvider"

可以看到默认的配置文件为config/snappy.php

return [
    'pdf' => [
        'enabled' => true,
        'binary'  => env('WKHTML_PDF_BINARY', '/usr/local/bin/wkhtmltopdf'),
        'timeout' => false,
        'options' => [],
        'env'     => [],
    ],

    'image' => [
        'enabled' => true,
        'binary'  => env('WKHTML_IMG_BINARY', '/usr/local/bin/wkhtmltoimage'),
        'timeout' => false,
        'options' => [],
        'env'     => [],
    ],

];

注意,这里有个坑,默认binary配置为/usr/local/bin/wkhtmltopdf/usr/local/bin/wkhtmltoimage,在第一次使用的时候,会报错/usr/local/bin/wkhtmltopdf不存在,这是因为在linux系统下,wkhtmltopdf和wkhtmltoimage的真实路径和名称为:/usr/local/bin/wkhtmltopdf-amd64/usr/local/bin/wkhtmltoimage-amd64

使用Laravel-snappy导出PDF
因此,需要把配置信息修改为:

'pdf' => [
        ...
        'binary'  => env('WKHTML_PDF_BINARY', '/usr/local/bin/wkhtmltopdf-amd64'),
        ...
    ],

    'image' => [
        ...
        'binary'  => env('WKHTML_IMG_BINARY', '/usr/local/bin/wkhtmltoimage-amd64'),
        ...
    ],

开始使用

//使用方法1
$pdf = \PDF::loadView('welcome', $data);
return $pdf->download('welcome.pdf');

//使用方法2
$html = '<html><head><meta charset="utf-8"></head><h1>订单id</h1><h2>12346546</h2></html>';
$pdf = \PDF::loadHTML($html);
return $pdf->inline();

很多博客里没有提到,使用方法1中,会报这样的错:

The exit status code '1' says something went wrong: stderr: "Loading pages (1/6) [> ] 0% [======> ] 10% QSslSocket: cannot resolve CRYPTO_num_locks QSslSocket: cannot resolve CRYPTO_set_id_callback QSslSocket: cannot resolve CRYPTO_set_locking_callback QSslSocket: cannot resolve sk_free QSslSocket: cannot resolve sk_num QSslSocket: cannot resolve sk_pop_free QSslSocket: cannot resolve sk_value QSslSocket: cannot resolve SSL_library_init QSslSocket: cannot resolve SSL_load_error_strings QSslSocket: cannot resolve SSLv3_client_method QSslSocket: cannot resolve SSLv23_client_method QSslSocket: cannot resolve SSLv3_server_method QSslSocket: cannot resolve SSLv23_server_method QSslSocket: cannot resolve X509_STORE_CTX_get_chain QSslSocket: cannot resolve OPENSSL_add_all_algorithms_noconf QSslSocket: cannot resolve OPENSSL_add_all_algorithms_conf QSslSocket: cannot resolve SSLeay QSslSocket: cannot call unresolved function CRYPTO_num_locks QSslSocket: cannot call unresolved function CRYPTO_set_id_callback QSslSocket: cannot call unresolved function CRYPTO_set_locking_callback QSslSocket: cannot call unresolved function SSL_library_init QSslSocket: cannot call unresolved function SSLv23_client_method QSslSocket: cannot call unresolved function sk_num [==================> ] 31% QSslSocket: cannot call unresolved function SSLv23_client_method QSslSocket: cannot call unresolved function SSL_library_init [============================================================] 100% Counting pages (2/6) [============================================================] Object 1 of 1 Resolving links (4/6) [============================================================] Object 1 of 1 Loading headers and footers (5/6) Printing pages (6/6) [> ] Preparing [============================================================] Page 1 of 1 Done Exit with code 1 due to network error: UnknownNetworkError QSslSocket: cannot call unresolved function CRYPTO_num_locks QSslSocket: cannot call unresolved function CRYPTO_set_id_callback QSslSocket: cannot call unresolved function CRYPTO_set_locking_callback " stdout: "" command: /usr/local/bin/wkhtmltopdf-amd64 --lowquality '/tmp/knp_snappy612c3edcdfc855.21787864.html' '/tmp/knp_snappy612c3edcdfce49.80482557.pdf'.

可以参考这篇文章:
QSslSocket: cannot resolve CRYPTO_num_locks的解决方法
执行:

sudo apt-get update
sudo apt install libssl1.0-dev

修复完成,导出welcome页面。

如果使用save()方法保存,默认保存到/public文件夹下,并且如果文件名相同的情况下,第二次保存会提示文件已经存在。更多用法可以参考这篇文章:

laravel使用snappy生成pdf问题及过程(本地环境)

自定义页面导出数据

简单的用法可以直接使用loadHTML(),但是如果比较复杂的页面,并且需要美化页面的情况下,如果还继续使用loadHTML()就显得很有问题,可以想象一下,成片的h5代码在php代码中,就显得很繁杂,不够优雅,就算要维护也相当困难。因此如果是这种需求的话,应该使用loadView()
控制器:

$logs = [
            ["name" => "李大", "city" => "上海"],
            ["name" => "阿鹏", "city" => "北京"]
        ];
        //请注意这里的compact,如果不使用compact,需要另外写js进行处理
        $pdf = PDF::loadView('admin.user_data', compact('logs'));
        return $pdf->download('billing_data.pdf');

admin.user_data.blade.php:

<!DOCTYPE html>
<html>
<head>
 <meta charset="utf-8">
 <title>数据导出</title>
  <!-- 最新版本的 Bootstrap 核心 CSS 文件 -->
  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha384-HSMxcRTRxnN+Bdg0JdbxYKrThecOKuH5zCYotlSAcp1+c8xmyTe9GYg1l9a69psu" crossorigin="anonymous">

  <!-- 最新的 Bootstrap 核心 JavaScript 文件 -->
  <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha384-aJ21OjlMXNL5UyIl/XNwTMqvzeRMZH2w8c5cRVpzpU8Y5bApTppSuUkhZXN0VxHd" crossorigin="anonymous"></script>
</head>
<body>
 <table class="table">
 <caption>基本的表格布局</caption>
 <thead> <tr> <th>名称</th>
 <th>城市</th>
 </tr> </thead> <tbody>  @foreach($logs as $log)
  <tr>
 <td>{{  $log["name"] }}</td>
 <td>{{  $log["city"] }}</td>
 </tr>
  @endforeach
  </tbody>
 </table></body>
</html>

导出效果:

使用Laravel-snappy导出PDF

相应的美化工作可以使用css控制。

本作品采用《CC 协议》,转载必须注明作者和本文链接
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!