ドキュメントへ移動

モデルクラスと契約

クラス図の使い方

クラスを視覚的に作成します。メンバーと関連を定義し、モデルのチェックを確認し、パッケージを整理して、図を保存・エクスポートします。

クラスと関連 → クラス図クラス図を開く

クラスとその責任を設計する

クラス図は、クラス、抽象クラス、インターフェース、および列挙型のための独立した視覚的ワークスペースです。各分類子には、名前、属性またはリテラルコンパートメント、および操作コンパートメントがあります。抽象名は斜体で表示され、インターフェースと列挙型はそのステレオタイプを表示します。クラスを選択し、「ヘッダーの色」を使用してプリセット、カスタムカラー、またはニュートラルを選択します。ヘッダーの色は保存され、元に戻す/やり直すがサポートされ、画像のエクスポートに表示されます。メンバーのテキストは読みやすい状態を維持します。

新しい図を作成する場合、「空白の図」または「注文システムテンプレート」を選択するように求められます。新しい図は、クラウドに保存されるか JSON としてダウンロードされるまでメモリ内に残ります。コンパクトなエディターバーには、図の名前、ファイルメニュー、元に戻す/やり直し、テーマコントロール、画像のエクスポートが含まれています。クラス図のクラウドファイルは、SQL、Prisma、および ERD ビルダーのドキュメントとは別個のものです。

最初のクラス図を構築する

  1. 「クラス図」を開き、「空白の図」または「注文システムテンプレート」を選択します。「ファイル」→「新しい図」で再度選択画面が開き、「ファイル」→「空白」で現在の図が置き換えられます(確認と取り消し機能あり)。
  2. 「クラス」をクリックするか、ライブラリからキャンバスにドラッグし、インスペクターで Customer に名前を変更し(狭い画面では「詳細を編集」を使用)、可視性 Private (-) と型 UUID を持つ id 属性を追加します。
  3. カスタム分類子の場合は、[カスタム分類子] を選択するか、既存の分類子のオプションの [ステレオタイプ] フィールドを編集します。entity、service、controller などのタグは、名前の上に «your tag» として表示され、クラウドファイル、JSON、および画像のエクスポートに含まれます。これらは選択したベース分類子の動作を維持し、ツールは UML プロファイルを検証しません。
  4. Order という名前の別のクラスを追加します。戻り値の型が Decimal の calculateTotal などの操作を追加します。ガイド付きフィールドには、確定する前にプレビューが表示されます。
  5. リレーションシップのライブラリから [関連 (Association)] を選択します。「From (元)」は、クラスが選択されている場合は選択されたクラスから始まります。「From」を Customer に、「To (先)」を Order に設定し、作成します。コネクタを選択してラベルと多重度を追加します。
  6. 両方の項目を一度に作成するには、クラスを選択して「新規接続」を選択します。「接続されたクラスの追加」では、新しい分類子、オプションの名前、リレーションシップ、方向を選択できます。継承と実現は最初、新しい子または実装者を選択された親または契約にポイントします。その他のタイプは最初、選択されたクラスから新しいクラスをポイントします。「接続されたクラスの作成」により、1回のアンドゥステップで両方がコミットされます。「キャンセル」または Escape キーでフォームを破棄します。
  7. 「ダイアグラムの整列と調整」を使用し、「ファイル」から編集可能なバックアップ用のJSONをダウンロードするか、PNG、JPEG、WebP、ベクターSVG、またはPDF用に「ダイアグラムをエクスポート」します。

属性、リテラル、および可視性

分類子を選択し、「フィールド」を使用して、名前、必須型、可視性、およびオプションのデフォルト値を持つ属性を追加します。型の提案には一般的な型と分類子名が含まれます。カスタム型も許可されます。「追加」または「保存」でプレビューを1回の編集でコミットします。「キャンセル」または「エスケープ」で保留中のフォームを破棄します。

