XHTMLRenderer詳解

一、概述

XHTMLRenderer是一個Java類庫，可以將XML、XHTML、HTML和SVG文檔渲染成PDF、圖片、Swing UI和Java2D輸出。它使用開源渲染引擎Flying Saucer，基於CSS2.1規範實現，支持部分CSS3特性，兼容大多數現代瀏覽器。

該類庫運行於Java 1.5及以上版本，具有高度的可擴展性和定製性，常用於企業級應用開發、電子書製作、報表生成等領域。

二、基礎應用

使用XHTMLRenderer將XHTML文檔渲染成PDF文件，需要進行如下步驟：

// 1. 創建Document對象，指定XHTML文檔路徑
String inputUrl = new File("index.html").toURI().toURL().toString();
Document document = XMLResource.load(new URL(inputUrl)).getDocument();

// 2. 創建PDF繪製器
PDFRenderer renderer = new PDFRenderer();

// 3. 創建PDF輸出流，指定輸出路徑
OutputStream outputStream = new FileOutputStream(new File("output.pdf"));

// 4. 渲染並輸出PDF文件
renderer.setDocument(document, inputUrl);
renderer.layout();
renderer.createPDF(outputStream);
outputStream.close();

這段代碼將XHTML文檔index.html渲染成output.pdf文件，並輸出到指定文件路徑下。

三、高級應用

XHTMLRenderer具有高度的可定製性和擴展性，可通過添加自定義的用戶代理、樣式表和事件處理程序等方式進行定製。

四、示例代碼

以下是一個完整的XHTMLRenderer示例代碼：

import org.xhtmlrenderer.pdf.ITextRenderer;
import org.w3c.dom.Document;

import java.io.*;
import java.net.URL;
import java.nio.charset.StandardCharsets;

public class XHTMLRendererExample {

    public static void main(String[] args) throws Exception {

        // 1. 創建Document對象，指定XML文檔路徑
        String inputUrl = new File("index.xhtml").toURI().toURL().toString();
        Document document = XMLResource.load(new URL(inputUrl)).getDocument();

        // 2. 創建PDF繪製器
        ITextRenderer renderer = new ITextRenderer();

        // 3. 設置字體路徑，可省略
        renderer.getFontResolver().addFontDirectory("/usr/share/fonts/truetype/");

        // 4. 自定義用戶代理，可省略
        renderer.getSharedContext().setUserAgentCallback(new MyUserAgent());

        // 5. 添加事件處理程序，可省略
        renderer.setDocument(document, inputUrl);
        renderer.getSharedContext().setReplacedElementFactory(new MyImageReplacedElementFactory());

        // 6. 設置樣式表，可省略
        String css = readFileToString(new File("test.css"), StandardCharsets.UTF_8);
        renderer.getSharedContext().getCss().addStyleSheet(new InputSource(new StringReader(css)), CSSImportResource.URI);

        // 7. 創建PDF輸出流，並設置頁面大小和邊距，可省略
        OutputStream outputStream = new FileOutputStream(new File("output.pdf"));
        renderer.setDocument(document, inputUrl);
        renderer.layout();
        renderer.createPDF(outputStream);

        outputStream.close();
    }

    private static String readFileToString(File file, Charset encoding) throws IOException {
        try (InputStream inputStream = new FileInputStream(file)) {
            byte[] bytes = new byte[(int) file.length()];
            inputStream.read(bytes);
            return new String(bytes, encoding);
        }
    }
}

五、小結

XHTMLRenderer是一個優秀的Java類庫，能夠將XML、XHTML、HTML和SVG文檔渲染成PDF、圖片、Swing UI和Java2D輸出。它具有高度的可擴展性和定製性，可應用於企業級應用開發、電子書製作、報表生成等領域。