up:: PlantUML
基本
@startuml DiagramName
class Dummy{
String data1
{field}data2 : String
void method1()
{method} method2
}
@endumlフィールドとメソッドを並べて書ける。
{}を使うとフィールドを強制したり出来る。ちなみにstaticとabstractはこれをしないと宣言できない。static = classifier。
高等なクラス
@startuml
class 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セパレータを使い独自に区分けできる。
宣言できるもの
class, interface, enum, abstract, entity, anotation.
特殊目印
@startuml
class System << (S,#FF7700) Singleton >>
class Date << (D,orchid) >>
@enduml定義されてないものに目印をつけたいなら、こう。
anotation
実行時にいろんな注意を付記するもの。
Java用。
@Overrideならインターフェイスメソッドのオーバーライドメソッドを示す。
@Deprecatedなら名前変更したせいでもう使われてないメソッドを示す。
@SuppressWarningsなら様々な状況で警告を出さないようにできる。
この他独自でアノテーションを作る方法もあるらしい。
source:: 【Java入門】アノテーションの使い方と作成する方法 | 侍エンジニアブログ
abstract
abstractでもabstract classでも宣言可能。
非文字
@startuml
class "This is my class" as class1
class class2 as "It works this way too"
class2 *-- "foo/dummy" : use
@endumlasを使うことで変数のように宣言できる。
クラスの非表示、削除
@startuml
class Dummy1 {
+myMethods()
}
class Dummy2 {
+hiddenMethod()
}
class Dummy3 <<Serializable>> {
String name
}
hide members
hide <<Serializable>> circle
show Dummy1 methods
show <<Serializable>> fields
@endumlshowとhideで細かい非表示設定ができる。
消したいときは代わりにRemove。
基本はhide empty members。
クラスも非表示できる。
孤立クラスの非表示・削除
hide @unlinked、
remove @unlinked。
関係
@startuml
Class05 o-- Class06 : Aggregation
Class11 <-- Class12 : isNavigable
Class07 <.. Class08 : Dependency
Class01 <|-- Class02 : Extension
Class13 <|.. Class14 : Realization
Class03 *-- Class04 : Composition
class15 +-- class16 : Inner
@enduml重ねて文字を書いてる部分を一つにすると横向きになる。
@startuml
Room o- Student
Room *-- Chair
@enduml隙間にrightやleftを挟んで自由に変えることもできる。
@startuml
foo -left-> dummyLeft
foo -right-> dummyRight
foo -up-> dummyUp
foo -down-> dummyDown
@endumlAggregation
集約。
isNavigable
誘導可能性。Association、関連とも。
Dependency
依存。
集約、誘導可能性、依存の使い分け
- 集約は全体クラスと部分クラス。学校と生徒。
- 誘導可能性は集約ほど強くなく、オブジェクトにアクセスしてメソッドを使用する可能性があるくらいの認識。部活と生徒。
- 依存はそのオブジェクトを引数として使用するくらいの弱い関係。一方のクラス内でメンバとして宣言しない。 学校と部活。
source:: 【クラス図の矢印】集約、誘導可能性、依存の違い
Extension
継承。Inheritanceや汎化といった名称も。
class name extends classnameでも書ける。
Realization
実現。
インターフェース用。
class name implements interfacenameでも書ける。まあ見ての通りJava文法だけど。
Composition
構成。
インスタンスの生成や削除を担う。
Inner
内部クラス。
source:: PlantUML使い方メモ - Qiita
source:: クラス図の構文と機能
レイアウト
@startuml
class Bar1
class Bar2
together {
class Together1
class Together2
class Together3
}
Together1 - Together2
Together2 - Together3
Together2 -[hidden]--> Bar1
Bar1 -[hidden]> Bar2
@endumltogetherを使えば、ある程度クラスをグループ化できる。扱い的には同じパッケージにある感じ。
カラーとスタイル
線の間に[]で色々つけて線スタイルを変えたり色を変えたりできる。
インラインスタイルで書けばクラスの色を変更することもできる。
skinparams
もっと詳しく変更したいときに。
実際に使うのはskinparam shadowing falseやskinparam monochrome true、skinparam monochrome reverseじゃなかろうか。
source:: Changing colors and fonts
その他
注釈機能や、生成画像の分割、矢印まとめ機能なんかがある。