可視性には、publicに +、privateに -、protectedに #、packageに ~ を使用します。テキストモードでは1行につき1つのメンバーを受け付けます。フォーマット機能はサポートされている有効なシグネチャのみを整頓します。カスタム表記はテキストのまま維持され、別の行が変更された場合でも保持されます。

列挙型では、属性の代わりにリテラルを使用します。リテラル名とオプションの値(例: ACTIVE = "active")を入力します。ガイド付きフィールドでは、重複するメンバー名が拒否されます。カスタムテキストは、フィールドで表現できない場合でも保持されます。

UML attributes / 属性シグネチャ
- id: UUID
+ displayName: String
# active: Boolean = true
~ tags: List<String> = []
メンバー構文は、完全なUMLやプログラミング言語の型チェッカーではなく、保守的な編集支援です。型名は、他の分類子を自動的に作成したりリンクさせたりしません。

操作と型付きパラメータ

操作には、可視性、名前、オプションのデフォルト値を持つ型付きパラメータ、およびオプションの戻り値の型があります。「パラメータを追加」を行うと入力行が挿入され、削除ボタンを押すとその保留中のパラメータが削除されます。新しい操作の戻り値の型はデフォルトで void になります。

テキストモードでは、name(parameter: Type): ReturnType と記述し、オプションで可視性プレフィックスを付けます。ネストされたジェネリック型と引用符で囲まれたデフォルトがサポートされています。各パラメータには、一意の名前と型が必要です。オーバーロードは、パラメータの型が異なる場合に操作名を共有できます。

UML operations / 操作シグネチャ
+ placeOrder(items: List<OrderItem>): Order
+ findOrders(status: String = "open"): List<Order>
- calculateTotal(): Decimal

リレーションシップ表記を選択してください

クラスにホバーまたはキーボードフォーカスを合わせる(タッチスクリーンではタップして選択)と接続ポイントが表示され、別のクラスにドラッグして関連付けを作成できます。ポイントは非アクティブ時および読み取り専用の図では非表示のままになります。ライブラリからリレーションシップを選択することもできます。インスペクターを使用すると、タイプ、エンドポイント、ラベル、および 1、0..1、0..* などのエンドポイントの多重度を変更できます。多重度は編集可能なテキストであり、ツールはビジネスルールを推論しません。

各多重度には、1、0..1、0..*、および 1..* のプリセットがあります。カスタムテキストは編集可能なまま保持されます。リレーションシップの意味は、実際の方向(親/契約、または全体/部分)と関連付けの数を示します。To の多重度は From あたりのインスタンス数をカウントし、From の多重度はその逆をカウントします。ガイダンスはセマンティック検証を追加しません。

リレーションシップ名は、コネクタの中点付近に直接配置されます。多重度は自身のクラス境界の近くに配置され、UML のヘッドを避けます。ラベルはライブドラッグに追従し、離すと他のラベルに対して収まります。長いテキストは折り返され、ラベルが線上に収まらない場合、混雑したルートには明確なフォールバックが必要になることがあります。

ロールとナビゲーションでは、関連するクラスの横にオプションの「送信元ロール」と「送信先ロール」が追加されます。異なるロールやラベルによって、billingAddress や shippingAddress などの並行する構造的リンクが区別されます。関連のナビゲーションは、送信元、送信先、またはその両方を指すことができます。その他の関係タイプは、セマンティックヘッドを保持します。

ツールは、欠落しているエンドポイント、まったく同じ方向/タイプ/ラベル/構造的役割を持つ重複、継承サイクル、および自己継承または実現を拒否します。多重度、ナビゲーション、およびパスの変更だけでは、別個のリンクにはなりません。関連、集約、複合、および依存関係は、クラス自体を結合する場合があります。これらの構造チェックは、完全な UML 意味論的有効性を確立するものではありません。

