摘要：格式文檔導(dǎo)出，是信息系統(tǒng)中非常實(shí)用的一種功能，用于各種報(bào)表和文檔的到處。示例中，使用生成要導(dǎo)出的格式文檔，通過來實(shí)現(xiàn)文件下載。將轉(zhuǎn)換成文檔生成的代碼比較簡(jiǎn)單，創(chuàng)建一個(gè)對(duì)象，然后會(huì)在指定的中輸入生成的文件。作用相當(dāng)于在中使用進(jìn)行配置。

PDF格式文檔導(dǎo)出，是信息系統(tǒng)中非常實(shí)用的一種功能，用于各種報(bào)表和文檔的到處。最近正好有空，用之前項(xiàng)目中使用過的itext做一個(gè)簡(jiǎn)單的示例，方便以后使用。示例中，使用Freemarker生成要導(dǎo)出的HTML格式文檔，通過Spring Boot來實(shí)現(xiàn)PDF文件下載。

源代碼：GitHub

需要在build.gradle中添加要引入的jar包，還有Gradle插件。主要有spring boot plugin和spring boot相關(guān)的包；freemarker，還有itextpdf，這里的itext-asian會(huì)引入中文支持。

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是一種非常輕量易用的模板引擎，除了用于在web mvc框架中渲染html頁面以外，還可以用在其他需要生成其他有復(fù)雜格式的文檔，并且需要用數(shù)據(jù)進(jìn)行格式化的場(chǎng)景下；將生成的字符串寫入指定的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");
        }
    }
}

傳入的參數(shù)是ftl文件的根目錄和文件名，還有要用來格式化文檔的數(shù)據(jù)。

itext生成PDF的代碼比較簡(jiǎn)單，創(chuàng)建一個(gè)Document對(duì)象，然后XmlWorkerHelper會(huì)在指定的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();
    }
}

如果簡(jiǎn)單的實(shí)現(xiàn)文件下載的話，可以直接使用HttpServletResponse的OutputStream，就可以實(shí)現(xiàn)pdf下載，但是Spring MVC支持自定義View，使用Spring boot可以通過簡(jiǎn)單的配置實(shí)現(xiàn)對(duì)應(yīng)功能。

Spring MVC通過繼承基類AbstractView，可以實(shí)現(xiàn)自定義的View，在子類中，可以設(shè)置header，通過對(duì)輸出流的操作，就可以實(shí)現(xiàn)在Java代碼中調(diào)用需要的資源，輸出對(duì)應(yīng)的內(nèi)容的功能。詳細(xì)內(nèi)容參看源代碼。

@Override
protected void renderMergedOutputModel(Map 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 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模式調(diào)用自定義的View對(duì)象，還需要進(jìn)行一些配置；

首先，在WebMvcConfigurerAdapter的子類中，添加view resolver配置。作用相當(dāng)于在spring mvc中使用xml進(jìn)行配置。

@Bean
public ResourceBundleViewResolver viewResolver() {
    ResourceBundleViewResolver resolver = new ResourceBundleViewResolver();
    resolver.setOrder(1);
    resolver.setBasename("views");
    return resolver;
}

然后要在resources目錄下創(chuàng)建一個(gè)views.properties文件，為我們自定義的view指定一個(gè)名字，就可以在controller中正常使用。

simplePDF.(class)=com.liuwill.text.view.Pdfview
simpleFormPDF.(class)=com.liuwill.text.view.FormPdfview

下載源代碼之后，執(zhí)行gradle bootRun來運(yùn)行Spring Boot，運(yùn)行起來之后，訪問 http://localhost:8888/download 查看結(jié)果。

文／liuwill（簡(jiǎn)書作者）
原文鏈接：Spring Boot集成Freemarker和iText生成PDF文檔
著作權(quán)歸作者所有，轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán)，并標(biāo)注“簡(jiǎn)書作者”。