本文多数内容引用自官网文档，并非本人原创，也谈不上翻译，只是把自己 理解的东西用中文写出来。

编写本文的目的旨在记录个人在学习PlantUML时对官网上一些内容的理解，以 及总结学习过程中遇到的问题，并将其分享。文章中如有不对之处欢迎大家直 言指正，以免造成误导。

版权：本文可自由转载，但不能商用，不能衍生，保持署名。转载请注明作者及出处.

Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

PlantUML是一个快速创建UML图形的组件，官网上之所以称它是一个组件，我 想主要是因为多数情况下我们都是在Eclipse、NetBenas、Intellijidea、 Emacs、Word等软件里来使用PlantUML（参看各软件相关配置）。

PlantUML支持的图形有：

PlantUML通过简单和直观的语言来定义图形，它可以生成PNG、SVG和二进制 图片。下面是一个简单的示例：

在官网上有一个简单的在线Demo服务， 有兴趣的朋友可以上去看下。

下载 plantuml.jar 到你的硬盘上（官网下载页面）

安装生成图片用的软件Graphviz

在 .emacs 里添加配置，把 plantuml 添加到 org-babel-load-languages 加载语言列表里。

然后把刚下载到的 plantuml.jar 文件的存放路径也添加到 .emacs 文件中，以方便Emacs调用。

重启Emacs，复制上面的示例代码试一下吧！

顺序图（Sequence Diagram）

简单示例

顺序图用 -> , -->, Alice: Authentication Response Alice -> Bob: Another atuhentication Request Alice Foo2 : To boundary Foo1 -> Foo3 : To control Foo1 -> Foo4 : To entity Foo1 -> Foo5 : To database #+END_SRC

使用 as 关键词可以为参与者起一个别名，这样在对引用长名的参与者时， 会方便很多。在参与者申明语句后行尾可以追加背景色的设置，只要把标准 的HTML颜色值 写在后面就行了。

使用非字母的参与者名称（Use non-letters in participants）

针对非字母的参与者名，我们可以使用双引号，同样也可以为比较长的名字 起个别名，方法同上使用 as 关键词。

使用上面的关键词来申明参与者，是一种显示申明；而采用引号来申明参与 者则是一种隐示申明方法，它不需要专门的位置去定义。

发送消息给自己（Message to Self）

一个参与者可以给自己发送消息，消息名如果需要有多行文本，可以用 \n 来表示换行。

改变箭头的样式（Change arrow style）

在用例图里可以通过以下方式来改变箭头的样式：

消息序号（Message sequence numbering）

关键词 autonumber 用来给自动的给消息添加上序号。

使用 legend 和 end legend 关键词可以设置图形的图例。图例可以设 为左对齐、右对齐和居中对齐。

分割图形（Splitting diagrams）

关键词 newpage 是用来把图形分割成几个图片的。每一个被分割出来的 图片可以看作是一个新的页面（ new page ），如果要给新的页面添加一 个标题，可以紧跟在关键词 newpage 之后来设置。

使用这个方法可以方便的在Word里把比较长的图形分别打印到几个不同的页 面上（有点分页符的概念）。

消息分组（Grouping message）

有时候可能需要对消息进行分组，那么可以使用下面的关键词来实现：

上面的关键词后可以添加一些文本用来显示在头部（注： group 除外，因 为它后面的文本用来显示在组名称的位置）。在组嵌套组的结构里可以用关 键词end 来关闭组或者说是表示一个组符号的结束符（类似 if/endif ）。

消息注解（Notes on messages）

我们可能经常会在消息的左边或右边使用注解，要添加注解，只要使用 note left 或 note right 关键词就可以了。

一些其他的注解方式（Some other notes）

通过使用关键词 note left of ， note right of 或 note over ， 我们还可以把注解放置在与之相关的参与者的左边或右边，或下方。

通过改变注解的背景色，我们还可以高亮一个注解文本块。

如果要使用多行注解，可以使用关键词 end note 来表示注解的结束。

使用HTML进行格式化（Formatting using HTML）

我们可以使用少量的HTML标签来格式化文本：

加粗文本 或 或 用来加下划线 斜体 或 或 用来加删除线 或 或 用来加波浪线 或 用来设置文本颜色 或 用来设置背景色 设置字体大小 或 用来添加图片，图片文件必须 是可以访问得到才行。 或 用来添加一个互 联网图片，同样的图片地址必须是可用的才行。 #+BEGIN_SRC plantuml :file ../img/plantuml-quickstart-s17.png participant Alice participant "The Famous Bob" as Bob Alice -> Bob : A well formated message note right of Alice This is displayed left of Alice. end note note left of Bob This is displayed left of Alice Bob end note note over Alice, Bob This is hosted by end note #+END_SRC

用例图（Use Case Diagram）

用例（Usecase）

用例可以用一对小括号括起来表示，也可以使用 usecase 关键词来定义。 用例也可以通过使用 as 关键词来设置别名，在建立关系的时候可以使用 别名。

#+BEGIN_SRC plantuml :file ../img/plantuml-quickstart-u1.png @startuml (Usecase One) (Usecase Two) as (UC2) usecase UC3 usecase (Last\nusecase) as UC4 @enduml #+END_SRC

参与者（Actors）

定义参与者时，可以把参与者的名称放在两个冒号的中间，也可以用 actor 关键词来定义参与者。同样参与着也可以使用别名。

#+BEGIN_SRC plantuml :file ../img/plantuml-quickstart-u2.png @startuml :Actor 1: :Another\nactor: as Men2 actor Men3 actor :Last actor: as Men4 @enduml #+END_SRC

示例

#+BEGIN_SRC plantuml :file ../img/plantuml-quickstart-u99.png left to right direction skinparam packageStyle rect actor customer actor clerk rectangle checkout { customer -- (checkout) (checkout) .> (payment) : include (help) .> (checkout) : extends (checkout) -- clerk } #+END_SRC

类图（Class Diagram）

示例1

class Company { } class Department { name : Name } class Office { address : String phone : Number } class Headquarters { } class Person { name : Name employeeID : Integer title : String getPhoto() : Photo getPhone() : Number getContactInformation() : ContactInformation getPersonalRecords() : PersonnelRecord } class ContactInformation { address : String } class PersonnelRecord { taxID employmentHistory salary } Company "1" *-do- "1..*" Department Company "1" *-do- "1..*" Office '(Department, Office) -up-* Company Department "*" -ri- "*" Office : Location > Department "*" --* "0..1" Department Office