133 Star 653 Fork 135

xsx / x-easypdf

加入 Gitee
与超过 600 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md

一个用搭积木的方式构建pdf的框架(基于pdfbox)

star

更新说明

master分支将作为稳定版本发布,develop分支将会不定期进行更新,欢迎大家提供宝贵意见,目前稳定版本 v2.5.0

介绍

x-easypdf基于pdfbox构建而来,极大降低使用门槛,以组件化的形式进行pdf的构建。简单易用,仅需一行代码,便可完成pdf的操作

API文档

https://apidoc.gitee.com/xsxgit/x-easypdf

特性

  1. 轻量级

仅添加pdfbox相关依赖,无其他任何依赖

  1. 简单易用

仅需一行代码,便可完成pdf的操作

  1. 自动换行分页

文本超出单行显示时,即可自动换行;内容超出单页显示时,即可自动分页

  1. 模板填充

提供内置方法,可轻松实现模板填充

  1. 组件化

页面所有内容均采用组件化形式进行构建,使用不同的组件组合方式,即可构造出理想的文档

  1. 扩展灵活

只需实现系统提供的接口,即可完成自定义的组件扩展

软件架构

软件架构

  1. document(文档):PDF文档
  2. page(页面):若干个页面组成PDF文档
  3. watermark(水印):每个页面可设置页面级别的独立水印,也可设置文档级别的全局水印,优先级为:页面级别>文档级别
  4. header(页眉):每个页面可设置页面级别的独立页眉,也可设置文档级别的全局页眉,优先级为:页面级别>文档级别
  5. footer(页脚):每个页面可设置页面级别的独立页脚,也可设置文档级别的全局页脚,优先级为:页面级别>文档级别
  6. component(组件):核心,每个页面由若干个组件构成

text(文本组件):已提供,文本写入组件

line(线条组件):已提供,线条写入组件

image(图片组件):已提供,图片写入组件

table(表格组件):已提供,表格写入组件,cell(单元格)->row(行)->table(表格)

rect(矩形组件):已提供,矩形写入组件

后续将添加更多其他方便实用的组件。。。

maven坐标

<dependency>
    <groupId>wiki.xsx</groupId>
    <artifactId>x-easypdf</artifactId>
    <version>2.5.0</version>
</dependency>

安装教程

mvn clean install

使用说明

  1. 简单小示例

代码如下:

