首页
/ Flying Saucer 技术文档

Flying Saucer 技术文档

2024-12-20 18:32:49作者:农烁颖Land

1. 安装指南

环境要求

Flying Saucer 从版本 9.5.0 开始,需要 Java 11 或更高版本。从版本 9.6.0 开始,需要 Java 17 或更高版本。

获取 Flying Saucer

Flying Saucer 通过 Maven 进行分发。可用的构件有:

  • org.xhtmlrenderer:flying-saucer-core - 核心库和 Java2D 渲染
  • org.xhtmlrenderer:flying-saucer-pdf - 使用 OpenPDF 进行 PDF 输出(例如 iText 2.x)
  • org.xhtmlrenderer:flying-saucer-pdf-openpdf - 已不再支持(被 flying-saucer-pdf 替代)
  • org.xhtmlrenderer:flying-saucer-swt - SWT 输出
  • org.xhtmlrenderer:flying-saucer-log4j - log4j 的日志插件

您可以通过 Maven Central 仓库来获取这些构件。

依赖关系

flying-saucer-coreflying-saucer-pdfflying-saucer-swt 必须在构建路径上,以及对应操作系统的 SWT JAR 文件。

2. 项目的使用说明

要使用 Flying Saucer,您可以参考 flying-saucer-examples 目录下的示例代码。

以下是一些重要的入口点:

  • org.xhtmlrenderer.demo.browser.BrowserStartup - 启动浏览器演示
  • org.xhtmlrenderer.simple.XHTMLPanel
  • org.xhtmlrenderer.pdf.PDFRenderer
  • org.xhtmlrenderer.simple.ImageRenderer

3. 项目API使用文档

由于 Flying Saucer 是一个纯 Java 库,您可以直接通过其提供的 API 来使用它。以下是简要的 API 使用说明:

  • 使用 XHTMLPanel 将 XHTML 渲染到 Swing 面板上。
  • 使用 PDFRenderer 将 XHTML 转换为 PDF。
  • 使用 ImageRenderer 将 XHTML 渲染为图像。

具体的 API 使用方法,您可以参考项目的 Javadoc 文档或者示例代码。

4. 项目安装方式

如前所述,您可以通过 Maven 来获取 Flying Saucer。以下是添加到 Maven pom.xml 文件中的依赖示例:

<dependencies>
    <dependency>
        <groupId>org.xhtmlrenderer</groupId>
        <artifactId>flying-saucer-core</artifactId>
        <version>版本号</version>
    </dependency>
    <!-- 其他依赖,如 flying-saucer-pdf 等 -->
</dependencies>

请替换 版本号 为最新的或者您需要的版本。

以上是关于 Flying Saucer 的技术文档,希望对您使用该项目有所帮助。如果您有任何问题或需要进一步的帮助,请访问项目的 讨论组 获取支持。

登录后查看全文
热门项目推荐