# uml-sequence-diagram-drawio **Repository Path**: zhang-zhanzhong/uml-sequence-diagram-drawio ## Basic Information - **Project Name**: uml-sequence-diagram-drawio - **Description**: 根据文本文件生成 draw.io UML 序列图。 - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 2 - **Created**: 2022-10-29 - **Last Updated**: 2022-10-29 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [![Maven Central](https://img.shields.io/maven-central/v/com.github.adrninistrator/uml-sequence-diagram-drawio.svg)](https://search.maven.org/artifact/com.github.adrninistrator/uml-sequence-diagram-drawio/) [![Apache License 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-green.svg)](https://github.com/Adrninistrator/uml-sequence-diagram-drawio/blob/master/LICENSE) # 1. 前言已有一些工具可以根据文本自动生成UML时序图，如PlantUML（[https://plantuml.com/zh/](https://plantuml.com/zh/)）、Mermaid（[https://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/)）等。但存在一些使用不便之处，例如激活需要手工指定、语法较复杂，不便于记忆、部分功能使用频率较低、不便于人工继续编辑、展示的样式与常见的UML时序图不同等。因此使用Java开发了以下根据文本自动生成UML时序图的工具，激活能够自动生成、语法简单便于记忆，支持大部分UML时序图的功能、生成draw.io格式文件，可以继续编辑、展示的样式与常见的UML时序图一致。本工具生成的UML时序图相关的术语及样式参考了[https://www.uml-diagrams.org/sequence-diagrams.html](https://www.uml-diagrams.org/sequence-diagrams.html)，支持的元素包括：生命线（Lifeline）、激活（Execution/Activation）、消息（Message）。 `当前项目可用于为Java代码自动生成UML时序图`，可参考[https://github.com/Adrninistrator/gen-java-code-uml-sequence-diagram](https://github.com/Adrninistrator/gen-java-code-uml-sequence-diagram)。 # 2. 更新说明 - 0.1.0 支持根据消息文本计算所需高度，不再需要人工指定统一固定高度 - 0.1.1 检查输入文件编码是否为UTF-8-BOM # 3. 示例以下为本工具生成的draw.io格式的UML时序图： ![](pic/example.png) 生成以上UML时序图的文本如下： ``` >>这是一个描述
end~这是一个链接 @小
明 as xm @爸爸 @妈妈 as mm @老师 @请假
系统 as qjxt xm=>xm:~~今天不想上学了~~ xm->妈妈:妈妈我今天不想上学了
我肚子不舒服 xm=>mm: 妈妈我今天肚子不舒服
帮我找老师请个假 mm=>老师:小明今天不舒服
想请个假妈妈<=老师:稍等我查一下记录
等会回复你 xm<=妈妈:老师说要等一会老师=>老师:让我看看小明的请假记录~https://www.baidu.com 老师=>qjxt:查询小明的请假记录老师<=请假
系统:返回数据
今年共请假0次老师=>妈妈:那就让他休息一天吧老师<=妈妈:谢谢老师妈妈->xm:老师同意你请假了 ``` `默认会为每个消息自动添加序号，可以通过后续说明的配置关闭。` `将鼠标移到生命线或激活上方后，会显示对应生命线的描述，便于在时序图较长时查看。` # 4. 根据文本文件生成UML时序图本工具代码地址为： [https://github.com/Adrninistrator/uml-sequence-diagram-drawio/](https://github.com/Adrninistrator/uml-sequence-diagram-drawio/) 。 ## 4.1. 使用方式使用本工具的操作系统中需要安装JDK，并在环境变量中配置对应目录。 ### 4.1.1. 通过命令行执行可从以下地址下载本工具并解压： [https://github.com/Adrninistrator/uml-sequence-diagram-drawio/releases/](https://github.com/Adrninistrator/uml-sequence-diagram-drawio/releases/) 在Windows环境执行时，可在命令行执行以下命令，参数1为文本文件路径（可在资源管理器中将文件拖放到命令行窗口中）： ``` run.bat [文本文件路径] ``` 在开头有文本文件的内容示例，在后续有格式说明，文本文件可使用任意后缀名。 `在Windows环境执行时，还可将文本文件拖动到run.bat图标上执行，操作更简单。` 在Linux等环境执行时，可在命令行执行以下命令，参数1为文本文件路径： ``` sh run.sh [文本文件路径] ``` 执行完毕后，会在文本文件路径所在目录下生成对应的draw.io格式的UML时序图文件。 ### 4.1.2. 在Java项目中执行在Java项目中执行本工具时，可以通过以下方式引入本工具： - Gradle ``` testImplementation 'com.github.adrninistrator:uml-sequence-diagram-drawio:0.1.1' ``` - Maven ```xml com.github.adrninistrator uml-sequence-diagram-drawio 0.1.1 provided ``` 执行com.adrninistrator.usddi.runner.RunnerGenUmlSequenceDiagram类，generate()方法，可以根据指定的文本文件，生成对应的draw.io格式的UML时序图文件。 ## 4.2. 输入文本要求 ### 4.2.1. 输入文本关键字以下关键字用于指定描述： ``` >> ``` 以下关键字用于指定生命线的名称： ``` @ as ``` 以下关键字用于指定消息： ``` => <= -> : ``` 以下关键字用于对描述或消息指定链接： ``` ~ ``` 以下关键字用于指定注释： ``` # ``` ### 4.2.2. 输入文本格式 #### 4.2.2.1. 描述格式描述是指时序图最上部用于说明的文字，与时序图没有关联，仅起说明作用。 - \>\>description 使用“\>\>description”格式指定描述，“description”为描述的内容，可指定任意内容；描述需要在输入文本的最前面指定，只能指定一个描述，也可以不指定。可使用HTML标签设置描述内容的样式，如换行等，可参考后续内容。 ##### 4.2.2.1.1. 链接格式 - \>\>description~link 使用“~link”格式指定描述对应的链接，“link”为链接的内容；点击指定了链接的描述内容后，会显示对应的链接，如下所示： ![](pic/link_description.png) 链接内容可以指定为一般的文字，也可以指定为URL或文件路径（file://），如下所示： ``` file://C:\Windows\System32\calc.exe file://C:\Windows\system.ini https://www.baidu.com ``` 当链接内容指定为URL时，点击链接时会使用默认浏览器打开对应URL；当链接内容指定为文件路径，点击链接时会使用对应文件格式的默认软件打开文件，若对应文件格式未指定默认软件，则不会打开，需要先设置。 #### 4.2.2.2. 生命线格式在输入文本中前面的内容（若有指定描述，则在描述之后），使用以下格式指定生命线，生命线在输入文本中出现的顺序（从上往下）与在UML时序图中的展示顺序（从左往右）一致。 - @name 使用“@name”格式指定生命线，“name”为生命线的名称； - @name as alias 为了简化生命线名称，可使用“@name as alias”格式指定生命线的名称，及别名，“alias”为生命线的别名； #### 4.2.2.3. 消息格式在输入文本中后面面的内容，使用以下格式指定消息，消息在输入文本中出现的顺序（从上往下）与在UML时序图中的展示顺序（从上往下）一致。 `以下的“~L”为可选数据，如果不需要为消息指定链接则不需要指定。` - x=>y:m~L 使用“x=>y:m~L”格式指定同步请求消息； “x”为起点生命线的名称或别名，“y”为终点生命线的名称或别名，“m”为消息内容； - x<=y:m~L 使用“x<=y:m~L”格式指定返回消息； “y”为起点生命线的名称或别名，“x”为终点生命线的名称或别名，“m”为消息内容；同步请求消息与返回消息需要在正确的位置成对出现； - x=>x:m~L 使用“x=>x:m~L”格式指定自调用消息； “x”为生命线的名称或别名，“m”为消息内容； - x->y:m~L 使用“x->y:m~L”格式指定异步消息； “x”为起点生命线的名称或别名，“y”为终点生命线的名称或别名，“m”为消息内容； ##### 4.2.2.3.1. 链接格式以上消息内容中的“L”为链接，可以不指定，格式已在前文说明；为消息指定链接后的示例如下： ![](pic/link_message.png) #### 4.2.2.4. 注释格式在输入文本中，以“#”开头的行代表注释。 #### 4.2.2.5. 时序图开始新的部分格式有时可能需要在一个时序图中展示多个不同部分的时序图，例如在部分1中消息最初的起点对应生命线1，在部分2中消息最初的起点对应生命线2，在这种情况下，可在每个部分的消息之间指定一个或多个空行，如下所示： ``` 部分1消息部分1消息 ... 部分1消息部分2消息部分2消息 ... 部分2消息 ``` ### 4.2.3. 输入文本编码输入文本文件编码需要是UTF-8无BOM。 ### 4.2.4. 消息顺序的要求 `本工具通过栈控制各类消息的处理，因此文本中指定的消息顺序需要符合一定要求，否则无法生成最终的时序图。` 当处理到同步请求消息时，会将当前同步请求消息入栈当处理到返回消息，会将栈顶消息出栈当处理到自调用消息及异步消息时，不会进行入栈或出栈处理 `对于异步消息的终点，不支持作为下一条消息的起点。` ## 4.3. 参数配置 ### 4.3.1. 位置相关参数位置相关参数在配置文件“~usddi_conf/position.properties”中指定，如下所示： |参数名称|参数作用|是否允许为空|默认值| |---|---|---|---| |lifeline.center.horizontal.spacing|生命线中间点的水平间距|非空|无| |lifeline.box.width|生命线的方框宽度|非空|无| |lifeline.box.height|生命线的方框高度|非空|无| |message.vertical.spacing|消息（及与生命线之间）垂直间距|非空|无| |self.call.horizontal.width|自调用消息的水平宽度|非空|无| |activation.width|激活的宽度|非空|无| |parts.extra.vertical.spacing|两个部分之间的额外垂直间距|可选|0| `消息的高度根据消息字体大小与消息行数（
代表换行）计算得出，不需要人工指定` ### 4.3.2. 位置相关参数示例位置相关参数示例如下所示： ![](pic/position_example.png) ### 4.3.3. 样式相关参数样式相关参数在配置文件“~usddi_conf/style.properties”中指定，如下所示： |参数名称|参数作用|是否允许为空|默认值| |---|---|---|---| |message.auto.seq|自动为消息添加序号|可选|是| |line.width.of.lifeline|线条宽度-生命线|可选|1| |line.width.of.activation|线条宽度-激活|可选|1| |line.width.of.message|线条宽度-消息|可选|1| |line.color.of.lifeline|线条颜色-生命线|可选|黑色| |line.color.of.activation|线条颜色-激活|可选|黑色| |line.color.of.message|线条颜色-消息|可选|黑色| |box.color.of.lifeline|方框背景颜色-生命线|可选|白色| |box.color.of.activation|方框背景颜色-激活|可选|白色| |text.font.of.lifeline|文字字体-生命线|可选|Helvetica| |text.font.of.message|文字字体-消息|可选|Helvetica| |text.size.of.lifeline|文字大小-生命线|可选|12| |text.size.of.message|文字大小-消息|可选|12| |text.color.of.lifeline|文字颜色-生命线|可选|黑色| |text.color.of.message|文字颜色-消息|可选|黑色| 颜色相关的参数，应为RGB颜色十六进制形式，即“#xxxxxx”，如“#00ff00”；文字字体相关的参数，应指定字体的名称，如“宋体”、“Times New Roman”；线条宽度相关的参数，支持整数或小数；文字大小相关的参数，支持整数。 ## 4.4. 为某个生命线名称、消息内容文字指定样式以上样式相关参数是对一个UML时序图内统一的参数配置，当需要为某个生命线名称、消息内容文字单独指定样式时，可以按照以下方式实现： ### 4.4.1. 文字字体、大小、颜色文字字体、大小、颜色可通过HTML中的font标签进行设置，如下所示： ```html xxx ``` - 文字字体 ```html xxx ``` - 文字大小 ```html xxx ``` - 文字颜色 ```html xxx ``` ### 4.4.2. 加粗、斜体、下划线、删除线文字加粗、斜体、下划线、删除线可通过HTML中的标签进行设置，如下所示： - 加粗 ```html xxx ``` - 斜体 ```html xxx ``` - 下划线 ```html xxx ``` - 删除线 ```html ~~xxx~~ ``` - 多个样式 ```html ~~xxx~~ ``` 同时指定文字字体、大小、颜色，及加粗、斜体、下划线、删除线时，如下所示： ```html ~~xxx~~ ``` ### 4.4.3. 文字换行当需要使文字换行时，使用以下内容作为换行符： ```
``` ## 4.5. 使用建议 ### 4.5.1. 增加注释提高可读性假如用于生成UML时序图的文本内容太多时，会影响可读性，可通过增加注释的方式，根据消息的作用对消息进行分段，增加可读性例如文本内容如下： ``` @步骤1 as s1 @步骤2 as s2 @步骤3 as s3 @步骤4 as s4 s1=>s2:1 s1<=s2:2 s1=>s1:1 s1=>s1:2 s1=>s1:3 s1=>s1:4 s1=>s2:1 s2=>s3:2 s3=>s4:3 s4=>s4:1 s4=>s4:2 s3<=s4:3 s2<=s3:2 s1<=s2:1 ``` 增加注释后如下，可以看出对可读性有提升： ``` @步骤1 as s1 @步骤2 as s2 @步骤3 as s3 @步骤4 as s4 # 阶段1 s1=>s2:1 s1<=s2:2 # 阶段2 s1=>s1:1 s1=>s1:2 s1=>s1:3 s1=>s1:4 # 阶段3 s1=>s2:1 s2=>s3:2 s3=>s4:3 s4=>s4:1 s4=>s4:2 s3<=s4:3 s2<=s3:2 s1<=s2:1 ``` `注意，增加文本可读性时需要使用注释“#”，不能使用空行，否则会当作时序图需要开始新的部分` ### 4.5.2. 使用文本编辑器语法高亮为了进一步提高用于生成UML时序图的文本的可读性，可将文本文件的后缀名修改为“.md”，使用Notepad++、VS Code等支持Markdown语法高亮的文本编辑器进行编辑。 # 5. 在Java项目中生成UML时序图调用上述Java组件提供的RunnerGenTextFile4USD类，可以生成用于生成UML时序图的文本文件，再根据文本文件生成UML时序图，该类提供的方法说明如下： |方法名|功能| |---|---| |init|初始化| |writeDescription|设置描述| |writeComment|添加注释| |addReqMessage|添加同步请求消息| |addRspMessage|添加返回消息| |addSelfCallMessage|添加自调用消息| |addAsyncMessage|添加异步请求消息| |write2File|将添加的数据写入文件| 在使用RunnerGenTextFile4USD类时，需要先调用init方法，指定需要生成的文本文件路径，之后根据需要添加注释或消息，最后调用write2File方法将添加的数据写入文件。 RunnerGenTextFile4USD类的使用示例如下所示，可参考test.usddi.gen_text_file.TestGenTextFile4USD类。 ```java String filePath = "test-" + System.currentTimeMillis() + ".txt"; System.out.println(filePath); RunnerGenTextFile4USD runnerGenTextFile4USD = new RunnerGenTextFile4USD(); try (BufferedWriter writer = runnerGenTextFile4USD.init(filePath)) { // 设置描述 runnerGenTextFile4USD.writeDescription("description", "descriptionLink"); // 添加注释 runnerGenTextFile4USD.writeComment("111"); runnerGenTextFile4USD.writeComment("222"); runnerGenTextFile4USD.writeComment("333"); // 添加不同类型的消息 runnerGenTextFile4USD.addReqMessage("a", "b", "请求1"); runnerGenTextFile4USD.addRspMessage("a", "b", "返回1"); runnerGenTextFile4USD.addSelfCallMessage("a", "自调用1
aaa"); runnerGenTextFile4USD.addAsyncMessage("a", "c", "异步请求1
bbb"); // 将添加的数据写入文件 runnerGenTextFile4USD.write2File(); // 根据文本生成UML时序图文件 new RunnerGenUmlSequenceDiagram().generate(filePath, filePath + USDDIConstants.EXT_DRAWIO); } catch (Exception e) { e.printStackTrace(); } ``` # 6. 生成的.drawio文件使用方式 ## 6.1. 直接打开.drawio文件从以下地址可以下载draw.io桌面版软件： [https://github.com/jgraph/drawio-desktop/releases](https://github.com/jgraph/drawio-desktop/releases) 本工具生成的.drawio文件可使用draw.io软件打开并编辑。 ## 6.2. 复制.drawio文件的XML内容复制本工具生成的.drawio文件的XML内容，在draw.io桌面版或网页版中，打开“其他->编辑绘图”，或“Extras->Edit Diagram”菜单，可以粘贴到当前打开的draw.io文件中。