リレーションシップ表記を選択してください
リレーションシップ方向とシンボル
関連関連付けられた分類子間の線。オプションのナビゲーション矢印は到達可能なクラスを指します。再帰的なリンクもサポートされています。
継承From はサブクラスです。実線が親である To の中空の三角形で終わります。
実現From は To のコントラクトを実装します。破線が To の中空の三角形で終わります。
集約From は全体であり、To は部分です。中空のひし形は From に属します。
コンポジションFrom は To のライフタイムを所有します。塗りつぶされたひし形は From に属します。
依存From は To に依存します。破線のオープン矢印が To のサプライヤーを指します。

自動の側面、固定されたヘッダー、およびパス

新しいダイアグラムのデフォルトは「曲線」です。キャンバス ツールバーの [表示] → [接続パス] では、すべてのパスと新しい接続のデフォルトを設定するために「曲線」と「エルボー」を提供します。エルボーは、小さな角丸を持つ水平および垂直のセグメントを使用します。コネクタを選択して、その線パスを個別に上書きします。

新しい接続は、クラスの移動やサイズ変更に伴い、適切な側面を自動的に選択します。左と右の接続はヘッダーにアタッチされます。上と下は対応するカードの境界にアタッチされます。インスペクターで上、下、左、または右を選択すると、その端点のみが固定され、そのパートナーは自動追従を継続できます。

開始側または終了側の選択欄で「自動」を選ぶと、その端がクラスの位置に追従します。「両端を自動」で両端の固定を解除します。選択した端をドラッグして接続側を変え、中央の点をドラッグして線を曲げます。Escape でキャンセルし、Home またはダブルクリックで曲がりをリセットします。「接続をリセット」で自動経路に戻ります。調整は元に戻す操作、保存、画像出力に対応します。

パスは接続されたカードを避けて通ります。再帰的リンクはクラスの外側をループし、並行リンクは別々のルートを使用します。配置と自動側面により読みやすさが向上しますが、無関係なカードや他の接続をすべて回避できるとは保証されません。側面モードのない古い JSON ドラフトは、「自動」を選択するまで保存された側面を保持します。

モデルを確認して安全に名前を変更する

チェックは、メンバー表記、名前、多重度の境界、継承構造に関するエラー、警告、提案を開きます。問題を選択すると、そのクラスまたはリレーションシップと関連するフィールドが表示されます。チェックはカスタムテキストを保持し、自動修正は行わず、プログラミング言語のコンパイラとしては機能しません。

選択したクラスでの参照の名前変更... により、属性、操作パラメータ、および戻り値の型における正確な型参照のプレビューが表示されます。更新する参照を選択し、名前と参照を1つの取り消しステップとして適用します。カスタム表記、デフォルト、修飾された外部型、および繰り返される分類子名へのあいまいな参照は変更されません。

選択された型の置き換えは、各メンバー区画の8,000文字の制限内に収まる必要があります。変更案が制限を超える場合は、一部の参照の選択を解除するか、すべての参照選択をクリアしてクラス名のみを変更してください。ツールはメンバーのテキストを省略するのではなく、サイズオーバーの更新を拒否します。

クラスの整列、均等配置、およびロック

レイアウト機能には、選択したクラスの整列、水平/垂直方向の等間隔配置、選択範囲の配置、位置のロック、および配置ガイドへのスナップの切り替えがあります。Ctrl/Cmdキーを押しながらクリックしてクラスを選択します。ロックされたクラスは、ドラッグ、パッケージの移動、配置の際にも固定されたままとなり、ロック状態は保存されます。等間隔配置は外側のクラスを維持し、混雑した範囲は変更しません。選択範囲の配置では他のクラスは固定されたままそのブロックを配置するか、配置が収まらない場合は図をそのまま維持します。単一クラスのドラッグは6ピクセル以内でスナップします。ガイドとその切り替え設定は保存ファイルには含まれません。

キャンバスの配置とナビゲーション

