PDF格式文档导出，是信息系统中非常实用的一种功能，用于各种报表和文档的到处。最近正好有空，用之前项目中使用过的itext做一个简单的示例，方便以后使用。示例中，使用Freemarker生成要导出的HTML格式文档，通过Spring Boot来实现PDF文件下载。
源代码：GitHub
创建Gradle项目
需要在build.gradle中添加要引入的jar包，还有Gradle插件。主要有spring boot plugin和spring boot相关的包；freemarker，还有itextpdf，这里的itext-asian会引入中文支持。
buildscript {
repositories {
mavenLocal()
mavenCentral()
}
dependencies {
classpath('org.freemarker:freemarker:2.3.23')
classpath("org.springframework.boot:spring-boot-gradle-plugin:1.4.0.RELEASE")
}
}
... ...
dependencies {
// tag::jetty[]
compile("org.springframework.boot:spring-boot-starter-web") {
exclude module: "spring-boot-starter-tomcat"
}
compile("org.springframework.boot:spring-boot-starter-jetty")
// end::jetty[]
// tag::actuator[]
compile("org.springframework.boot:spring-boot-starter-actuator")
compile("org.springframework.boot:spring-boot-starter-aop")
compile("org.springframework:spring-context-support")
compile 'com.itextpdf:itextpdf:5.5.9'
compile 'com.itextpdf:itext-asian:5.2.0'
compile 'com.itextpdf.tool:xmlworker:5.5.9'
compile 'org.freemarker:freemarker:2.3.23'
compile 'javax.servlet:javax.servlet-api:3.1.0'
testCompile (group: 'junit', name: 'junit', version: '4.12')
testCompile("org.springframework.boot:spring-boot-starter-test")
}
用Freemarker来生成html字符串
freemarker是一种非常轻量易用的模板引擎，除了用于在web mvc框架中渲染html页面以外，还可以用在其他需要生成其他有复杂格式的文档，并且需要用数据进行格式化的场景下；将生成的字符串写入指定的Java流中。
public class FreemarkerUtils {
public static String loadFtlHtml(File baseDir, String fileName,Map globalMap){
if(baseDir == null || !baseDir.isDirectory() || globalMap ==null || fileName == null || "".equals(fileName)){
throw new IllegalArgumentException("Directory file");
}
Configuration cfg = new Configuration(Configuration.VERSION_2_3_22);
try {
cfg.setDirectoryForTemplateLoading(baseDir);
cfg.setDefaultEncoding("UTF-8");
cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);//.RETHROW
cfg.setClassicCompatible(true);
Template temp = cfg.getTemplate(fileName);
StringWriter stringWriter = new StringWriter();
temp.process(globalMap, stringWriter);
return stringWriter.toString();
} catch (IOException | TemplateException e) {
e.printStackTrace();
throw new RuntimeException("load fail file");
}
}
}
传入的参数是ftl文件的根目录和文件名，还有要用来格式化文档的数据。
itext将html转换成PDF文档
itext生成PDF的代码比较简单，创建一个Document对象，然后XmlWorkerHelper会在指定的OutputStream中输入生成的pdf文件。
public static void savePdf(OutputStream out, String html) {
Document document = new Document(PageSize.A4, 50, 50, 60, 60);
try {
PdfWriter writer = PdfWriter.getInstance(document, out);
document.open();
XMLWorkerHelper.getInstance().parseXHtml(writer, document, new StringReader(html));
} catch (Exception e) {
e.printStackTrace();
} finally {
document.close();
}
}
如果简单的实现文件下载的话，可以直接使用HttpServletResponse的OutputStream，就可以实现pdf下载，但是Spring MVC支持自定义View，使用Spring boot可以通过简单的配置实现对应功能。
集成Spring Boot实现文件下载
Spring MVC通过继承基类AbstractView，可以实现自定义的View，在子类中，可以设置header，通过对输出流的操作，就可以实现在Java代码中调用需要的资源，输出对应的内容的功能。详细内容参看源代码。
@Override
protected void renderMergedOutputModel(Map<String, Object> model,
HttpServletRequest request, HttpServletResponse response) throws Exception {
// IE workaround: write into byte array first.
ByteArrayOutputStream baos = createTemporaryOutputStream();
// Apply preferences and build metadata.
Document document = newDocument();
PdfWriter writer = newWriter(document, baos);
prepareWriter(model, writer, request);
buildPdfMetadata(model, document, request);
// Build PDF document.
document.open();
buildPdfDocument(model, document, writer, request, response);
document.close();
// Flush to HTTP response.
writeToResponse(response, baos);
}
......
protected void buildPdfDocument(Map<String, Object> model,
Document document, PdfWriter writer, HttpServletRequest request,
HttpServletResponse response) throws Exception {
URL fileResource = FormPdfview.class.getResource("/templates");
String html = FreemarkerUtils.loadFtlHtml(new File(fileResource.getFile()), "simpleForm.ftl", model);
XMLWorkerHelper.getInstance().parseXHtml(writer, document, new ByteArrayInputStream(html.getBytes()), Charset.forName("UTF-8"), new AsianFontProvider() );
}
为了能够在Spring MVC的控制器中通过MVC模式调用自定义的View对象，还需要进行一些配置；
首先，在WebMvcConfigurerAdapter的子类中，添加view resolver配置。作用相当于在spring mvc中使用xml进行配置。
@Bean
public ResourceBundleViewResolver viewResolver() {
ResourceBundleViewResolver resolver = new ResourceBundleViewResolver();
resolver.setOrder(1);
resolver.setBasename("views");
return resolver;
}
然后要在resources目录下创建一个views.properties文件，为我们自定义的view指定一个名字，就可以在controller中正常使用。
simplePDF.(class)=com.liuwill.text.view.Pdfview
simpleFormPDF.(class)=com.liuwill.text.view.FormPdfview
效果
下载源代码之后，执行gradle bootRun来运行Spring Boot，运行起来之后，访问 http://localhost:8888/download 查看结果。
