关于服务器端wkhtmltopdf依赖于X server的解决方案

背景

• wkhtmltopdf这个库友好地支持将html文件转换为pdf文件,它基于QT的webkit进行渲染,因此依赖于操作系统的图形用户界面操作。
• 而服务器一般是运行级别3(即多用户状态下的字符终端界面),因此在服务器端直接调用wkhtmltopdf会报如下错误:

qt.qpa.screen: QXcbConnection: Could not connet to display
Cloud not connect to any X display

• 原因就在于wkhtmltopdf依赖于X server (linux 操作系统里面图形接口服务器的简称),而一般服务器运行在字符终端级别,并没有启动图形用户界面 ,因此产生无法连接到X display服务的错误。

解决方案

• 在 xvfb(X virtual framebuffer)中运行wkhtmltopdf, xvfb能够直接处理图形化功能,给应用程序提供一个虚拟的X server。

• ubuntu 下使用包管理工具直接安装

sudo apt-get install xvfb

• 在xvfb中运行wkhtmltopdf

xvfb-run wkhtmltopdf $source $destination

• 通过这种方式即可解决wkhtmltopdf产生的"Cloud not connect to any X display"的错误。

参考代码

• 以下提供golang版本的示例代码
• 该代码将htmlFile(绝对路径)这个html文件转换为pdfFile(绝对路径)pdf文件

func generatePdfFile(htmlFile string, pdfFile string)error{
 // xvbf命令
 xvfbCommand, err := exec.LookPath("xvfb-run")
 if err != nil{
 return errors.New("xvfb未安装")
 }
 // wkhtmltopdf命令
 wkh2fCommand, err := exec.LookPath("wkhtmltopdf")
 if err != nil{
 return errors.New("wkhtmltopdf未安装")
 }
 args := []string{wkh2fCommand, htmlFile, pdfFile}
 errBuf := &bytes.Buffer{}
 cmd := exec.Command(xvfbCommand, args...)
 cmd.Stderr = errBuf
 err = cmd.Run()
 if err != nil{
 errStr := errBuf.String()
 if strings.TrimSpace(errStr) == ""{
 errStr = err.Error()
 }
 return errors.New(errStr)
 }
 return nil
}

• 另,关于操作系统的7个运行级别如下

关于操作系统的7个运行级别 
运行级别0:系统停机状态,系统默认运行级别不能设为0,否则不能正常启动
运行级别1:单用户工作状态,root权限,用于系统维护,禁止远程登陆
运行级别2:多用户状态(没有NFS)
运行级别3:完全的多用户状态(有NFS),登陆后进入控制台命令行模式
运行级别4:系统未使用,保留
运行级别5:X11控制台,登陆后进入图形GUI模式
运行级别6:系统正常关闭并重启,默认运行级别不能设为6,否则不能正常启动

有疑问加站长微信联系(非本文作者)

• 请尽量让自己的回复能够对别人有帮助
• 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
• 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
• 图片支持拖拽、截图粘贴等方式上传