スマート配置については「配置」をクリックします。クラスのサイズとリレーションシップの構造を使用し、親とインターフェースを子の上に配置し、切断されたグループを分離します。ドロップダウンでは、「左から右」、「上から下」、「コンパクト」も提供されます。

配置はリレーションシップの意味と固定された端点を維持し、自動の側面を更新し、結果を合わせます。「元に戻す」で1ステップで元に戻ります。レイアウトエンジンの読み込み中にドキュメントが変更された場合、古い結果は破棄されます。新しいドキュメントのために再度配置してください。

大きなレイアウトは、保存された位置制限内で一緒に移動します。配置が収まらない場合、図はそのまま維持されます。「名前のみ」や別の方向を試してから、再度配置してください。

クラスをドラッグして位置を調整し、空のキャンバスをドラッグしてパンし、スクロールしてズームします。「図体に合わせる」およびズームコントロールはナビゲーションに役立ち、ミニマップに全体像が表示されます。幅が900pxまでの場合、インスペクターはキャンバスの下に移動します。クラスまたは接続を選択し、「詳細の編集」(共有ファイルの場合は「詳細を表示」)を選択してアクセスします。「図に戻る」でキャンバスに戻ります。リレーションシップを選択すると、表示モードでそのフォームが開きます。現在のドラフトが開いたままになるよう、クラス図ガイドは別のタブで開きます。

「検索」または Ctrl/Cmd+K で、名前、ステレオタイプ、属性、操作、パッケージ名、ノートを検索します。上/下矢印キーと Enter キーを使用して結果を選択および中央に配置します。メンバーの結果を選択すると、そのクラスの詳細全体が表示され、一致するインスペクターセクションにフォーカスが当たります。Escape で検索を閉じます。「接続にフォーカス」を選択すると、選択したクラスとすぐ近くの隣接要素が強調表示され、関連のない要素の明るさが落ちます。「すべて表示」または Escape でフォーカスが解除されます。

キャンバスツールバーの「表示」を開き、「すべての詳細」、「属性のみ」、「名前のみ」から選択します。「属性のみ」では属性または列挙リテラルが保持され、操作が要約されます。「名前のみ」ではメンバー数が表示されます。クラスにホバー、フォーカス、または選択を行うとその詳細レベルが上書きされ、「図のデフォルト」を選択すると継承されます。グローバルレベルを変更すると、上書きがクリアされます。フォーカスと詳細は共有ファイルでも機能し、保存されたドキュメントや「元に戻す/やり直す」の外部に留まり、メンバーのテキストを変更しません。画像は選択された詳細レベルに従いますが、JSON およびクラウドファイルはすべてのメンバーを保持します。

Ctrl/Cmd キーを押しながらクリックして、グループを選択します。コンパクトな選択ツールバーには、該当する場合に「フォーカス」、「複製」、「新規接続」が表示されます。「その他の選択アクション」には、「選択のコピー」、「パッケージの作成」、「選択の削除」が含まれます。「モバイル詳細の編集」または「詳細の表示」をクリックすると、引き続きインスペクターが開きます。「選択の複製」はオフセットコピーを作成します。「選択のコピー」と「貼り付け」を使用すると、ブラウザのクリップボードアクセスが利用可能な場合に、クラス図間でクラスやノートを転送できます。メモリ内コピーにより、ワークスペース内での貼り付けがサポートされます。コピーには新しいIDと未使用の名前が割り当てられ、グループのオフセットと内部リレーションシップが維持され、すべてのクラスがコピーされた場合にのみパッケージが含まれます。パッケージを選択すると、そのすべてのメンバーがコピーされます。複製または貼り付けは1つの取り消しステップです。テキストフィールドはネイティブのコピー/貼り付け動作を維持します。

ノートを追加し、パッケージ内でクラスをグループ化する

