コンポーネント図 テンプレート（書き方とサンプル例）

こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
コンポーネント図のテンプレートと例文をご紹介します。

コンポーネント図とは？

クラス図はUML（統一モデリング言語）で描かれる図の一つです。クラス図はオブジェクト指向モデリング、およびオブジェクト指向プログラミングで利用されます。ソースコードにおけるクラスやインタフェースをモデリングし、プロジェクト関係者がシステム構造を理解しやすくなります。

コンポーネント図では主にシステムがどのようなコンポーネントによって構成されており、それらコンポーネントがどのような相互関係になっているかを可視化します。

WEB上で簡単にコンポーネント図の作成・管理を行えるツール「NotePM」

コンポーネント図の目的

一般的にシステムは複数のコンポーネントによって成り立っています。それは異なる役割を持ったサーバー群であったり、アプリケーション群、データベースやプロキシサーバーなどです。さらに外部システムが関わる場合も少なくありません。システム規模が大きくなればなるほど、相互関係は複雑になるでしょう。

コンポーネント図ではそうしたシステムの構成要素がどのように関わっているのかを可視化します。それによってシステムの全体像がつかめるようになり、システムのイベントによってどういった相互作用が起こるのかを把握できるようになります。

コンポーネント図の書き方

グループ化

コンポーネント図では、枠を使ってコンポーネントをグルーピングします。枠には次の種類があります。

名称	表示
package	左上にパッケージ名が表示されます
node	立体的なボックスで表示されます
folder	フォルダーはパッケージに似た表示です
frame	フレーム名は左上ですが、本体の内側に表示されます
cloud	雲の形です
database	データベース型です

パッケージ

package "グループ1" {
  HTTP - [コンポーネント1]
  [別なコンポーネント]
}

ノード

node "グループ2" {
  FTP - [コンポーネント2]
  [コンポーネント1] --> FTP
}

クラウド

cloud {
  [例1]
}

データベース

database "MySQL" {
    [売上げ]
    [顧客] --> [売上げ]
}

フォルダー

folder "個人のフォルダー" {
    [ファイル]
}

フレーム

frame "フレーム" {
    [フォルダー4]
}

コンポーネントに色を付ける

コンポーネントを定義した後に #色名 で色を付けられます。

frame "フレーム" #Blue {
    [フォルダー4]
}

矢印

コンポーネント間を関連付けるのが矢印です。これはコンポーネントとして定義されている中で行うことも、別途まとめて記述もできます。

コンポーネント内で定義する場合

この例ではコンポーネント1とFTPを関連付けています。

package "グループ1" {
  HTTP - [コンポーネント1]
  [別なコンポーネント]
}

node "グループ2" {
  FTP - [コンポーネント2]
  [コンポーネント1] --> FTP
}

まとめて定義する場合

まとめて定義する場合は、コンポーネントの定義とは別で記述します。

[コンポーネント1] --> FTP

矢印の種類

矢印は書き方によって方向や種類が変わります。

• -> または <- : 水平方向
• --> または <-- : 垂直方向
• -left -> left : 左矢印
• -right-> right : 右矢印
• -up-> up : 上矢印
• -down-> down : 下矢印

さらに . や .. は破線になります。例えば ..> や .> といった具合です。

矢印に説明を付ける場合には : を使います。例えば [コンポーネント1] ..> HTTP : 呼び出す といった具合です。

database "MySQL" {
    [売上げ]
    [顧客] --> [売上げ] : 1:n
}

ノート

コンポーネントに吹き出しを付ける場合には note を使います。上下左右、自由に付けられます。

[コンポーネント] as C

note top of C: 上のノート

note bottom of C
  下のノート
  改行もできます
end note

note left of C
  左のノート
  こちらも改行
end note

note right of C: 右のノート