PlantUML クラス図:VPasCode ツールを使用した実践ガイド

はじめに

静的スケッチから動的ドキュメンテーションへ:VPasCode における PlantUML 変数の習得
現代のソフトウェアアーキテクチャにおいて、図は単なる静的なイラストではなく、コードベースとともに進化しなければならない生きたドキュメンテーションです。しかし、複数の図間の一貫性を維持しようとすると、反復的で管理が困難なスクリプトになりがちです。登場するのがPlantUML 変数—これは、図のコードを硬直したテキストから柔軟で再利用可能なテンプレートへと変える強力な機能です。これにVisual Paradigm VPasCodeというブラウザベースで AI 強化されたワークスペースを組み合わせることで、ローカル環境のインストールや複雑なビルドパイプラインの手間を省きながら、動的でモジュール化された図を作成できるようになります。このガイドでは、プリプロセッサディレクティブ、条件分岐、カスタム関数を活用してワークフローを効率化し、アーキテクチャ図が正確で、一貫性があり、更新しやすい状態を維持する方法を探ります。
再利用可能なテンプレートと条件付きロジックを用いて、VPasCode 内の PlantUML 変数が静的なスケッチを動的なドキュメンテーションへと変換する様子を示す図。

PlantUML クラス図は、システムの静的構造—クラス、属性、操作、および関係—を記述します。テキスト仕様を書いて図としてレンダリングするため、ソースコードの編集やバージョン管理が容易になります。

1. 最小限の図

クラス図は@startumlで始まり、@enduml:

User クラスと Order クラスを定義する PlantUML コードと、それらの間の「places」関係を示す生成された図を表示する VPasCode インターフェース。

PlantUML は関係宣言からクラスを推論できますが、明示的に宣言することで、大規模な図の読みやすさと保守性が向上します。

2. クラス、属性、およびメソッド

属性と操作は中括弧内に記述します。コロンはメンバー名と型を区切り、括弧は操作を示します。

User クラスの PlantUML コードと、属性とメソッドを示すレンダリングされた図を並べて表示する VPasCode インターフェース。

@startuml
class User {
  -id: int
  -email: String
  +login(password: String): boolean
  +logout(): void
}
@enduml

可視性マーカーは次の通りです:

  • + public

  • - private

  • # protected

  • ~ package-private

メンバー名の前に型を書くこともできます。例えば、+String email または +void logout()PlantUML は、慣れ親しんだコード風のメンバー表記とこれらの可視性マーカーの両方をサポートしています。

静的メンバーと抽象メンバー

使用 {static} または {classifier} を静的メンバーに、{abstract} を抽象メンバーに使用します:

静的メンバーと抽象メンバーを持つ抽象的な PaymentMethod クラスと具体的な CardPayment クラスを定義する PlantUML コードを表示する VPasCode インターフェース。

@startuml
abstract class PaymentMethod {
  {abstract} +authorize(amount: Decimal): boolean
  {static} +supportedCurrencies: String[]
}

class CardPayment {
  +authorize(amount: Decimal): boolean
}

PaymentMethod <|-- CardPayment
@enduml

抽象クラスは以下のようにも宣言できますabstract class.

3. リレーションシップ

矢印の形状がリレーションシップの種類を示します。線の方向は名前の順序によって決定され、その意味を明確にするためにラベルを使用します。

リレーションシップ PlantUML 記法 一般的な意味
継承 / 一般化 `Parent < — Child`
インターフェース実装 `Interface < .. Class`
コンポジション Whole *-- Part 部分のライフサイクルは全体によって所有される
アグリゲーション Whole o-- Part 全体は、独立して存在できる部分をグループ化または参照する
方向付きアソシエーション A --> B A は B へのナビゲーション可能な関係を持つ
依存関係 A ..> B A は B を使用するか、B に依存する

これらは PlantUML の標準的なリレーションシップ記法です。

OrderService、Order、Repository 間の集約、関連、継承などの関係タイプを示す PlantUML コードとクラス図を表示する VPasCode インターフェース。

@startuml
interface Repository
class SqlRepository
class OrderService
class Order
class OrderLine

Repository <|.. SqlRepository
OrderService ..> Repository : uses
Order *-- "1..*" OrderLine : contains
@enduml

