开发工具文档【免费下载链接】plantumlGenerate diagrams from textual description项目地址https://gitcode.com/gh_mirrors/pl/plantuml点击查看免费下载本篇技术指南聚焦于 PlantUML 仓库中内置的 ditaaDiagrams Through ASCII Art引擎——即org.stathissideris.ascii2image包及其核心子包core。文章将说明该包在 PlantUML 中的定位内部拷贝的 ditaa 代码、startditaa语法的选项解析、从 ASCII 文本栅格到最终 PNG 图片的完整转换流程以及相关选项类的默认值与作用帮助读者理解 PlantUML 的 DITAA 图是如何从一行行字符“生长”成矢量级清晰位图的。背景PlantUML 内置了一份 ditaa 源码根据仓库中 core/readme.md 的说明org.stathissideris.ascii2image包是ditaa 项目Stathis Sideris 编写的内部拷贝随 PlantUML 源码一并分发目的是提供源代码引用与文档。该文档还给出了明确指引更多信息参见 net/sourceforge/plantuml/ditaa/readme.md后者将这套代码定位为“管理 PlantUML Ditaa Diagram 的类”。值得注意的细节仓库根目录下的readme.md文件明确标注为附加说明Disclaimer: “This file was not part of the original package”即它并非 ditaa 原始包的一部分而是 PlantUML 为便于溯源而补入的文档源码版权头例如 ConversionOptions.java 顶部保留了 “ditaa - Diagrams Through ASCII Art, Copyright (C) 2004-2011 Efstathios Sideris”并声明采用GNU Lesser General Public License v3与 ditaa 的原始开源许一致。因此要真正理解这个包需要同时看两部分org.stathissideris.ascii2imageditaa 本体负责文本解析与图像渲染与net.sourceforge.plantuml.ditaaPlantUML 侧的适配层负责语法识别与参数传递。包结构与职责划分org.stathissideris.ascii2image包按职责分为三个子包子包职责关键类core转换/处理/渲染选项、配置解析ConversionOptions、ProcessingOptions、RenderingOptions、ConfigurationParser、DocBookConverter、DebugUtils、PairtextASCII 文本栅格的读取与结构化TextGrid、AbstractionGrid、CellSet、GridPattern、GridPatternGroup、StringUtils、AbstractCellgraphics从栅格抽象出图形对象并渲染为位图Diagram、DiagramShape、DiagramText、DiagramComponent、BitmapRenderer、FontMeasurer、ImageHandler、CustomShapeDefinition整个流程可以概括为“文本 → 栅格 → 抽象图形 → 位图”四步对应关系如下ASCII 文本行 │ TextGrid.initialiseWithLines(...) ▼ 文本栅格 (text 包) │ new Diagram(grid, options) ▼ 图形抽象 (graphics 包Diagram / DiagramShape / DiagramText) │ BitmapRenderer.renderToImage(diagram, renderingOptions) ▼ BufferedImage → PNG 输出转换管线从startditaa到 PNGPlantUML 侧的入口是 net/sourceforge/plantuml/ditaa/PSystemDitaa.java。它继承自DirectOsDiagram核心逻辑集中在exportDiagramNow()方法中完整调用链如下收集文本行PSystemDitaaFactory逐行调用add(line)把startditaa与endditaa之间的原始 ASCII 内容累积起来同时计算所有行的最小前导空格数nbStartingSpace用于后续统一左对齐裁剪建立栅格TextGrid.initialiseWithLines(lines, null)将每行StringBuilder填充进字符栅格作为后续形状识别的基础数据结构构造图形抽象new Diagram(grid, options)依据栅格中的-、|、、/、\、*等字符识别矩形、圆角框、箭头、文本标签等图形元素DiagramShape、DiagramText渲染位图BitmapRenderer.renderToImage(diagram, options.renderingOptions)把抽象图形画成BufferedImage写出结果SImageIO.write(..., png, os)输出 PNG若请求的格式是ATXT则直接把原始 ASCII 源文本回写os.write(getSource().getPlainString(...))相当于“原样导出文本”。此外渲染过程中若抛出任何异常exportDiagramNow会走CrashReportHandler生成崩溃报告DITAA has crashed并调用exportDiagramError输出错误图而不是让进程整体失败——这是 PlantUML 对内置引擎的容错设计。从 DiagramType.java 的枚举可见DITAA是 PlantUML 官方支持的一等图类型与SEQUENCE、CLASS、GANTT等并列由PSystemDitaaFactory在识别到ditaa起始行时实例化。选项体系三个 Options 类各司其职ditaa 引擎将配置拆成三类对象全部集中在core包中ProcessingOptions—— 文本处理阶段选项位于 ProcessingOptions.java控制“如何解读 ASCII 文本”配置项默认值说明performSeparationOfCommonEdgestrue是否执行公共边分离让相邻方框的共享边合并对应-E/--no-separation取反allCornersAreRoundfalse是否所有角都渲染为圆角对应-r/--round-cornerstabSize8Tab 字符展开宽度exportFormatFORMAT_PNG导出格式同时定义FORMAT_JPEG、FORMAT_GIF常量tagProcessingModeUSE_TAGS标签处理模式USE_TAGS/RENDER_TAGS/IGNORE_TAGScolorCodesProcessingModeUSE_COLOR_CODES颜色代码处理模式USE_COLOR_CODES/RENDER_COLOR_CODES/IGNORE_COLOR_CODEScustomShapes空映射通过ConfigurationParser从配置文件加载的自定义形状定义RenderingOptions—— 渲染阶段选项位于 RenderingOptions.java控制“如何把图形画成图片”配置项默认值说明dropShadowstrue是否绘制投影对应-S/--no-shadows取反antialiastrue是否启用抗锯齿fixedSlopefalse梯形/平行四边形侧边取固定斜率还是固定宽度cellWidth/cellHeight10/14字符单元格尺寸像素setScale()会等比缩放scale1整体缩放系数对应scale参数backgroundColor白色背景色透明度 255时needsTransparency()返回trueimageTypePNG输出类型枚举PNG/SVGfontFamilyCourier默认字体设置fontURL后变为CustomConversionOptions—— 顶层聚合入口ConversionOptions.java 是两者的聚合容器持有processingOptions与renderingOptions各一份并对外提供便捷方法例如setDropShadows(boolean)直接转发给渲染选项、setDebug(boolean)同时打开处理调试输出与渲染调试线。PSystemDitaa的构造器正是通过这一个对象完成全部参数装配options.setDropShadows(dropShadows); options.renderingOptions.setBackgroundColor(transparentBackground ? new XColor(0, 0, 0, 0).toAwtColor() : XColor.WHITE.toAwtColor()); options.renderingOptions.setScale(scale); options.processingOptions.setPerformSeparationOfCommonEdges(performSeparationOfCommonEdges); options.processingOptions.setAllCornersAreRound(allCornersAreRound);ConfigurationParser—— 自定义形状ConfigurationParser.java 负责读取 ditaa 配置文件识别include、shape、shapes三种 XML 标签把自定义形状解析为CustomShapeDefinition并存入HashMap供ProcessingOptions在识别图形时查询。这是 ditaa 支持“自定义形状库”的底层机制PlantUML 的startditaa语法中未直接暴露该能力属于 ditaa 本体功能。PlantUML 侧的参数解析与默认值PSystemDitaaFactory.java 负责把startditaa起始行中的选项字符串翻译成上述选项对象。它支持两组入口initDiagram起始行即ditaa的情形与executeLine遇到ditaa或ditaa(...)行时。可识别参数如下起始行参数含义默认值-E/--no-separation关闭公共边分离默认开启分离-S/--no-shadows关闭投影默认开启投影-r/--round-corners所有角使用圆角默认直角-T/--transparent透明背景背景色 Alpha 置 0默认白色背景scale数字缩放系数正则scale([\d.])匹配默认1从源码看部分 ditaa 原生命令行选项如--font-size、--font-family、--font-variant在工厂中被注释掉说明 PlantUML 侧仅暴露上述子集同时DiagramType的识别逻辑说明startditaa需要遵循start前缀DiagramType.java 中findStartTypes要求文本以或\开头。一个典型用例startditaa scale1.5 -T -------- ------- ------- | --- ditaa ------ | | Text | ------- | PNG | | ASCII | | out | -------- ------- endditaascale1.5会被extractScale的正则捕获使RenderingOptions的cellWidth10与cellHeight14等比放大到 15 与 21从而得到更高分辨率的输出-T则令背景完全透明。引擎能力边界与适用场景结合源码可以归纳出这套内置引擎的适用场景与限制输入是等宽字符画引擎按“字符单元格”理解图形表示拐角、-与|表示边线文字行则成为DiagramText因此书写时应对齐列、使用等宽字体环境输出以 PNG 为主PSystemDitaa.exportDiagramNow固定走SImageIO.write(..., png, os)ATXT格式仅原样回写文本不产生渲染效果出错有兜底渲染异常不会中断整个 PlantUML 进程而是生成DITAA has crashed风格的错误图便于定位问题适合“涂鸦转正式图”原型/线框/流程图草稿可直接用 ASCII 描述无需学习 UML 语法适合快速草图、文档内嵌示意图等场景。小结org.stathissideris.ascii2image.core在 PlantUML 中承担的是ditaa 引擎的配置中枢ProcessingOptions决定如何理解字符栅格RenderingOptions决定如何绘制像素ConversionOptions聚合两者而 PlantUML 的PSystemDitaaFactoryPSystemDitaa则把startditaa语法桥接到这条文本转图像的管线之上。想继续深入建议按此顺序阅读源码PSystemDitaaFactory.java参数入口→ PSystemDitaa.java调用链→ ConversionOptions.java选项装配→ RenderingOptions.java渲染默认值。赞分享开发工具文档【免费下载链接】plantumlGenerate diagrams from textual description项目地址https://gitcode.com/gh_mirrors/pl/plantuml点击查看免费下载相关推荐ditaa一个强大的ASCII艺术图转换工具ditaa一个强大的ASCII艺术图转换工具 项目基础介绍和主要编程语言 ditaaDIagrams Through Ascii Art是一个用Java编Notepad--跨平台文本编辑器的编码处理与多文件管理实战指南Notepad 跨平台文本编辑器的编码处理与多文件管理实战指南 你是否曾因不同操作系统间的文本编码问题而头疼是否在处理多个项目文件时感到手忙脚乱作为一款支桌面应用深入解析Image-to-ASCII将图像转换为ASCII艺术的技术实现深入解析Image to ASCII将图像转换为ASCII艺术的技术实现 项目概述 Image to ASCII是一个功能强大的图像处理工具它能够将普通图像图像处理创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考