PlantUMLの機能が思ったより多彩

著者:杉浦

PlantUMLの機能が思ったより多彩

 PlantUMLはUML図を表現できる言語です。言語故にテキストファイルであり、変更やGit管理が楽で便利です。
 PlantUMLを書いていると、あまりに図が複雑になるため複数ファイルに記述を分けたい時があります。そういった時、何度も同じ意味で同じ名前を宣言する記述が重複しがちです。そういった問題はinclude機能で定義ファイルの読み込みのみを記述することで解決できます。
 Use the preprocessorのIncluding files or URL

// define.puml
@startuml
participant "ブラウザ" as br
participant "サーバ" as svr
@enduml

// child.puml
@startuml
!include define.puml
br-->svr: ページ要求
@enduml

// child2.puml
@startuml
!include define.puml
br<--svr: ページレスポンス
@enduml


 こうすると、あるファイルだけ違う変数名で同じものを指している、という混乱やコピペコードを防げます。
 デフォルトのPlantUMLでER図を書いている時、定義の記述を一行にきれいなデザインでまとめることにくたびれます。デフォルトで等幅フォントを採用しておらず、空白を使って縦を合わせるのがめちゃくちゃしんどいです。等幅フォントを使うように宣言しましょう。
 Which fonts are available ?

@startuml
skinparam {
  defaultFontName Monospaced
}

entity users {
  # id                  int(11) unsigned auto_increment
    name                varchar(255)         not null,
    login_id            varchar(50)          not null,
    password            varchar(255)         not null,
    password_changed_at datetime             not null,
    email               varchar(255)         not null,
    last_login          varchar(25)          not null,
    login_failed        tinyint              not null,
    locked              tinyint              not null,
    locked_at           int                  not null,
    status              tinyint    default 0 not null,
    login_hash          varchar(255)         not null,
    created_at          int        default 0 not null,
    updated_at          int        default 0 not null,
    deleted             tinyint(1) default 0 not null,
}

@enduml


 ここでは特に使うと確信した二例を紹介しましたが、公式の前処理、共通事項をはじめとしたUMLから離れた欄を隅まで見ていくと思わず教えて欲しかったとなる便利機能がわいてきます。
 シンプルなテキストファイルで UML が書ける、オープンソースのツール

  • この記事いいね! (1)

著者について

杉浦 administrator