注意深く選択してください:コンポジションと集約は、異なるライフサイクルのセマンティクスを表します。部品が全体によって意味ある形で所有されている場合のみコンポジションを使用し、所有の解釈がどちらにも当てはまらない場合は、単純な関連を使用してください。

4. 多重度、役割名、およびラベル

多重度は、関連の各端で参加できるオブジェクトの数を指定します。一般的な形式には、"1", "0..1", "*"、および"1..*".

顧客と注文のクラスが「places」関係で結合され、多重度制約 1 と 0..* を持つ PlantUML クラス図を表示する VPasCode インターフェース。

ここでは、各注文は、1 つの顧客ですが、顧客はゼロ件以上の注文を依頼できます。多重性は反対側から読み取ってください:”の近くの数は注文は、顧客に関連付けられる注文の数を説明します。

より正確にするには、役割名または制約を追加してください:

役割名と制約注釈を持つ 1 対多の関連で結合された Team クラスと Player クラスを示す PlantUML クラス図を表示する VPasCode インターフェース。

@startuml
class Team
class Player

Team "1" o-- "0..*" Player : members
note on link
  プレーヤーはチーム間を移動する可能性があります。
end note
@enduml

5. インターフェース、列挙型、ステレオタイプ、およびパッケージ

PlantUMLは次のような宣言をサポートしています:インターフェース, 列挙型, 抽象クラス、および「」で囲まれたステレオタイプ<<と>>.

インターフェース、列挙型、ステレオタイプ、パッケージを含む PlantUML クラス図を表示する VPasCode インターフェース。

@startuml
package "Ordering" {
  interface PaymentGateway {
    +charge(amount: Decimal): PaymentResult
  }

  enum OrderStatus {
    NEW
    PAID
    CANCELLED
  }

  class Order <<Entity>> {
    +id: UUID
    +status: OrderStatus
  }

  class CheckoutService <<Service>> {
    +checkout(order: Order): PaymentResult
  }

  CheckoutService ..> PaymentGateway : calls
  Order --> OrderStatus
}
@enduml

パッケージは関連する型を視覚的にグループ化します。”<<Entity>>”や”<<Service>>”などのステレオタイプを使用して、有用な文脈を追加してください。ただし、クラス名ですでに示されている内容を単に繰り返すだけのラベルを追加するのは避けてください。<<Entity>> または “<<Service>>有用な文脈を追加する場合に使用してください。クラス名ですでに示されている内容を単に繰り返すだけのラベルを追加するのは避けてください。

6. 注釈、エイリアス、およびレイアウト

注釈は、クラス名を過剰に複雑にすることなく、設計上の意思決定を説明したり、制約を明確にしたりするために使用できます。表示名にスペースや句読記号が含まれる場合、エイリアスは役立ちます。

設計決定を説明する注釈付きの PlantUML コードと、左から右へのクラス図レイアウトを示す VPasCode のスクリーンショット。

@startuml
class "外部支払いAPI" as PaymentApi
class CheckoutService

CheckoutService ..> PaymentApi : 支払いを送信

note right of CheckoutService
  一時的な失敗を再試行します。
  拒否された支払いは再試行しません。
end note

left to right direction
@enduml

左から右の方向全体のレイアウト方向を変更します。デフォルトは上から下です。また、”-left->”や”-up-|>”などの関係方向を使用して、ローカルの配置を誘導することもできます。-left-> または “-up-|>を使用して、ローカルの配置を誘導します。

7. より完全な例

この例では、可視性、型、メソッド、列挙型、多重度、合成、および依存関係を組み合わせています。

Sales パッケージの PlantUML コードと、顧客、注文、製品の関係を示す対応するクラス図を表示する VPasCode インターフェース。

@startuml
左から右の方向

package "販売" {
  class Customer {
    -id: UUID
    +name: String
    +placeOrder(): Order
  }

  class Order {
    -id: UUID
    -status: OrderStatus
    +addLine(product: Product, quantity: int): void
    +total(): Decimal
  }

  class OrderLine {
    -quantity: int
    +lineTotal(): Decimal
  }

  class Product {
    +sku: String
    +price: Decimal
  }

  enum OrderStatus {
    NEW
    PAID
    CANCELLED
  }

  interface PaymentGateway {
    +charge(amount: Decimal): PaymentResult
  }

  class CheckoutService {
    +checkout(order: Order): PaymentResult
  }

  Customer "1" --> "0..*" Order : 注文を作成
  Order *-- "1..*" OrderLine : 含む
  OrderLine "*" --> "1" Product : 参照
  Order --> OrderStatus
  CheckoutService ..> PaymentGateway : 使用
}
@enduml

