# pdf-fill

**Repository Path**: cocoknight/pdf-fill

## Basic Information

- **Project Name**: pdf-fill
- **Description**: pdf表单填充
- **Primary Language**: Unknown
- **License**: WTFPL
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-25
- **Last Updated**: 2025-09-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PDF Fill 项目说明文档

## 项目简介
PDF Fill 是一个基于 Java 的开源项目，旨在提供便捷的 PDF 文件填充功能。该项目可以将动态数据填充到预定义的 PDF 模板中，适用于生成个性化文档，如合同、报告等。

## 主要功能
- **PDF 模板填充**：支持将动态数据填充到 PDF 模板中。
- **多字体支持**：内置字体和自定义字体支持，确保生成的 PDF 文件兼容不同语言和字符集。
- **文件预览与下载**：提供 PDF 文件的在线预览和下载功能。
- **灵活配置**：通过配置文件可以轻松调整字体路径、模板路径等参数。

## 技术栈
- **Spring Boot**：用于快速构建微服务。
- **iText**：用于处理 PDF 文件的生成和填充。
- **YAML**：配置文件格式。
- **RESTful API**：提供 HTTP 接口供外部调用。

## 项目结构
- `src/main/java`：Java 源代码目录。
- `src/main/resources`：资源文件目录，包括字体、模板和静态文件。
- `src/test/java`：单元测试代码。
- `pom.xml`：Maven 项目配置文件。
- `application.yml`：Spring Boot 配置文件。

## 安装与部署
### 环境要求
- Java 11 或更高版本
- Maven 3.x
- Spring Boot 2.x

### 安装步骤
1. 克隆项目到本地：
   ```bash
   git clone https://gitee.com/cocoknight/pdf-fill.git
   ```
2. 进入项目目录并构建：
   ```bash
   cd pdf-fill
   mvn clean install
   ```
3. 启动项目：
   ```bash
   mvn spring-boot:run
   ```

## 使用说明
### 填充 PDF 模板
1. 准备 PDF 模板文件并放置在 `src/main/resources/template/` 目录下。
2. 通过 HTTP 请求调用 `/pdf/preview/{template}` 接口，传入需要填充的数据。

示例请求：
```http
GET /pdf/preview/templatepdf.pdf?name=张三&sex=男&birthday=1990-01-01&jobResume=软件工程师 HTTP/1.1
```

### 自定义字体
1. 将自定义字体文件（如 `STKAITI.TTF`）放置在 `src/main/resources/fonts/` 目录下。
2. 在 `application.yml` 中配置字体路径：
   ```yaml
   pdffill:
     font:
       path: classpath:fonts/STKAITI.TTF
   ```

## 贡献指南
欢迎贡献代码！请遵循以下步骤：
1. Fork 项目仓库。
2. 创建新分支并提交更改。
3. 提交 Pull Request 并描述修改内容。

## 许可证
本项目采用 MIT 许可证。详情请查看项目根目录下的 LICENSE 文件。

## 联系方式
如有问题或建议，请提交 Issue 或联系项目维护者。