如何快速搭建 PlantUML Server：在线UML图表生成的终极指南 🚀

PlantUML Server 是一款强大的开源Web应用，能够帮助开发者快速生成各种UML图表。无论是流程图、时序图还是类图，只需简单几步，你就能拥有自己的在线UML绘图工具。本文将带你全面了解如何从零开始搭建、配置和使用 PlantUML Server，让图表绘制变得轻松高效。

📋 核心功能与环境要求

PlantUML Server 作为一款专业的在线UML图表生成工具，支持多种图表类型和灵活的部署方式。它基于Java开发，可通过Maven直接启动或Docker容器化部署，满足不同场景的使用需求。

系统环境要求

• JRE/JDK 11 或更高版本
• Apache Maven 3.0.2 或更高版本
• 推荐使用 Jetty 11+ 或 Tomcat 10+ 作为应用服务器

PlantUML Server 主界面展示，包含代码编辑区和实时预览功能的分屏设计

⚡ 两种快速启动方式

1️⃣ Maven 直接启动（适合开发测试）

无需复杂配置，通过Maven命令即可一键启动嵌入式Jetty服务器：

mvn jetty:run

服务器默认监听 http://localhost:8080/plantuml。如需自定义端口，可添加 -Djetty.http.port 参数：

mvn jetty:run -Djetty.http.port=9999

2️⃣ Docker 容器化部署（适合生产环境）

推荐使用Docker方式部署，简单高效且环境隔离：

# Jetty版本（轻量级，推荐）
docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

# Tomcat版本（企业级应用服务器）
docker run -d -p 8080:8080 plantuml/plantuml-server:tomcat

服务器启动后访问 http://localhost:8080 即可使用。

🔒 安全加固：只读容器模式

Jetty版本支持只读文件系统，增强容器安全性：

docker run -d -p 8080:8080 --read-only -v /tmp/jetty plantuml/plantuml-server:jetty

🔧 自定义配置指南

修改基础URL路径

通过环境变量 BASE_URL 可自定义访问路径。编辑 docker-compose.yml：

environment:
  - BASE_URL=plantuml

然后启动服务：

docker-compose up

此时访问地址变为 http://localhost:8080/plantuml。

关键环境变量配置

PlantUML Server 支持多种环境变量配置，满足不同需求：

变量名	说明	默认值
PLANTUML_SECURITY_PROFILE	安全配置文件	INTERNET
PLANTUML_LIMIT_SIZE	图片尺寸限制	4096
PLANTUML_STATS	启用统计报告	off
HTTP_PROXY_READ_TIMEOUT	代理超时时间(ms)	10000

配置示例（Docker方式）：

docker run -d -p 9999:8080 \
  -e PLANTUML_SECURITY_PROFILE=INTERNET \
  -e PLANTUML_LIMIT_SIZE=8192 \
  plantuml/plantuml-server:jetty

🛠️ 高级部署方案

源码构建Docker镜像

如需自定义功能，可从源码构建Docker镜像：

# 克隆仓库
git clone https://gitcode.com/gh_mirrors/pl/plantuml-server

# 构建Jetty版本镜像
docker image build -f Dockerfile.jetty -t plantuml-server:local .

# 运行自定义镜像
docker run -d -p 8080:8080 plantuml-server:local

生成WAR包部署

适合将应用部署到现有Java应用服务器：

# 构建标准WAR包
mvn package

# 生成包含JSP支持的WAR包
mvn package -Dapache-jsp.scope=compile

# JDK8兼容版本
rm -rf src/test
mvn package -f pom.jdk8.xml

生成的WAR包位于 target/ 目录下，可直接部署到Tomcat等服务器。

📱 WebUI功能亮点

PlantUML Server 提供直观易用的Web界面，主要功能包括：

• 实时预览：编辑UML代码时即时查看渲染效果
• 多格式导出：支持PNG、SVG、PDF等多种格式
• 语法自动补全：提供UML关键词和图标快速提示
• 主题切换：支持多种图表样式自定义

详细功能说明可参考项目文档：docs/WebUI

🔄 使用反向代理

PlantUML Server 可配合Nginx等反向代理使用，项目提供多种配置示例：

• examples/nginx-simple：基础Nginx配置
• examples/nginx-contextpath：带上下文路径的配置

通过反向代理可实现负载均衡、SSL终止等高级功能，适合生产环境部署。

🎯 总结

通过本文介绍的方法，你已经掌握了 PlantUML Server 的搭建、配置和使用技巧。无论是开发团队协作还是个人项目文档编写，这款工具都能显著提高UML图表的绘制效率。立即尝试搭建属于你的在线UML绘图服务器，让图表绘制变得简单而高效！

需要进一步了解高级功能和配置选项，可以查阅项目官方文档或源代码：src/main/java/net/sourceforge/plantuml/servlet。