laravel 中使用的 PDF 扩展包 laravel-dompdf 和 laravel-snappy

这两天项目中需要将HTML页面转换为PDF文件方便打印，我在网上搜了很多资料。先后尝试了laravel-dompdf和laravel-snappy两种扩展包，个人感觉laravel-snappy比较好用。

一、使用laravel-dompdf扩展包

1、安装扩展包

我们通过composer来安装

composer require barryvdh/laravel-dompdf

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

Barryvdh\DomPDF\ServiceProvider::class,

3、添加facade到config / app.php中的aliases数组中

'PDF' => Barryvdh\DomPDF\Facade::class,

4、使用

可以创建一个dompdf实例并加载HTML字符串、文件或者视图，然后使用stream()方法显示在浏览器中、save()方法保存到文件或者download()方法下载。

$pdf = App::make('dompdf.wrapper');
$pdf->loadHTML('<h1>Test</h1>');
return $pdf->stream();

也可以使用门面（facade），使用前先use PDF;

$pdf = PDF::loadView('pdf.invoice', $data);
return $pdf->download('invoice.pdf');

也可以链式操作

return PDF::loadFile(public_path().'/myfile.html')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');

可以更改方向（landscape将方向设为横向，一般使用的都是竖向的，使用时注意一下）和纸张大小，并隐藏或显示错误（默认情况下，调试打开时显示错误）

PDF::loadHTML($html)->setPaper('a4', 'landscape')->setWarnings(false)->save('myfile.pdf')

其他的一些基本使用和配置请参考文档资料：https://github.com/barryvdh/laravel-dompdf

5、解决中文乱码问题

下载一个支持unicode编码的中文字体。例如：msyh.ttf（微软雅黑）

建议先在storage下创建fonts文件夹，把字体放在fonts文件夹下，不然会报错。

在css中引入字体

<style>
            @font-face {
                font-family: 'msyh';
                font-style: normal;
                font-weight: normal;
                src: url({{ storage_path('your_path/msyh.ttf') }}) format('truetype');
            }
            body {
                font-family: msyh, DejaVu Sans,sans-serif;
            }
</style>

注意：亲测只有unicode编码的中文，才能正常显示，这也是我觉得这个PDF扩展不太好用的原因。

二、使用laravel-snappy扩展包

1、安装依赖软件

laravel-snappy扩展包需要Wkhtmltopdff的支持，所以先安装Wkhtmltopdf

方法一：下载wkhtmltopdf安装包

wkhtmltopdf 下载地址：https://wkhtmltopdf.org/downloads.html

windows直接下载安装就可以了，注意安装到你知道的地方，这个路径后面有用。

我的安装在G:wk目录下

在bin目录下有wkhtmltoimage与wkhtmltopdf两个依赖软件

linux下载解压完成后，要将文件移动到 /usr/local/bin 下

方法二：通过 composer 来安装

以linux系统为例

32位:
$ composer require h4cc / wkhtmltopdf-i386 0.12.x
$ composer require h4cc / wkhtmltoimage-i386 0.12.x，
64位:
$ composer require h4cc/wkhtmltopdf-amd64 0.12.x
$ composer require h4cc/wkhtmltoimage-amd64 0.12.x

(uname -a 命令查看系统位数)

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

Linux 下使用该第三方插件需要几个库的支持

yum install libXrender*
yum install libfontconfig*

2、安装laravel-snappy扩展包

composer require barryvdh/laravel-snappy

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

Barryvdh\Snappy\ServiceProvider::class,

4、添加facade到config / app.php中的aliases数组中

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

5、生成配置文件

高版本的 laravel ，例如 Version 5.5 以上，请忽略上面的3,4步骤，直接到这里生成皮配置文件

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

此命令会在 config/snappy.php 生成配置文件

具体配置如下:

<?php

return [

    'pdf' => [
        'enabled' => true,
        'binary'  => env('WKHTML_PDF_BINARY', '/usr/local/bin/wkhtmltopdf-amd64'), // linux 配置路径
        // 'binary'  => env('WKHTML_PDF_BINARY', 'G:\wk\wkhtmltopdf\bin\wkhtmltopdf\wkhtmltopdf-amd64'), // windows 配置路径
        'timeout' => false,
        'options' => [],
        'env'     => [],
    ],

    'image' => [
        'enabled' => true,
        'binary'  => env('WKHTML_IMG_BINARY', '/usr/local/bin/wkhtmltoimage-amd64'), // linux 配置路径
        // 'binary'  => env('WKHTML_IMG_BINARY', 'G:\wk\wkhtmltopdf\bin\wkhtmltopdf\wkhtmltoimage-amd64'), // windows 配置路径
        'timeout' => false,
        'options' => [],
        'env'     => [],
    ],

];

 6、使用 ( 与使用dompdf类似 )

先引入

use PDF;
use SnappyImage;

生成PDF文件

可以使用门面（facade）加载HTML字符串、文件或者视图，然后使用stream()方法显示在浏览器中、save()方法保存到文件或者download()方法下载。

$pdf = PDF::loadView('pdf.invoice', $data);
return $pdf->download('invoice.pdf');

也可以链式操作

