Erupt Print 打印模块
erupt-print 提供基于 HTML 模板的打印能力,支持配置模板变量,将业务数据动态填充后生成可打印的单据或报告。
2.0.0 新增:erupt-print 现已直接支持 Erupt 实体,可为任意 Erupt 表格数据定义打印模板、配置变量并一键打印,不再仅限于 erupt-flow 流程单据。
引入方式
<dependency>
<groupId>xyz.erupt</groupId>
<artifactId>erupt-print</artifactId>
<version>${erupt.version}</version>
</dependency>核心概念
| 概念 | 说明 |
|---|---|
| 打印模板 | HTML 格式的模板文件,可在管理界面可视化编辑 |
| 模板变量 | 在模板中定义占位符,运行时由 Erupt 实体字段值动态替换 |
| 打印触发 | 在 Erupt 表格行操作中一键触发,将当前行数据填充到模板后打印 |
| 内置打印 | 模型没有打印模板时的默认排版:按表单字段生成的可配置打印预览,无需任何模板 v2.4.0+ |
使用流程
- 定义模板:在系统菜单"打印模板"中新建模板,编写 HTML 布局
- 配置变量:在模板中插入变量占位符,绑定 Erupt 实体的字段名
- 关联 Erupt:将模板与目标 Erupt 实体关联
- 触发打印:在对应表格行点击打印按钮,系统自动填充变量并调起打印预览
没有配置模板也可以打印:打印入口直接打开内置打印预览。模型配置了模板后,打印时先弹出「选择打印排版」列表,「默认排版」即内置打印,其余按模板输出。
模板变量配置
在打印模板中定义变量,变量值从 Erupt 实体字段或流程业务数据中动态填充:

打印效果

内置打印 v2.4.0+
内置打印把记录按表单字段排成一张单据,预览顶部是一条设置栏,改动即时反映在预览中:
| 设置 | 说明 |
|---|---|
| 表单样式 | 标签在上 / 标签在左 |
| 每行列数 | 1 ~ 4 列;整行布局(@Layout(formSize = FormSize.FULL_LINE))的模型默认 1 列,其余默认 3 列 |
| 边框 / 线框颜色 | 单元格边框开关及颜色(默认 #d9d9d9) |
| 字号 | 10 ~ 24 px,默认 13 |
| 标题 | 是否在表单上方打印标题,默认取当前菜单名 |
| 纸张大小 / 方向 | A4 / A3 / A5 / Letter / 自动,纵向或横向,默认 A4 纵向 |
| 页边距 | 0 ~ 50 mm,默认 10 |
这份设置保存在浏览器 localStorage 的 print-builtin-config 中,对所有模型生效,下次打印沿用上次的选择;erupt-flow 审批单的默认打印使用同一份设置(流程自定义打印模板则沿用模板自带的页面设置)。
打印内容
- 表单中可见且带标题的字段按顺序排入网格,占整行的字段(多行文本、富文本、代码、附件、签名、地图、标签等)独占一行,前一行的末格自动补齐,保证每行闭合
- 一对多 / 多对多 / 多表单字段打印成一张子表,列取自该子模型的表格列,布尔、选择、日期等按显示值输出
- 树形标签(TAB_TREE)字段打印为勾选节点的名称,按树的顺序以逗号连接
- 组合(COMBINE)字段作为一个带标题的分节嵌套渲染,分割线与说明块也会打印
- 密码、占位、TPL 等不可打印类型自动略过
打印方式
点击「打印」后,预览内容被写入一个隐藏的 iframe:iframe 带上站点自身的样式表(去掉深色 / 紧凑主题包,纸面始终是浅色常规密度),等样式、图片与字体加载完成后再调起浏览器打印,打印结束 iframe 自动移除。排版因此按纸张宽度重排,而不是把屏幕上的像素尺寸原样打印;@page 的尺寸、方向与边距来自设置栏。模板打印走同一条通道,但不带站点样式,模板自身的样式不会被工作台的全局样式覆盖。
打印权限
打印入口(表格工具栏的「打印」与「打印布局」、记录面板「更多」菜单中的「打印」)只对可读取记录详情的用户显示:模型的 @Power(print) 开启,且当前用户拥有 edit 或 viewDetails 之一。@Power(print = false) 的模型既没有打印入口,也没有打印布局的管理入口。服务端的模板渲染接口按同样的规则校验,并且记录必须落在当前用户的行数据范围内,见 @Power → print。
模板打印请求 v2.4.0+
按模板打印时,前端不再把模板内容发给服务端,而是只传打印配置的 id:
POST /erupt-api/print/{erupt}/{id}?config=<打印配置 id>服务端按 erupt 与 config 找到该模型下的打印配置(找不到时报错),读取记录并以 Velocity 渲染模板内容,返回 HTML;前端用该配置保存的页面设置(纸张、方向、四边距)打印。模板内容只在「打印布局」中维护,打印请求无法注入任意模板。