TTokenySpace
返回 Skills 列表

Plantuml

用 PlantUML 文本语法绘制 UML 图:时序图、类图、活动图、用例图、状态图、组件图、部署图、思维导图、甘特图等。

#中文
0

安装到 Tokeny(自动)

下载 ZIP
安装"plantuml-skill-2"技能
技能信息:
- 名称: Plantuml
- 标识: plantuml-skill-2
- 描述: 用 PlantUML 文本语法绘制 UML 图:时序图、类图、活动图、用例图、状态图、组件图、部署图、思维导图、甘特图等。
- 版本: 1.0.0
下载地址:
https://www.tokeny.space/api/skills/plantuml-skill-2/download
继续

复制上方内容到 Tokeny 客户端并在会话中发送即可自动安装;也可直接 下载 ZIP并拖动到技能窗口安装。

SKILL.md

PlantUML 图表绘制

使用 PlantUML 基于文本的语法生成 UML 图和其他图表类型。所有图表都以 @startuml 开始,以 @enduml 结束。

基本结构

@startuml
' 图表内容
@enduml

注释:单行用 ',块注释用 /' ... '/

通用命令

  • title — 添加标题
  • caption — 图片下方标题
  • header / footer — 页眉/页脚(可加 left/center/right
  • legend ... end legend — 图例
  • scale 1.5 / scale 200 width / scale 200*100 — 缩放
  • left to right direction — 改变方向
  • Creole 语法可用于文本格式化(粗体 **...**、斜体 //...//、列表等)

时序图 (Sequence Diagram)

参与者声明

participant Alice
actor Bob
boundary Wall
control C
entity E
database DB
collections Col
queue Q

as 定义别名:participant Alice as A。 用 order 设定顺序:participant Alice order 10

消息箭头

  • A -> B — 实线箭头
  • A --> B — 虚线箭头
  • A <- B — 反向
  • A ->> B — 实线开放箭头
  • A -\ B — 仅起始端箭头
  • A \\- B — 仅末端箭头
  • A x> B — 末端带X
  • A -> B : 消息文本 — 带标签

生命线

  • activate A / deactivate A
  • autoactivate on — 自动激活
  • destroy A — 销毁

分组

  • alt/else — 条件分支
  • opt — 可选
  • loop — 循环
  • par — 并行
  • break — 中断
  • critical — 关键
  • group 标题 — 自定义分组

其他

  • note left/right/over — 注释
  • A -> B : <text> 中可使用 \n 换行
  • ref over A, B — 引用
  • delay — 延迟
  • divider — 分隔线

类图 (Class Diagram)

元素声明

class ClassName {
  + publicMethod()
  - privateField: Type
  # protectedField: Type
  ~ packageField: Type
  {static} staticField
  {abstract} abstractMethod()
}
interface InterfaceName
abstract class AbstractClass
enum EnumName {
  VALUE1
  VALUE2
}
annotation AnnotationName

可见性:+ public, - private, # protected, ~ package。

关系

  • A --|> B — 继承(A继承B)
  • A ..|> B — 实现(A实现B接口)
  • A --> B — 关联
  • A --* B — 组合
  • A ..* B — 聚合
  • A o-- B — 聚合(反向)
  • A ..> B — 依赖
  • A -- B — 实线连接
  • A .. B — 虚线连接

关系标签:A --> "1" B : "包含""*" --> "1" 多重性。

构造型与注释

<<interface>> InterfaceName
<<abstract>> AbstractClass
<<enumeration>> EnumName
<<annotation>> AnnotationName

类内注释:note left, note right, note top, note bottom

package "包名" {
  class A
  class B
}

活动图 (Activity Diagram, Beta)

基本语法

@startuml
start
:动作1;
:动作2;
stop
@enduml

动作以 : 开始,; 结束。隐式自动连接。

条件

if (条件?) then (yes)
  :动作A;
else (no)
  :动作B;
endif

elseif 支持多分支。!pragma useVerticalIf on 切换垂直模式。

Switch

switch (变量?)
case (值1)
  :动作1;
case (值2)
  :动作2;
endswitch

循环

repeat
  :动作;
repeat while (条件?)
while (条件?) is (标签)
  :动作;
endwhile

并行

fork
  :分支1;
fork again
  :分支2;
end fork

分割

split
  :路径1;
split again
  :路径2;
end split

泳道

|泳道A|
:动作1;
|泳道B|
:动作2;

泳道别名:|#<颜色>|<别名>| <标题>

分组

partition "分区名" {
  :动作1;
  :动作2;
}

也支持 group, package, rectangle, card

其他

  • kill / detach — 终止/分离
  • break — 打断循环
  • note — 注释(可用 floating 浮动)
  • 箭头:-> 可加文本和颜色

用例图 (Use Case Diagram)

语法

actor 用户 as U
usecase "登录" as UC1
usecase "查看资料" as UC2
U --> UC1
U --> UC2
UC1 ..> UC2 : <<include>>
  • Actor:actor 关键字或冒号语法 :用户名:
  • 用例:usecase 关键字或括号 (用例名)
  • as 定义别名
  • 矩形:rectangle "系统名" { ... } 分组

关系

  • --> 关联
  • ..> 依赖
  • ..> : <<include>> 包含
  • ..> : <<extend>> 扩展
  • --|> 继承

状态图 (State Diagram)

基本语法

[*] --> State1
State1 --> State2 : 事件
State2 --> [*]

复合状态

state Composite {
  state Sub1
  state Sub2
  Sub1 --> Sub2
}

伪状态

  • <<fork>> / <<join>> — 分叉/合并
  • <<choice>> — 选择
  • <<entryPoint>> / <<exitPoint>> — 入口/出口
  • [H] / [H*] — 历史/深历史状态

并发

--|| 分隔并发区域。

注释

note left of, note right of, note top of, note bottom of, note on link

组件图 (Component Diagram)

语法

component "组件A" as A
component [组件B]
interface "接口" as I
A --|> I
A ..> B : 使用
  • 组件:component[名称]
  • 接口:interface()名称
  • as 别名

连接类型

  • .. 虚线
  • -- 实线
  • --> 箭头

分组容器

package, node, folder, frame, cloud, database

端口

port, portIn, portOut 关键字。

部署图 (Deployment Diagram)

元素

actor 用户
component 组件
interface 接口
usecase 用例
node 服务器 {
  component 应用
}
database 数据库

短格式::a: (actor), [c] (component), ()i (interface), (u) (usecase)。

连接

与组件图相同的连接类型,支持线条样式、颜色、粗细。

嵌套

所有元素可嵌套:node, package, folder, frame, cloud, database

allowmixingallow_mixing 指令允许在类图/对象图中混用部署元素。

时序图/定时图 (Timing Diagram)

参与者类型

  • analog — 模拟信号(连续,线性插值)
  • binary — 二进制信号
  • clock — 时钟信号(需 period,可选 pulse/offset
  • concise — 简明表示
  • robust — 状态线表示

语法

@startuml
clock clk period 2
binary b
robust r
@0
b is high
r is state1
@5
b is low
r is state2
@enduml
  • @N — 绝对时间
  • @+N / @-N — 相对时间
  • @N as :名称 — 锚点
  • is — 定义状态

思维导图 (MindMap)

语法(运算符方式)

@startmindmap
+ 中心主题
++ 一级分支
+++ 二级分支
-- 左侧分支
--- 二级左侧
@endmindmap

运算符:+ 右侧, - 左侧, * 右侧多级, _ 左侧多级。

OrgMode 语法

@startmindmap
* 中心
** 分支1
*** 子分支
@endmindmap

Markdown 语法

@startmindmap
- 中心
-- 分支
--- 子分支
@endmindmap

多行文本用 :; 包围。

甘特图 (Gantt Diagram)

语法

@startgantt
projectstart 2024-01-01
[任务A] lasts 5 days
[任务B] lasts 3 days
[任务B] starts at [任务A]'s end
@endgantt

关键命令

  • [任务] lasts N days — 持续时间
  • [任务] starts N days after [任务B]'s end — 相对开始
  • [任务] ends at [任务B]'s end — 相对结束
  • [任务] happens at 2024-01-15 — 绝对日期
  • then — 连续任务
  • [任务] as T — 短名称
  • is xx% completed — 完成度
  • [里程碑] happens at 2024-02-01 — 里程碑

日历

  • projectstart — 项目开始日期
  • 2024-01-01 to 2024-12-31 — 日期范围
  • saturday are closed / sunday are closed — 关闭日
  • printscale daily/weekly/monthly/quarterly/yearly — 尺度

skinparam 常用参数

注意:skinparam 已废弃,建议迁移到 <style> CSS 样式。

skinparam backgroundColor transparent
skinparam monochrome true
skinparam shadowing false
skinparam defaultFontName Helvetica
skinparam classFontColor red
skinparam classFontSize 10
skinparam ArrowHeadColor none
skinparam componentStyle rectangle

嵌套写法:

skinparam class {
  FontColor red
  FontSize 10
  FontName Helvetica
}

预处理

变量

!$var = "value"
!$i = 42
!$a ?= "default"

条件

!if ($var == "value")
  ...
!else
  ...
!endif

循环

!while ($i > 0)
  ...
!endwhile

函数

!function $name($param)
  !return $param + "!"
!endfunction

包含文件

!include file.iuml
!include_many file.iuml
!include_once file.iuml
!includesub file.puml!SECTION

内置函数

%date(), %now(), %darken("red", 20), %chr(65), %intval("42"), %file_exists("path") 等。

颜色

支持标准颜色名(red, blue, green 等)和 RGB 码(#FF0000)。transparent 仅用于背景。

内联颜色样式:#color;line:color;line.[bold|dashed|dotted];text:color

输出与渲染

  • 命令行:java -jar plantuml.jar file.puml
  • 输出格式:-tpng(默认)、-tsvg-tpdf-tlatex
  • 服务器:可使用 PlantUML Web 服务器渲染
  • !pragma 指令可控制渲染行为

评论

加载中…