Django使用reportlab套件生成PDF文件

简介

项目中生成了一个实例，须要提供给用户下载pdf文件功能。

最开始想到的是使用前段技术，直接将html页面保存为pdf文件。这个过程使用了html2pdf，这个纯js项目。该项目会将指定的DOM元素经过html2canvas工具保存为图片，而后经过jsPDF工具将保存的图片最终以pdf文件形式展示，并直接供下载。

这样作有个缺点就是当页面很是长时，就有可能出现一行文字被从中间截断，展现在两页pdf文件中的状况。于是须要寻找更高级，输出格式更优雅的解决方案。最后发现了能够经过Reportlab套件来完成工做。

工做流

要想经过Reportlab套件来生成pdf文件的工做流程主要分三步：

1. django后台经过与数据库或者其余调用获取数据
2. 将这些数据传入到RML（Report Markable Language）模板，并调用reportlab套件生成二进制数据
3. django根据生成的数据返回响应

第1和第3步能够参考官方outputting pdf文档

比较关键的是第2步如何实现，下面将针对RML、以及如何调用reportlab套件生成二进制数据进行详细讲解

RML和Reportlab套件使用

关于RML能够参考Reportlab提供的RML-for-Idiots和RML User Guide两个文档进行学习，这里并不赘述。只介绍我的使用的一些体会。

• 首页与其他页使用不一样模板

要想实现第一页和后面其他页使用不一样的模板，在<story>上添加firstPageTemplate属性，指定第一页的模板。紧接着使用<setNextTempate name='main'>来指定剩余页（若是有的话）使用的模板。

若是想整个pdf使用同一个模板的话，则无须使用<setNextTempate name='main'>。

<?xml version="1.0" encoding="utf-8" standalone="no" ?>
<!DOCTYPE document SYSTEM "rml_1_0.dtd"> 
<document filename="rml.pdf">

<template pagesize="(595, 842)" leftMargin="72">
    <pageTemplate id="head">
        <pageGraphics>
            <setFont name="bighei" size="24"/>
            <drawCentredString x="297.5" y="760">{{ name }}</drawCentredString>
        </pageGraphics>
        <frame id="first" x1="80" y1="80" width="435" height="550"/>
	</pageTemplate>
	<pageTemplate id="main">
        <frame id="first" x1="80" y1="80" width="435" height="682"/>
	</pageTemplate>
</template>

<stylesheet>
	<initialize>
	<alias id="style.normal" value="style.Normal"/>
	</initialize>

	<paraStyle name="chapter title"    fontName="bighei" fontSize="20" leading="36"                  spaceAfter="10"/>

	<paraStyle name="question stem"    fontName="bighei" fontSize="12" leading="12" spaceBefore="15" spaceAfter="10"/>

	<paraStyle name="question options" fontName="bighei" fontSize="10" leading="12"                  spaceAfter="5" />
</stylesheet>

<story firstPageTemplate="head">

    <setNextTemplate name="main" />
    {{ paras }}

</story>

</document>

• 经过Django template解决RML不能嵌套循环问题

我的在使用过程当中发现没法在RML模板中进行嵌套循环，

{{ for outter_item in outter_list }}
    {{ for inner_item in outter_item }}
    {{ innger_item }}
    {{ endfor }}
{{ endfor }}

可是Django模板中并没有此限制，于是能够直接调用render_to_string方法将RML须要的字符串使用django的机制来生成，而后再传给RML解决这个问题。

from io import BytesIO
import preppy
import trml2pdf

TEMPLATE = os.path.join(PATH_TO_TEMPLATE_DIR, 'template.prep')
def generate_pdf():

    django_context = dict()

    paras = render_to_string('django_templates.html', django_context)

    rml_context = dict(
        name='RML Test',
        paras=paras.encode("utf-8")
    )

    template = preppy.getModule(template_path)
    rml = template.getOutput(rml_context)

    return trml2pdf.parseString(rml)

• 解决中文乱码问题

RML默认不支持中文，须要本身注册支持中文的字体

from reportlab.pdfbase import pdfmetrics
from reportlab.pdfbase import ttfonts

pdfmetrics.registerFont(ttfonts.TTFont(font_name, font_path))

• Django views

def test_rml(request):
    response = HttpResponse(content_type='application/pdf')
    response['Content-Disposition'] = 'attachment; filename="rml.pdf"'
    
    pdf = generate_pdf()
    
    response.write(pdf)
    
    return response