8. ツール:Visual Paradigm VPasCode

VPasCodeは、Visual Paradigmが提供するブラウザベースのテキストから図形への変換エディタです。PlantUMLのクラス図をサポートし、ライブプレビュー機能を備えたコードエディタを提供するため、PlantUMLを書いたり貼り付けたりしながら、作業中にレンダリングされた結果をリアルタイムで確認できます。

Visual Paradigm VPasCode で PlantUML コードを記述し、ライブプレビューのクラス図を表示する方法を示す 4 つのステップからなるワークフロー図。

一般的なワークフロー:

  1. VPasCodeを開き、PlantUMLエディタまたはPlantUMLのサンプルを選択します。

  2. スターターテキストを、図形を含む以下の内容に置き換えます。@startumlおよび@enduml.

  3. ライブプレビューを確認します。レンダリングに失敗した場合、強調表示された構文エラーとその行を確認してください。

  4. 図形を調整した後、必要に応じてエクスポートまたは共有してください。VPasCodeでは、SVG、PNG、PDFのエクスポートオプションについて説明しています。

VPasCodeは、Visual ParadigmテーマやRoseテーマなど、PlantUML用のテーマ選択インターフェースも提供しています。チームで一貫した結果を得るためには、エクスポートされた画像だけに頼るのではなく、ドキュメントやコードと一緒にPlantUMLのソースコードを保持してください。

9. 一般的な落とし穴とベストプラクティス

関連、集約、多重度、図の整理をカバーする PlantUML クラス図の 6 つのベストプラクティスを示すインフォグラフィック。

  • 関連(association)と依存関係(dependency)を混同しないでください。依存関係は一般的に「使用する」ことを意味し、関連はより永続的な構造的な関係を表すことが多いです。

  • 合成(composition)の使いすぎを避けてください。合成は、単なる接続よりも強いライフサイクルの主張を行います。

  • 多重度(multiplicity)は、反対側の端からラベル付けしてください。あるクラスの横にある数は、そのクラスのインスタンスがもう一方の端のインスタンスと関連付けられる可能性のある数を示します。

  • 図形は焦点を絞って作成してください。非常に大きなモデルは、パッケージや、異なる関心事項のための別々の図形に分割してください。

  • 視聴者に役立つ詳細を表示してください。概念的な概要では、クラス名と関係のみで十分な場合があります。設計レベルの図形では、型、可視性、操作が必要になる場合があります。

  • ソースコードを維持すべき成果物として扱ってください。テキストの変更を確認し、編集後にレンダリングし、ソースが変更された場合はエクスポートを再生成してください。

クイックリファレンス

継承、集約、関連関係を示す生成されたクラス図と並べて PlantUML コード構文を表示する VPasCode インターフェース。

@startuml
class A {
  +publicField: String
  -privateField: int
  #protectedMethod(): void
  ~packageMember(): boolean
}

interface I
abstract class Base
enum State { READY; DONE }

Base <|-- A
I <|.. A
A *-- B : composition
A o-- C : aggregation
A --> D : association
A ..> I : dependency
@enduml

図のさらなる洗練が必要な場合、PlantUML はメンバーのグループ化、注釈、色など、追加のクラス図機能をサポートします。

結論

より迅速なワークフローのためのスマートな図の構築
PlantUML における変数とプリプロセッサディレクティブの習得は、単なる構文のアップグレード以上のものです。それは、スケーラブルで保守可能なドキュメンテーションへの転換を意味します。設定値を一元化し、動的ロジックを活用することで、アーキテクチャ図における冗長性を減らし、人的エラーのリスクを最小限に抑えることができます。VPasCodeVPasCode は、直感的で AI を支援する環境を提供することで、これらの利点をさらに高めます。ここでは、変更をリアルタイムで可視化し、複雑なスクリプトを簡単にデバッグできます。単純なサービス名の定義から複雑な JSON 設定の管理まで、これらのテクニックにより、それらが表すシステムと同様に堅牢で適応性の高い図を作成できるようになります。今日からこれらの実践を日常のワークフローに統合し、図作成のプロセスを手作業の負担から、効率的で自動化された資産へと変革しましょう。