ノート — コメントを追加するとノートが作成され、インスペクターでノートテキストにフォーカスが当たります。空のキャンバスノートには「ノートを記述…」と表示されます。「ノートを添付」すると、破線でクラスやリレーションシップにリンクされます。ノートは配置された場所に留まり、テザーがターゲットを追跡します。ターゲットを削除するとノートは切り離されますが、テキストは保持されます。長いノートは境界付きプレビューに折り返されますが、完全なテキストは編集可能です。

パッケージ — グループクラスは、選択したクラスを即座にグループ化します。何も選択されていない場合は、メンバーと任意のパッケージ名を選択してから「パッケージを作成」します。各クラスは最大1つのパッケージに属します。メンバーが位置固定されていない限り、ヘッダーをドラッグしてメンバーをまとめて移動できます。「クラスのグループ化解除」を行うと、フレームのみが削除されます。ヘッダーの山括弧またはインスペクターを使用して、パッケージを外部接続を持つクラス数へと折りたたむことができます。「検索とチェック」によりパッケージが展開され、メンバーが表示されます。パッケージは視覚的なグループであり、名前空間やセマンティックな関係のエンドポイントではありません。折りたたみは表示のみです。JSON およびクラウドにはすべてのメンバーとリンクが保持され、画像は表示されたビューと一致します。

クラウドファイル、ポータブル JSON、および画像

「ファイル」→「PlantUML のエクスポート」は編集可能なソースをプレビューし、「テキストのコピー」または「.puml のダウンロード」を提供します。すべてのメンバー、種類、ステレオタイプ、色、役割/ナビゲーション/多重度、パッケージ、およびノートをローカルにエクスポートします。PlantUML は独自のレイアウトを選択するため、キャンバスの位置、固定された辺、位置のロック、および折りたたまれたビューはエクスポートされません。完全な編集可能なダイアグラムを保持するには JSON を使用してください。PlantUML のインポートは利用できません。

クラス図は、ブラウザのストレージに図を保存しません。新しい図はメモリ内に残ります。保存 (Ctrl/Cmd+S) は、必要なときにサインインし、独立したクラス図のクラウドファイルを作成または更新します。「ファイル」→「クラス図を開く」を開くと、独自の検索可能なファイルリストが開きます。「ファイル」→「クラス図を共有」は、パブリックアクセスを制御します。閲覧者は検査およびエクスポートできますが、編集はできません。未保存の図がある場合は、離れたりリロードしたりする前に確認メッセージが表示されます。「ファイル」から JSON をダウンロードして編集可能なコピーを保持し、「JSON のインポート」を使用してエクスポートされたバージョン 1 の Erd Go クラス図ファイルを再度開きます。インポートは置換の前に検証されます。

[空白]、[例]、[インポート] は、空ではない図を置き換える前に確認を行い、元に戻す(Undo)をサポートします。[図のエクスポート] では、PNG、JPEG、WebP、スタンドアロンのベクター SVG、および白背景の画像ベース PDF を提供します。画面外のクラスも含めて図全体をキャプチャするか(デフォルト)、現在のビューをキャプチャします。HD、2K、および 4K のプリセットは、1辺あたり 8192px 以内および 1,600 万ピクセル以内で比率を維持します。ベクター SVG は自由に拡大縮小します。さらなる図の編集のために、JSON またはクラウドファイルを保持してください。

オプションのメモとパッケージは、既存のバージョン1形式を拡張します。古いファイルはそれらなしでも引き続き開くことができます。制限は、200個の分類子、600個のリレーションシップ、最大2,000文字の100個のメモ、50個のパッケージ、メンバー区画あたり8,000文字、および32 MBのインポートされたJSONファイルです。クラウドファイル名は3~255文字である必要があります。保存されていない図を保持するには、離れる前にクラウドに保存するか、JSONをダウンロードしてください。古いブラウザローカルの下書きはそのまま残り、自動的には開かれなくなります。

