UML作业第二次：类图中类的表示

阅读量：5111 次

发布时间：2019-06-13

本文共 11198 字，大约阅读时间需要 37 分钟。

一、学习小结：

类之间的关系通过下面的符号定义 :

Type	Symbol	Drawing
Extension	`<\|--`
Composition	`*--`
Aggregation	`o--`

使用.. 来代替 -- 可以得到点线.

在这些规则下，也可以绘制下列图形

@startumlClass01 <|-- Class02Class03 *-- Class04Class05 o-- Class06Class07 .. Class08Class09 -- Class10@enduml

@startumlClass11 <|.. Class12Class13 --> Class14Class15 ..> Class16Class17 ..|> Class18Class19 <--* Class20@enduml

@startumlClass21 #-- Class22Class23 x-- Class24Class25 }-- Class26Class27 +-- Class28Class29 ^-- Class30@enduml

关系上的标识

在关系之间使用标签来说明时, 使用 :后接标签文字。

对元素的说明，你可以在每一边使用 "" 来说明.

@startumlClass01 "1" *-- "many" Class02 : containsClass03 o-- Class04 : aggregationClass05 --> "1" Class06@enduml

在标签的开始或结束位置添加< 或 >以表明是哪个对象作用到哪个对象上。

@startumlclass CarDriver - Car : drives >Car *- Wheel : have 4 >Car -- Person : < owns@enduml

添加方法

为了声明域或者方法，你可以使用后接域名或方法名。

系统检查是否有括号来判断是方法还是域。

@startumlObject <|-- ArrayListObject : equals()ArrayList : Object[] elementDataArrayList : size()@enduml

也可以使用{} 把域或者方法括起来

注意，这种语法对于类型/名字的顺序是非常灵活的。

@startumlclass Dummy {  String data  void methods()}class Flight {   flightNumber : Integer   departureTime : Date}@enduml

You can use {field} and {method} modifiers to override default behaviour of the parser about fields and methods.

@startumlclass Dummy {  {field} A field (despite parentheses)  {method} Some method}@enduml

定义可访问性

一旦你定义了域或者方法，你可以定义相应条目的可访问性质。

Character	Icon for field	Icon for method	Visibility
`-`			private
`#`			protected
`~`			package private
`+`			public

