itextpdf freemarker渲染

陳灬大灬海發表於2020-11-13

現有需求涉及到列印pdf操作，簡單找了倆種方式

  1. 在現有的模板上進行編輯，操作難度比較大
  2. 通過freemarker生成靜態頁面，在進行轉換html，完美。

關於動態生成pdf，網上參考的挺多的，看來看去還是覺得通過FreeMarker+IText生成pdf最為簡單
參考地址 https://www.cnblogs.com/yunfeiyang-88/p/10984740.html
github demo地址 https://github.com/chywx/spring-boot-pdf/blob/freemarker-print/src/main/java/cn/chendahai/html2pdf/JavaToPdfHtmlFreeMarkerBet.java

擼起來

建立springboot工程
新增maven依賴

    <!-- freemarker依賴 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-freemarker</artifactId>
    </dependency>

    <!-- itextpdf依賴 -->
    <dependency>
      <groupId>com.itextpdf</groupId>
      <artifactId>itextpdf</artifactId>
      <version>5.5.13.2</version>
    </dependency>

    <!-- 更好的css支援 -->
    <dependency>
      <groupId>org.xhtmlrenderer</groupId>
      <artifactId>flying-saucer-pdf</artifactId>
      <version>9.1.20</version>
    </dependency>

application.properties配置freemarker，預設配置

spring.freemarker.charset=UTF-8
spring.freemarker.suffix=.ftl
spring.freemarker.content-type=text/html; charset=utf-8
spring.freemarker.template-loader-path=classpath:/templates
spring.mvc.static-path-pattern=/static/**

測試程式碼

public class JavaToPdfHtmlFreeMarkerBet {

    private static final String DEST = "target/bet-gg.pdf";
    private static final String HTML = "index7.html";

    private static final String IMG_PATH = "file:///D:/project/javaproject/spring-boot-pdf/src/main/resources/static/";

    private static Configuration freemarkerCfg;

    static {
        freemarkerCfg = new Configuration();
        //freemarker的模板目錄
        try {
            freemarkerCfg.setDirectoryForTemplateLoading(new File("src/main/resources/templates/betPrint"));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) throws IOException, DocumentException, com.lowagie.text.DocumentException {
        Map<String, Object> data = new HashMap();
        data.put("name", "dahai");
        String content = JavaToPdfHtmlFreeMarkerBet.freeMarkerRender(data, HTML);
        JavaToPdfHtmlFreeMarkerBet.createPdf(content, DEST);
    }

    /**
     * freemarker渲染html
     */
    public static String freeMarkerRender(Map<String, Object> data, String htmlTmp) {
        Writer out = new StringWriter();
        try {
            // 獲取模板,並設定編碼方式
            Template template = freemarkerCfg.getTemplate(htmlTmp);
            template.setEncoding("UTF-8");
            // 合併資料模型與模板
            template.process(data, out); //將合併後的資料和模板寫入到流中，這裡使用的字元流
            out.flush();
            return out.toString();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                out.close();
            } catch (IOException ex) {
                ex.printStackTrace();
            }
        }
        return null;
    }

    public static void createPdf(String content, String dest) throws IOException, com.lowagie.text.DocumentException {
        ITextRenderer render = new ITextRenderer();
        // 解析html生成pdf
        render.setDocumentFromString(content);
        //解決圖片相對路徑的問題
        render.getSharedContext().setBaseURL(IMG_PATH);
        render.layout();
        render.createPDF(new FileOutputStream(dest));
    }
}

web環境

獲取模板的話可以直接通過注入FreeMarkerConfigurer來獲取

    @Autowired
    FreeMarkerConfigurer freeMarkerConfigurer;

Template template = freeMarkerConfigurer.getConfiguration().getTemplate("betPrint/print_match.ftl");

設定邊距

由於是通過模板進行渲染，所以邊距需要前端來進行控制

@page {
    margin: 0in 0.1in 0in 0.1in;
    mso-header-margin: .5in;
    mso-footer-margin: .5in;
    mso-page-orientation: landscape;
}

但是列印的時候如果選擇實際大小，那會導致前面的配置失效

pdf流形式返回

該例項是直接在本地磁碟生成pdf，如果是web環境下，可以通過生成流的方式，直接返回給客戶端，避免了磁碟io
方式就是將
render.createPDF(new FileOutputStream(dest));
修改為
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
render.createPDF(outputStream);

總結：

  1. html的格式要求符合xml格式，必須要有閉合標籤。比如<input />只能寫成<input></input>
  2. 由於這是服務端生成的，自然跟客戶端扯不上關係，這一點很好。但是跟window和linux還是有些細小的區別。比如linux字型的最小為12px
  3. CSS有些語法不支援，比如C3就不支援
  4. 載入圖片可以使用file://協議，linux也是支援的。還有，簡單起見，可以直接使用http載入網路圖片
  5. 由於是通過模板渲染，邊距，分頁等設定就是前端的事了 比如height: 100%;box-sizing: border-box;即可實現

相關文章