return PDF::loadFile(public_path().'/myfile.html')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');

可以更改方向（landscape将方向设为横向，一般使用的都是竖向的，使用时注意一下）和纸张大小，并隐藏或显示错误（默认情况下，调试打开时显示错误）

PDF::loadHTML($html)->setPaper('a4', 'landscape')->setWarnings(false)->save('myfile.pdf')

生成图片

$pdf = SnappyImage::loadView('pdf.invoice', $data);
return $pdf->download('invoice.image');

7、解决中英文乱码问题 （linux）

方法一：

宋体或其他中文字体添加到 /usr/share/fonts/ 里

方法二：

安装中文字体：

yum install ipa-gothic-fonts ipa-mincho-fonts ipa-pgothic-fonts ipa-pmincho-fonts 

在方法里面转义为 utf-8

 $pdf -> setOption('encoding', 'utf-8'); 

Demo测试用例如下：

Controller 层

<?php

namespace App\Http\Controllers\V2;

use Illuminate\Http\Request;
use App\Responses\Res;
use Illuminate\Support\Facades\Validator;
use PDF;
use SnappyImage;
use App;
use Illuminate\Support\Facades\Response;

class PdfController extends Controller
{

    /**
     * 您可以创建一个新的Snappy PDF / Image实例并加载HTML字符串，文件或视图名称。您可以将其保存到文件中，也可以内联（在浏览器中显示）或下载。
     * 使用App容器：
     */
    public function pdf1()
    {
        $snappy = App::make('snappy.pdf');
        //To file
        $html = '<h1>Bill</h1><p>You owe me money, dude.</p>';
        $snappy->generateFromHtml($html, '/tmp/bill-123.pdf');
        $snappy->generate('http://www.github.com', '/tmp/github.pdf');
        //Or output:
        return new Response(
            $snappy->getOutputFromHtml($html),
            200,
            array(
                'Content-Type'          => 'application/pdf',
                'Content-Disposition'   => 'attachment; filename="file.pdf"'
            )
        );
    }

    /**
     * 使用包装器：
     *
     * 使用内嵌的 html 生成一个pdf文件，然后进行 online 的预览
     */
    public function pdf2()
    {
        $pdf = App::make('snappy.pdf.wrapper');
        $pdf->setOption('encoding', 'utf-8');
        $pdf->loadHTML('<h1>Test-中文</h1>');
        return $pdf->inline();
    }

    /**
     * 或使用外观：
     *
     * 使用 blade 模板引擎，生成 pdf 文件
     */
    public function pdf3()
    {
        $pdf = PDF::loadView('v2.pdf.view_test', array(
            'h1' => 'English Test',
            'h2' => 'Test Number123456',
            'h3' => '测试中文',
        ));
        $pdf->setOption('encoding', 'utf-8');
        return $pdf->download('invoice.pdf');
    }

    /**
     * 您可以链接方法：
     *
     * 用过 url 网址获取内容，然后生成pdf文件
     */
    public function pdf4()
    {
        return PDF::loadFile('https://www.baidu.com/')->inline('github.pdf');
    }

    /**
     * 您可以更改方向和纸张尺寸
     */
    public function pdf5()
    {
        $html = '<h1>11111</h1><h2>Test</h2><h3>份打散加啦</h3>';
        PDF::loadHTML($html)->setPaper('a4')->setOrientation('landscape')->setOption('margin-bottom', 0)->save('myfile.pdf');
    }

    /**
     * 图片生成
     *
     * 利用 blade 模板，生成文件
     */
    public function img1()
    {
        $pdf = SnappyImage::loadView('v2.pdf.view_test', array(
            'h1' => 'English Test',
            'h2' => 'Test Number123456',
            'h3' => '测试中文，和标点符号',
        ));
        $pdf->setOption('encoding', 'utf-8');
        return $pdf->stream('image.jpg'); // 实现预览用此方法
        // return $pdf->download('invoice.image.jpg'); // 实现下载用此方法
    }
}

View层（v2.pdf.view_test）：

<h1>{{$h1}}</h1>
<h2>{{$h2}}</h2>
<h3>{{$h3}}</h3>

更多设置

$pdf = App::make('snappy.pdf.wrapper');
return $pdf
    	//->loadHtml('<h1>你好123</h1>')
    	//->loadFile('http://www.kissyou.club/wap/parttime-job/')
    	->loadView('test.index')
    	->setPaper('a4')
    	->setOrientation('landscape')
    	->setOption('margin-bottom', 0)
    	->setOption('enable-forms', true)
    	//->setOption('grayscale', true)
    	//->setOption('debug-javascript', true)
    	//->setOption('page-offset', 8)
    	->setOption('encoding', 'utf-8')
    	//->setOption('header-font-name', 'msyh')
    	//->setOption('enable-external-links', true)
    	->inline();  // $data 为传递的参数
    	//return $pdf->inline(); // 显示

参考资料如下：

laravel-dompdf包： https://packagist.org/packages/barryvdh/laravel-dompdf

laravel-snappy包：https://packagist.org/packages/barryvdh/laravel-snappy

原作者：https://www.cnblogs.com/weiyalin/articles/7765558.html