@startumlclass Dummy { -field1 #field2 ~method1() +method2()}@enduml

你可以采用以下命令停用这些特性 skinparam classAttributeIconSize 0 ：

@startumlskinparam classAttributeIconSize 0class Dummy { -field1 #field2 ~method1() +method2()}@enduml

抽象与静态

通过修饰符{static}或者{abstract}，可以定义静态或者抽象的方法或者属性。

这些修饰符可以写在行的开始或者结束。也可以使用{classifier}这个修饰符来代替{static}.

@startumlclass Dummy {  {static} String id  {abstract} void methods()}@enduml

高级类体

PlantUML默认自动将方法和属性重新分组，你可以自己定义分隔符来重排方法和属性，下面的分隔符都是可用的：--..==__.

还可以在分隔符中添加标题：

@startumlclass Foo1 {  You can use  several lines  ..  as you want  and group  ==  things together.  __  You can have as many groups  as you want  --  End of class}class User {  .. Simple Getter ..  + getName()  + getAddress()  .. Some setter ..  + setName()  __ private data __  int age  -- encrypted --  String password}@enduml

备注和模板

模板通过类关键字("<<"和">>")来定义

你可以使用note left of , note right of , note top of , note bottom of这些关键字来添加备注。

你还可以在类的声明末尾使用note left, note right,note top, note bottom来添加备注。

此外，单独用note这个关键字也是可以的，使用 .. 符号可以作出一条连接它与其它对象的虚线。

@startumlclass Object << general >>Object <|--- ArrayListnote top of Object : In java, every class\nextends this one.note "This is a floating note" as N1note "This note is connected\nto several objects." as N2Object .. N2N2 .. ArrayListclass Foonote left: On last defined class@enduml

链接的注释

在定义链接之后，你可以用 note on link 给链接添加注释

如果想要改变注释相对于标签的位置，你也可以用 note left on link， note right on link， note bottom on link。（对应位置分别在label的左边，右边，下边）

@startumlclass DummyDummy --> Foo : A linknote on link #red: note that is redDummy --> Foo2 : Another linknote right on link #blue	this is my note on right link	and in blueend note@enduml

抽象类和接口

用关键字abstract或abstract class来定义抽象类。抽象类用斜体显示。也可以使用interface, annotation 和 enum关键字。

@startumlabstract class AbstractListabstract AbstractCollectioninterface Listinterface CollectionList <|-- AbstractListCollection <|-- AbstractCollectionCollection <|- ListAbstractCollection <|- AbstractListAbstractList <|-- ArrayListclass ArrayList {  Object[] elementData  size()}enum TimeUnit {  DAYS  HOURS  MINUTES}annotation SuppressWarnings@enduml

使用非字母字符

如果你想在类（或者枚举）的显示中使用，你可以：

在类的定义中使用 as 关键字

在类名旁边加上 ""

@startumlclass "This is my class" as class1class class2 as "It works this way too"class2 *-- "foo/dummy" : use@enduml

隐藏属性、函数等

通过使用命令“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 命令来定义相关规则和例外。

@startumlclass Dummy1 {  +myMethods()}class Dummy2 {  +hiddenMethod()}class Dummy3 <
      
       > {	String name}hide membershide <
       
        > circleshow Dummy1 methodsshow <
        
         > fields@enduml

隐藏类

你也可以使用 show/hide 命令来隐藏类

如果你定义了一个大的文件，且想在文件包含之后隐藏部分类，该功能会很有帮助。

@startumlclass Foo1class Foo2Foo2 *-- Foo1hide Foo2@enduml

泛型（generics）

你可以用 < 和 > 来定义类的泛型。

@startumlclass Foo
       {  int size()}Foo *- Element@enduml

It is possible to disable this drawing using skinparam genericDisplay old command.

指定标记（Spot）

通常标记字符 (C, I, E or A) 用于标记类(classes), 接口（interface）, 枚举（enum）和抽象类（abstract classes）.

但是当你想定义原型时，可以增加对应的单个字符及颜色，来定义自己的标记（spot），就像下面一样：

@startumlclass System << (S,#FF7700) Singleton >>class Date << (D,orchid) >>@enduml

包

你可以通过关键词 package 声明包，同时可选的来声明对应的背景色（通过使用html色彩代码或名称）。

注意：包可以被定义为嵌套。

@startumlpackage "Classic Collections" #DDDDDD {  Object <|-- ArrayList}package net.sourceforge.plantuml {  Object <|-- Demo1  Demo1 *- Demo2}@enduml

包样式

包可以定义不同的样式。

你可以通过以下的命令来设置默认样式 : skinparam packageStyle,或者对包使用对应的模板:

@startumlscale 750 widthpackage foo1 <
      
       > {  class Class1}package foo2 <
       
        > {  class Class2}package foo3 <
        
         > {  class Class3}package foo4 <> {  class Class4}package foo5 <
         
          > {  class Class5}package foo6 <
          
           > {  class Class6}@enduml

你也可以参考下面的示例来定义包之间的连线:

@startumlskinparam packageStyle rectanglepackage foo1.foo2 {}package foo1.foo2.foo3 {  class Object}foo1.foo2 +-- foo1.foo2.foo3@enduml

命名空间（Namespaces）

In packages, the name of a class is the unique identifier of this class. It means that you cannot have two classes with the very same name in different packages.

In that case, you should use instead of packages.

You can refer to classes from other namespaces by fully qualify them. Classes from the default namespace are qualified with a starting dot.

Note that you don't have to explicitly create namespace : a fully qualified class is automatically put in the right namespace.

@startumlclass BaseClassnamespace net.dummy #DDDDDD {	.BaseClass <|-- Person	Meeting o-- Person		.BaseClass <|- Meeting}namespace net.foo {  net.dummy.Person  <|- Person  .BaseClass <|-- Person  net.dummy.Meeting o-- Person}BaseClass <|-- net.unused.Person@enduml

自动创建命名空间

使用命令 set namespaceSeparator ??? 你可以自定义命名空间分隔符（为 “.” 以外的字符）.

@startumlset namespaceSeparator ::class X1::X2::foo {  some info}@enduml

禁止自动创建包则可以使用 set namespaceSeparator none.

@startumlset namespaceSeparator noneclass X1.X2.foo {  some info}@enduml

棒棒糖接口

需要定义棒棒糖样式的接口时可以遵循以下语法:

bar ()- foo

bar ()-- foo

foo -() bar

@startumlclass foobar ()- foo@enduml

改变箭头方向

类之间默认采用两个破折号 -- 显示出垂直方向的线. 要得到水平方向的可以像这样使用单破折号 (或者点):

@startumlRoom o- StudentRoom *-- Chair@enduml

你也可以通过改变倒置链接来改变方向

@startumlStudent -o RoomChair --* Room@enduml

也可通过在箭头内部使用关键字，例如left, right, up 或者 down，来改变方向

@startumlfoo -left-> dummyLeft foo -right-> dummyRight foo -up-> dummyUp foo -down-> dummyDown@enduml

You can shorten the arrow by using only the first character of the direction (for example, -d- instead of -down-) or the two first characters (-do-).

Please note that you should not abuse this functionality : Graphviz gives usually good results without tweaking.

“关系”类

你可以在定义了两个类之间的关系后定义一个 关系类 association class 例如:

@startumlclass Student {  Name}Student "0..*" - "1..*" Course(Student, Course) .. Enrollmentclass Enrollment {  drop()  cancel()}@enduml

也可以用另一种方式:

@startumlclass Student {  Name}Student "0..*" -- "1..*" Course(Student, Course) . Enrollmentclass Enrollment {  drop()  cancel()}@enduml

皮肤参数

用改变字体和颜色。

可以在如下场景中使用：

在图示的定义中，

在或者提供的配置文件中。

@startumlskinparam class {	BackgroundColor PaleGreen	ArrowColor SeaGreen	BorderColor SpringGreen}skinparam stereotypeCBackgroundColor YellowGreenClass01 "1" *-- "many" Class02 : containsClass03 o-- Class04 : aggregation@enduml

Skinned Stereotypes

You can define specific color and fonts for stereotyped classes.

@startumlskinparam class {	BackgroundColor PaleGreen	ArrowColor SeaGreen	BorderColor SpringGreen	BackgroundColor<
      
       > Wheat	BorderColor<
       
        > Tomato}skinparam stereotypeCBackgroundColor YellowGreenskinparam stereotypeCBackgroundColor<< Foo >> DimGrayClass01 <
        
         >Class03 <
         
          >Class01 "1" *-- "many" Class02 : containsClass03 o-- Class04 : aggregation@enduml

Color gradient

It's possible to declare individual color for classes or note using the # notation.

You can use either or RGB code.

You can also use color gradient in background, with the following syntax: two colors names separated either by:

|,

/,

\,

or -

depending the direction of the gradient.

For example, you could have:

@startumlskinparam backgroundcolor AntiqueWhite/Goldskinparam classBackgroundColor Wheat|CornflowerBlueclass Foo #red-greennote left of Foo #blue\9932CC  this is my  note on this classend notepackage example #GreenYellow/LightGoldenRodYellow {  class Dummy}@enduml

Help on layout

Sometimes, the default layout is not perfect...

You can use together keyword to group some classes together : the layout engine will try to group them (as if they were in the same package).

You can also use hidden links to force the layout.

@startumlclass Bar1class Bar2together {  class Together1  class Together2  class Together3}Together1 - Together2Together2 - Together3Together2 -[hidden]--> Bar1Bar1 -[hidden]> Bar2@enduml

拆分大文件

有些情况下，会有一些很大的图片文件。

可以用 page (hpages)x(vpages) 这个命令把生成的图片文件拆分成若干个文件。

hpages 用来表示水平方向页面数， and vpages 用来表示垂直方面页面数。

你也可以使用特定的皮肤设定来给分页添加边框（见例子）

@startuml' Split into 4 pagespage 2x2skinparam pageMargin 10skinparam pageExternalColor grayskinparam pageBorderColor blackclass BaseClassnamespace net.dummy #DDDDDD {	.BaseClass <|-- Person	Meeting o-- Person		.BaseClass <|- Meeting}namespace net.foo {  net.dummy.Person  <|- Person  .BaseClass <|-- Person  net.dummy.Meeting o-- Person}BaseClass <|-- net.unused.Person@enduml