为之则易,不为则难。
一、引入依赖
<!-- 读取HTML模板文件 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
<!-- 将HTML文件转化为PDF文件 -->
<dependency>
<groupId>org.xhtmlrenderer</groupId>
<artifactId>flying-saucer-pdf</artifactId>
<version>9.1.20</version>
</dependency>
二、新建模板
模板文件相当于将html文件重命名为后缀为.tfl格式的文件,将其中可变的部分使用${变量名}占位。
生成PDF需要指定使用字体文件,否则不显示中文。暂时只支持宋体和黑体。本示例中使用了宋体就是font文件夹下的 simsun.ttc 文件,此文件可以在 Windows 系统中的 C:\Windows\Fonts 文件夹下找到。
pdfDemo.ftl文件:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<title>PDF导出示例</title>
<style>
@page {
/* 页面大小:示例中设置为A4纸的大小 */
size: 210mm 297mm;
margin: 15mm 15mm 15mm 15mm;
}
body {
width: 178mm;
font-family: SimSun;
font-size: 18px;
}
table {
width: 100%;
border-collapse: collapse;
}
thead th {
border: 1px solid #000;
padding: 5px 5px;
}
tr td {
border: 1px solid #000;
padding: 5px 5px;
}
.nameDiv {
margin: 15px 0px;
}
</style>
</head>
<body>
<div class="nameDiv">姓名:${name}</div>
<table>
<thead>
<th>序号</th>
<th>来访日期</th>
<th>来访原因</th>
<th>批复人员</th>
</thead>
<#list detailList as dl>
<tr>
<td>${dl_index+1}</td>
<td>${dl.date}</td>
<td>${dl.reason}</td>
<td>${dl.approver}</td>
</tr>
</#list>
</table>
</body>
</html>
三、PDF生成的工具类
import com.lowagie.text.pdf.BaseFont;
import freemarker.template.Configuration;
import freemarker.template.Template;
import org.xhtmlrenderer.pdf.ITextRenderer;
import java.io.File;
import java.io.OutputStream;
import java.io.StringWriter;
import java.net.URL;
import java.util.Locale;
/**
* PDF生成工具类
*/
public class PDFUtils {
/**
* resource资源路径获取
*/
private static final URL URL = Thread.currentThread().getContextClassLoader().getResource("");
/**
* 默认编码格式 UTF-8
*/
public static final String ENCODING = "UTF-8";
/**
* 模板路径
*/
private static final String TEMPLATE_PATH = URL.getPath().concat("pdfTemplate").concat(File.separator);
/**
* 字体路径
*/
private static final String FONT_PATH = URL.getPath().concat("pdfTemplate").concat(File.separator)
.concat("font").concat(File.separator);
/**
* 字体名 宋体
*/
private static final String FONT_NAME = "simsun.ttc";
private PDFUtils(){
throw new IllegalStateException("不允许创建PDFUtils实例");
}
/**
* 生成PDF
* @param templateFileName 模板文件名
* @param data 要填充的数据(键-值)(通常是一个Map<String, Object>,
* 或者是一个JavaBean,如果是JavaBean,那么属性名将作为键)
* 注意:键值对中的值不能为 null
* @param out 输出流
*/
public static void createPDF(String templateFileName, Object data, OutputStream out){
//创建一个Freemarker示例
Configuration cfg = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS);
ITextRenderer renderer = new ITextRenderer();
try {
//设置模板文件加载路径
cfg.setDirectoryForTemplateLoading(new File(TEMPLATE_PATH));
//设置css中的字体样式(默认宋体)
renderer.getFontResolver().addFont(FONT_PATH.concat(FONT_NAME), BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
//设置模板的编码格式
cfg.setEncoding(Locale.CHINA, ENCODING);
//获取模板文件
Template template = cfg.getTemplate(templateFileName, ENCODING);
StringWriter writer = new StringWriter();
//将数据输出到html中
template.process(data, writer);
writer.flush();
String html = writer.toString();
//将html代码传入渲染器中
renderer.setDocumentFromString(html);
renderer.layout();
renderer.createPDF(out, false);
renderer.finishPDF();
out.flush();
} catch (Exception e) {
e.printStackTrace();
throw new RuntimeException("生成PDF出现异常");
}
}
}
四、编写测试接口,下载PDF
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletResponse;
import java.io.BufferedOutputStream;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* 测试下载PDF Controller
*/
@RestController
@RequestMapping("pdf")
public class TestDownloadPdfController {
/**
* 下载PDF
* @param response
*/
@GetMapping("download")
public void download(HttpServletResponse response){
Map<String, Object> data = buildData();
try(BufferedOutputStream out = new BufferedOutputStream(response.getOutputStream())) {
response.setContentType(MediaType.APPLICATION_PDF_VALUE);
response.setCharacterEncoding(PDFUtils.ENCODING);
String fileName = URLEncoder.encode("访问记录.pdf", PDFUtils.ENCODING);
response.setHeader("Content-Disposition", "attachment;filename="+fileName);
PDFUtils.createPDF("pdfDemo.ftl", data, out);
}catch (Exception e){
e.printStackTrace();
throw new RuntimeException("下载PDF方法异常");
}
}
/**
* 生成数据
* @return
*/
private Map<String, Object> buildData(){
Map<String, Object> map = new HashMap<>();
map.put("name", "张三");
List<Map<String, Object>> detailList = new ArrayList<>();
Map<String, Object> map1 = new HashMap<>();
map1.put("date", "2020-11-14");
map1.put("reason", "吃饭");
map1.put("approver", "李四");
Map<String, Object> map2 = new HashMap<>();
map2.put("date", "2020-11-13");
map2.put("reason", "睡觉");
map2.put("approver", "李四");
Map<String, Object> map3 = new HashMap<>();
map3.put("date", "2020-11-12");
map3.put("reason", "打豆豆");
map3.put("approver", "李四");
Map<String, Object> map4 = new HashMap<>();
map4.put("date", "2020-11-11");
map4.put("reason", "工作");
map4.put("approver", "麻子");
detailList.add(map1);
detailList.add(map2);
detailList.add(map3);
detailList.add(map4);
map.put("detailList", detailList);
return map;
}
}