uml使用(二)--组件图编写

uml使用(二)–组件图编写

文章目录

  • uml使用(二)--组件图编写
      • 一、简介
      • 二、组件图知识点
        • 2.1、文档官网地址
        • 2.2、开始结束符
        • 2.3、组件
        • 2.4、接口
        • 2.5、线条及箭头
        • 2.6、模块
      • 三、完整示例
      • 四、编写工具

一、简介

这一节介绍常用组件图的编写,组件图可以描述项目架构。组件图中很多标识与时序图中同样,这里主要介绍不同的地方。

二、组件图知识点

2.1、文档官网地址

文档官网地址:http://plantuml.com/zh/component-diagram

2.2、开始结束符

uml开始和结束是一样的,都是@startuml和@enduml。

2.3、组件

用[]或component关键字来定义组件,同时可以使用as起别名,可以使用RGB或颜色来标识组件。
另外还可使用note left of , note right of , note top of , note bottom of对组件进行注释 ,如:

component 组件1 #green
[组件2]
[组件3] as cp3
[组件4]
note left of [组件41]:这是注释
note bottom of [组件42]
    这是另一种
    注释方式
end note

2.4、接口

用()或interface来定义接口。如:

() 接口1
interface 接口2

2.5、线条及箭头

…表示竖向虚线,.表示横向虚线;
–表示竖向实线,-表示横向实线

>和<箭头指向具体的组件,>>和<<时箭头为实心三角形,不加则没有箭头。

在–或…中,使用关键字up、down、left、right可以改变箭头方向。

组件后加冒号,可添加消息内容、

如:

接口3 .. [组件4]:请求1
接口4 . [组件4]
[组件4] -->> [组件5]:请求2
[组件5] -> [组件6]
[组件6] -up-> [组件7]

2.6、模块

模块样式有node、frame、package、cloud(云)、database(数据库)、folder,使用如:

folder folder标题 {
    [组件8] -left-> [组件9]
}
frame frame标题 {
    [组件10] -right-> [组件11]
}
package "package标题" {
    [组件12] -left-> [组件13]
}
database database标题 {
    [组件14] -down-> [组件15]
}
node node标题 {
    [组件16] -right-> [组件17]
}
cloud cloud标题 {
    [组件18] -right-> [组件19]
}

三、完整示例

下面给出个完整示例。

@startuml
title:这是标题

() 接口1
folder folder标题 {
    [组件a1] -> [组件a2]
}
frame frame标题 {
    [组件b1] <- [组件b2]
}
package "package标题" {
    [组件c1] -> [组件c2]
    [组件c2] -> [组件c3]
}
database database标题 {
    [组件d1] -down-> [组件d2]
}
node node标题 {
    [组件e1] -left-> [组件e2]
}
cloud cloud标题 {
    [组件f1] -right-> [组件f2]
}

接口1 --> [组件a1]
component 组件a1 #green
note left of [组件d1]:这是注释
[组件a2] -->[组件b2]
[组件b1] -down->[组件c1]
[组件c1] -->[组件e1]
[组件c2] -down->[组件f1]
[组件c3] -down->[组件d1]
@enduml

uml使用(二)--组件图编写_第1张图片

四、编写工具

同时序图一样,可在idea中使用plantuml插件(需要安装渲染工具Graphviz)。

你可能感兴趣的:(文档编写)