public class XpdfTest {
    public static void main(String[] args) throws IOException {
        // 定义保存路径
        final String outputPath = "D:\\pdf\\my.pdf";
        // 定义页眉与页脚字体颜色
        Color headerAndFooterColor = new Color(10, 195, 255);
        // 定义分割线颜色
        Color lineColor = new Color(210, 0, 210);
        // 获取背景图片
        try (InputStream backgroundImageInputStream = new URL("https://i0.hdslb.com/bfs/article/1e60a08c2dfdcfcd5bab0cae4538a1a7fe8fc0f3.png").openStream()) {
            // 设置背景图片
            XEasyPdfHandler.Document.build().setGlobalBackgroundImage(
                    // 构建图片并垂直居中
                    XEasyPdfHandler.Image.build(backgroundImageInputStream, XEasyPdfImageType.PNG).enableVerticalCenterStyle()
                    // 设置全局页眉
            ).setGlobalHeader(
                    // 构建页眉
                    XEasyPdfHandler.Header.build(
                            // 构建页眉文本,并居中显示
                            XEasyPdfHandler.Text.build("这是粗体页眉")
                                    // 设置水平居中
                                    .setStyle(XEasyPdfTextStyle.CENTER)
                                    // 设置字体大小
                                    .setFontSize(20F)
                                    // 设置字体颜色
                                    .setFontColor(headerAndFooterColor)
                                    // 使用粗体字
                                    .setDefaultFontStyle(XEasyPdfDefaultFontStyle.BOLD)
                    )
                    // 设置全局页脚
            ).setGlobalFooter(
                    // 构建页脚
                    XEasyPdfHandler.Footer.build(
                            // 构建页脚文本,并居中显示
                            XEasyPdfHandler.Text.build("这是粗体页脚")
                                    // 设置水平居中
                                    .setStyle(XEasyPdfTextStyle.CENTER)
                                    // 设置字体大小
                                    .setFontSize(20F)
                                    // 设置字体颜色
                                    .setFontColor(headerAndFooterColor)
                                    // 使用粗体字
                                    .setDefaultFontStyle(XEasyPdfDefaultFontStyle.BOLD)
                    )
                    // 添加页面
            ).addPage(
                    // 构建页面
                    XEasyPdfHandler.Page.build(
                            // 构建文本
                            XEasyPdfHandler.Text.build(
                                    "x-easypdf简介(细体)"
                            ).setStyle(XEasyPdfTextStyle.CENTER)
                                    // 设置字体大小
                                    .setFontSize(30F)
                                    // 设置上边距
                                    .setMarginTop(20F)
                                    // 使用细体字
                                    .setDefaultFontStyle(XEasyPdfDefaultFontStyle.LIGHT)
                            // 构建文本
                            ,XEasyPdfHandler.Text.build(
                                    "x-easypdf是一个基于PDFBOX的开源框架,"
                            ).setFontSize(16F).setFontColor(new Color(51, 0, 153))
                            // 构建文本
                            ,XEasyPdfHandler.Text.build(
                                    "专注于PDF文件导出功能,"
                            ).enableTextAppend().setFontSize(16F).setFontColor(new Color(102, 0, 153))
                            // 构建文本
                            ,XEasyPdfHandler.Text.build(
                                    "以组件形式进行拼接,"
                            ).enableTextAppend().setFontSize(16F).setFontColor(new Color(153, 0, 153))
                            // 构建文本
                            ,XEasyPdfHandler.Text.build(
                                    "简单、方便,功能丰富,"
                            ).enableTextAppend().setFontSize(16F).setFontColor(new Color(204, 0, 153))
                            // 构建文本
                            ,XEasyPdfHandler.Text.build(
                                    "欢迎大家试用并提出宝贵意见。"
                            ).enableTextAppend().setFontSize(16F).setFontColor(new Color(255, 0, 153))
                            // 构建文本
                            ,XEasyPdfHandler.Text.build(
                                    "-- by xsx"
                            ).setStyle(XEasyPdfTextStyle.RIGHT).setMarginTop(10F).setMarginRight(10F)
                            // 构建文本
                            ,XEasyPdfHandler.Text.build(
                                    "2021.10.10"
                            ).setStyle(XEasyPdfTextStyle.RIGHT).setMarginTop(10F).setMarginRight(10F)
                            // 构建实线分割线
                            ,XEasyPdfHandler.SplitLine.SolidLine.build().setMarginTop(10F).setColor(lineColor).setContentMode(XEasyPdfComponent.ContentMode.PREPEND)
                            // 构建虚线分割线
                            ,XEasyPdfHandler.SplitLine.DottedLine.build().setLineLength(10F).setMarginTop(10F).setLineWidth(10F).setColor(lineColor).setContentMode(XEasyPdfComponent.ContentMode.PREPEND)
                            // 构建实线分割线
                            ,XEasyPdfHandler.SplitLine.SolidLine.build().setMarginTop(10F).setColor(lineColor).setContentMode(XEasyPdfComponent.ContentMode.PREPEND)
                    )
                    // 保存并关闭文档
            ).save(outputPath).close();
        }
    }
}

效果如下:

示例效果

  1. 使用说明

请查看wiki

仓库评论 ( 211 )

你可以在登录后,发表评论

简介

一个用搭积木的方式构建pdf的框架(基于pdfbox) 展开 收起
Java 等 2 种语言
MulanPSL-2.0
取消

x-easypdf

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/xsxgit/x-easypdf.git
git@gitee.com:xsxgit/x-easypdf.git
xsxgit
x-easypdf
x-easypdf
master

搜索帮助

161121 f78d6d6f 1850385 154831 86f8c370 1850385