PlantUML类图 语法学习小结
类之间的关系
Type | Symbol | Drawing |
Extension | <|-- | |
Composition | *-- | |
Aggregation | o-- |
使用..
来代替 --
可以得到点 线
关系上的标识
在关系之间使用标签来说明时, 使用 :
后接 标签文字。对元素的说明,你可以在每一边使用 ""
来说明. 在标签的开始或结束位置添加<
或 >
以表明是哪个对象作用到哪个对象上。
添加方法
为了声明域或者方法,你可以使用 后接域名或方法名。系统检查是否有括号来判断是方法还是域。也可以使用{}
把域或者方法括起来
定义可访问性
一旦你定义了域或者方法,你可以定义 相应条目的可访问性质。
Character | Icon for field | Icon for method | Visibility |
- | private | ||
# | protected | ||
~ | package private | ||
+ | public |
你可以采用以下命令停用这些特性 skinparam classAttributeIconSize 0
:
抽象与静态
通过修饰符{static}
或者{abstract}
,可以定义静态或者抽象的方法或者属性。这些修饰符可以写在行的开始或者结束。也可以使用{classifier}
这个修饰符来代替{static}
.
高级类体
PlantUML默认自动将方法和属性重新分组,你可以自己定义分隔符来重排方法和属性,下面的分隔符都是可用的:--
..
==
__
.还可以在分隔符中添加标题:
备注和模板
模板通过类关键字("<<"和">>")来定义,你可以使用note left of
, note right of
, note top of
, note bottom of
这些关键字来添加备注。你还可以在类的声明末尾使用note left
, note right
,note top
, note bottom
来添加备注。此外,单独用note
这个关键字也是可以的,使用 ..
符号可以作出一条连接它与其它对象的虚线。
更多注释
可以在注释中使用部分html标签:
<b>
<u>
<i>
<s>
,<del>
,<strike>
<font color="#AAAAAA">
or<font color="colorName">
<color:#AAAAAA>
or<color:colorName>
<size:nn>
to change font size<img src="file">
or<img:file>
: the file must be accessible by the filesystem
你也可以在注释中展示多行。你也可以在定义的class之后直接使用 note left
, note right
, note top
, note bottom
来定义注释。
链接的注释
在定义链接之后,你可以用 note on link
给链接添加注释,如果想要改变注释相对于标签的位置,你也可以用 note left on link
, note right on link
, note bottom on link
。(对应位置分别在label的左边,右边,下边)
抽象类和接口
用关键字abstract
或abstract class
来定义抽象类。抽象类用斜体显示。 也可以使用interface
, annotation
和 enum
关键字。
使用非字母字符
如果你想在类(或者枚举)的显示中使用非字母字符,你可以:
- 在类的定义中使用
as
关键字 - 在类名旁边加上
""
隐藏属性、函数等
通过使用命令“hide/show
”,你可以用参数表示类的显示方式。基础命令是: hide empty members
. 这个命令会隐藏空白的方法和属性。除 empty members
外,你可以用:
empty fields
或者empty attributes
空属性,empty methods
空函数,fields
或attributes
隐藏字段或属性,即使是被定义了methods
隐藏方法,即使是被定义了members
隐藏字段 和 方法,即使是被定义了circle
类名前带圈的,stereotype
原型。
同样可以使用 hide
或 show
关键词,对以下内容进行设置:
class
所有类,interface
所有接口,enum
所有枚举,<<foo1>>
实现 foo1 的类,- 一个既定的类名。
你可以使用 show/hide
命令来定义相关规则和例外。
隐藏类
你也可以使用 show/hide
命令来隐藏类,如果你定义了一个大的 文件,且想在文件包含之后隐藏部分类,该功能会很有帮助。
泛型
你可以用 <
和 >
来定义类的泛型。
指定标记
通常标记字符 (C, I, E or A) 用于标记 类(classes), 接口(interface), 枚举(enum)和 抽象类(abstract classes).但是当你想定义原型时,可以增加对应的单个字符及颜色,来定义自己的标记(spot)
包
你可以通过关键词 package
声明包,同时可选的来声明对应的背景色(通过使用html色彩代码或名称)。注意:包可以被定义为嵌套。
包样式
包可以定义不同的样式。你可以通过以下的命令来设置默认样式 : skinparam packageStyle
,或者对包使用对应的模板:
自动创建命名空间
使用命令 set namespaceSeparator ???
你可以自定义命名空间分隔符(为 “.” 以外的字符).
禁止自动创建包则可以使用 set namespaceSeparator none
.
棒棒糖接口
需要定义棒棒糖样式的接口时可以遵循以下语法:
bar ()- foo
bar ()-- foo
foo -() bar
皮肤参数
用改变字体和颜色。
可以在如下场景中使用:
- 在图示的定义中,
- ,
- 在或者提供的配置文件中。
拆分大文件
有些情况下,会有一些很大的图片文件。可以用 page (hpages)x(vpages)
这个命令把生成的图片文件拆分成若干个文件。hpages
用来表示水平方向页面数, and vpages
用来表示垂直方面页面数。你也可以使用特定的皮肤设定来给分页添加边框
《书店图书销售管理》的类图元素
用户类:姓名,性别,出生日期,电话,邮箱,地址
图书类:图书编号,书名,作者,出版社,定价,出版日期
售卖类:图书编号,书名,售卖日期,图书价格,工作人员编号
工作人员类:工作人员编号,姓名,性别,年龄,岗位
@startuml
class 用户{ -姓名:-性别:-出生日期:-电话:-邮箱:-地址:}class 图书{
-图书编号:-书名:-作者:-出版社:-定价:-出版日期:} class 售卖{ -图书编号:-书名:-售卖日期:-图书价格:-工作人员编号:}class 工作人员{
-工作人员编号:-姓名:-性别:-年龄:-岗位:}售卖 -left-> 图书
售卖 -down-> 工作人员
售卖 -right-> 用户@enduml