MapFish Print 项目技术文档

1. 安装指南

在开始使用 MapFish Print 之前，您需要确保系统中已安装以下依赖项：make 和 Docker。

构建项目

构建 MapFish Print 的命令如下：

make build

此命令将构建三个工件：print-servlet-xxx.war、print-lib.jar 和 print-standalone.jar。

构建过程同时会在 docs/build/site 文件夹中构建文档。要部署文档，只需将其复制到 gh-pages 分支然后提交即可。GitHub 会自动在以下地址构建更新的站点：https://mapfish.github.io/mapfish-print/

如果您只想构建文档，可以运行以下命令：

./gradlew docs:build

或者在文档目录中运行构建命令。

请注意，测试（构建的一部分）需要 'Liberation Sans' 字体，您可以从这里下载。

2. 项目的使用说明

调试模式

为了能够快速测试打印的修改，您应该：

• 将文件 docker-compose.override.sample.yaml 复制为 docker-compose.override.yaml。
• 运行 docker compose up -d，打印服务将可在端口 8080 上访问，代码修改后将自动构建并重启。

使用此方法，您将拥有一个正在运行的打印服务，每次代码修改后，打印服务将重新构建并重启，并且调试端口 5005 将开启。

从命令行运行

以下命令将运行 MapFish 打印服务。参数必须通过 -PprintArgs="..." 参数提供。

要列出所有命令行选项，请在 ./core 目录下执行以下命令：

./gradlew print -PprintArgs="-help"

以下是一个示例命令：

./gradlew print -PprintArgs="-config ../examples/src/test/resources/examples/simple/config.yaml -spec ../examples/src/test/resources/examples/simple/requestData.json -output ./output.pdf"

如果您想以调试模式运行，可以添加 --debug-jvm 参数：

./gradlew print --debug-jvm -PprintArgs="-config ../examples/src/test/resources/examples/simple/config.yaml -spec ../examples/src/test/resources/examples/simple/requestData.json -output ./output.pdf"

对于使用 GeoServer 的示例，您应该在组合中运行它，然后构建并启动组合：

make build
cp docker-compose.override.sample.yaml docker-compose.override.yaml
make acceptance-tests-up

然后运行示例：

docker compose exec builder gradle print -PprintArgs="-config /src/examples/src/test/resources/examples/simple/config.yaml -spec /src/examples/src/test/resources/examples/simple/requestData.json -output /src/examples/output.pdf"

在 Eclipse 中使用

首先创建 Eclipse 项目元数据：

./gradlew eclipse

然后导入项目到 Eclipse。

在 Eclipse 中运行

• 创建新的 Java 运行配置
• 主类是 org.mapfish.print.cli.Main
• 程序参数：-config samples/config.yaml -spec samples/spec.json -output $HOME/print.pdf

3. 项目 API 使用文档

MapFish Print 的 API 使用文档目前没有在项目 README 中提供，但是可以通过查看项目的源代码和示例来了解如何使用 API。

4. 项目安装方式

MapFish Print 可以通过以下几种方式安装：

• Docker：您可以从 Docker 仓库中拉取 MapFish Print 的 Docker 镜像。

• War 和 jar：可以从 MapFish 的 GitHub 包仓库中获取 War 和 jar 文件。

• JitPack 仓库：您也可以从 JitPack 仓库中获取 MapFish Print。

• 发布版本：包括各种资源的发布版本可以在 GitHub 的发布页面上找到。

在安装前请确保您已阅读并遵守项目的贡献者许可协议。如果您是作为个人贡献者，需要提交一份数字版个人贡献者许可协议；如果是作为公司员工，则需要按照指南提交公司贡献者许可协议。