このツールでは、ソースコード生成、SQL 変換、およびテキストから図へのインポートは利用できません。

キーボードショートカット

キーボードショートカット
アクションショートカット
クラウドに保存Ctrl/Cmd+S。プロンプトが表示されたらサインインします。
クラス、メンバー、パッケージ、またはノートを検索Ctrl/Cmd+K、次に上/下矢印キーと Enter。
選択範囲のコピー / 貼り付けキャンバスからの Ctrl/Cmd+C / Ctrl/Cmd+V。貼り付けには編集可能なダイアグラムが必要です。
選択範囲の複製キャンバスからの Ctrl/Cmd+D。
元に戻す / やり直しキャンバスからの Ctrl/Cmd+Z / Ctrl/Cmd+Shift+Z または Ctrl/Cmd+Y。
選択範囲を削除キャンバスから削除またはバックスペースを実行します。クラスを削除すると、それに関連する関係も削除されます。
コネクタの側面を選択選択したコネクタのヘッドにフォーカスし、矢印キーを使用します。
キャンセルまたは閉じるEscape キーを押すと、メンバー、接続されたクラス、パッケージフォーム、またはコネクタヘッドのプレビューがキャンセルされ、[検索] やメニューが閉じられるか、キャンバスからの [フォーカス接続] が終了します。
「元に戻す / やり直し」は最大80件のドキュメント変更を保持します。フォーカスされたテキスト編集やノードのドラッグはグループ化され、カメラの変更は履歴に含まれません。フィールドの編集、フォームの使用、またはメニューを開いている間、キャンバスのショートカットによってダイアグラム要素が削除されることはありません。

ダイアグラムのトラブルシューティング

ダイアグラムのトラブルシューティング
症状試すべきこと
予期せぬ側にヘッドが留まっていますその端が「固定」されているかどうかを確認します。自動配置を再開するには、その「自動」コントロールを選択します。
リレーションシップが拒否されましたエンドポイント、正確な重複、自己継承/具象化、および継承サイクルを確認します。異なる構造的リンクには、異なる役割またはラベルを付与します。
メンバーを保存できません必要な名前/型を指定し、重複するパラメータ名やメンバーシグネチャを削除し、検証メッセージを確認します。サポートされていないカスタム表記にはテキストを使用してください。
メンバーが変更されたというフォームのメッセージ元に戻す(Undo)やその他のテキスト編集の後にキャンセルして再度開き、現在のメンバーバージョンを使用します。
クラスまたはメンバーが非表示になっています「検索」または Ctrl/Cmd+K を使用します。メンバーの結果は詳細全体を表示し、一致するインスペクターセクションにフォーカスします。「図に合わせる」やミニマップも役立ちます。
ファイルをインポートできませんSQL、ビルダーファイル、SVG、モデリングプランではなく、エクスポートされた Erd Go クラス図 JSON ファイルを選択してください。エラーが発生した場合でも、現在の図は保持されます。
クラウドの保存に失敗しました図を開いたまま、サインインと接続を確認してから再試行してください。ページを離れる前にJSONをダウンロードして、編集可能なバックアップを保持してください。

AIを使用してクラスモデルを計画する

「AI プロンプトのコピー」を使用してこのガイドをアシスタントと共有し、責任、所有権、継承、および多重度について説明します。要件によってリレーションシップがあいまいになっている場合は説明を求めてください。

分類子名、メンバーシグネチャ、および明示的な From および To ロールを持つリレーションシップリストをリクエストします。ビジュアルライブラリとインスペクターを使用して結果を構築します。次の計画は記述的なものであり、インポート言語ではありません。

Modeling plan / UMLモデリングプラン
Class Customer
  Attribute: - id: UUID
  Operation: + placeOrder(items: List<OrderItem>): Order

Class Order
  Operation: + calculateTotal(): Decimal

Association: Customer → Order
  Label: places
  Customer end: 1
  Order end: 0..*