序章
「二度測って一度切る」という言葉は誰でも聞いたことがあると思います。これはプログラミングにおける真実のアドバイスです。実装に時間を費やす前に、実装について検討することをお勧めします。実装中には、クラスを作成し、それらがどのように相互作用するかを考える必要があることがよくあります。すべてを視覚的に表現すると、最も正しい解決策を見つけるのに役立つことがよくあります。ここで UML クラス図が役に立ちます。UMLとは何ですか?
検索エンジンで関連する画像を見ると、UML が図、矢印、四角形と関係があることがわかります。UML は Unified Modeling Language の略であることを知っておく必要があります。ここで重要な言葉は「統一」です。これは、私たちの画像が私たちだけでなく、UML を知っている他の人にも理解されることを意味します。それは図を描くための共通語です。ウィキペディアによると、
「UML は、ソフトウェア エンジニアリングの分野における汎用の開発用モデリング言語であり、システムの設計を視覚化する標準的な方法を提供することを目的としています。」最も興味深いのは、誰もが想像することではないでしょうが、UML には仕様があるということです。さらに、UML 2 仕様もあります。仕様の詳細については、Object Management Group のWeb サイトをご覧ください。実際、このグループは UML 仕様を開発しています。UML がクラスの構造を記述することに限定されていないことも興味深いです。UML 図には多くの種類があります。ウィキペディアには、さまざまなタイプの UML 図の簡単な説明があります: UML 図。UML クラス図に戻ると、 『Head First Design Patterns』という書籍に言及する価値があります。本書では、UML 図を使用して設計パターンを説明しています。肝心なのは、UML が実際に使用されているということです。そして、それを知って使用方法を理解すると、非常に役立つことがわかりました。
応用
IDE で UML を操作できることを見てみましょう。IDE として IntelliJ IDEA を使用します。IntelliJ IDEA Ultimate を使用している場合は、「すぐに使える」「UML Support」プラグインがインストールされています。美しいクラス図を自動的に生成できます。たとえば、Ctrl+N または [ナビゲート] -> [クラス] メニュー項目を使用して、ArrayList クラスに移動します。クラス名のコンテキストメニューで、「ダイアグラム」→「ダイアグラムポップアップを表示」を選択します。その結果、美しい図が得られます。
しかし、自分で図を描きたい場合はどうすればよいでしょうか? Ultimate バージョンをお持ちでない場合はどうすればよいでしょうか? IntelliJ IDEA Community Edition を使用する以外に選択肢はありません。したがって、UML 図がどのように構成されているかを理解する必要があります。初め、。グラフ視覚化ツールのセットです。使用するプラグインはそれに依存します。インストール後、Graphviz インストール ディレクトリの bin ディレクトリを PATH 環境変数に追加する必要があります。その後、IntelliJ IDEA で、メニューから [ファイル] -> [設定] を選択します。「設定」ウィンドウで「プラグイン」カテゴリを選択し、「リポジトリの参照」ボタンをクリックして、PlantUML 統合プラグインをインストールします。PlantUML の何がそんなに優れているのでしょうか? UML は「ドット」と呼ばれるグラフ記述言語を使用して記述されており、ドット言語は PlantUML 以外でも使用されるため、より汎用的になります。さらに、以下で行うことはすべて IDE だけでなく、planttext.comでオンラインでも実行できます。。PlantUMLプラグインをインストールすると、「ファイル」→「新規作成」でUML図を作成できるようになります。「UMLクラス」図を作成してみましょう。これにより、例を含むテンプレートが自動的に生成されます。そのコンテンツを削除し、独自のコンテンツを追加します。これをテキストで表現する方法を理解するには、PlantUML マニュアルの plantuml クラス図を参照してください。 
これらの資料を基に、UML 図の作成を始めましょう。2 つのクラスを説明する次のコンテンツを追加します。
@startuml
class ArrayList {
}
class LinkedList {
}
@enduml
interface List
List <|.. ArrayList
List <|.. LinkedList
interface Collection
Collection <|-- List
~Object[] elementData
class Object{
}
ArrayList o- Object
class Node{
}
LinkedList *-- Node
class ListIterator
ListIterator <... ArrayList : create
ListIterator <... LinkedList : create
必要に応じて詳細を追加できます。もちろん、このような図を描くのは特別なことではありません。自分のタスクに取り組むときに、手ですぐに引き出すことができます。これは、間違ったモデルの実装に 1 日を費やしてからではなく、アプリケーションのアーキテクチャを徹底的に検討し、クラス構造の欠点を早い段階で特定する能力を養うのに役立ちます。それは試してみる良い理由だと思いませんか? :)
オートメーション
PlantUML 図を自動生成するにはさまざまな方法があります。たとえば、IDEA にはSketchITプラグインがありますが、図は完全に正しく描画されません。インターフェイスの実装が正しく描画されていないとします (継承として表示されます)。これをプロジェクトのビルド プロセスに統合する方法の例がインターネットにあります。たとえば、 Maven でuml-java-docklet を使用する方法を見つけることができます。デモのために、 Maven Archetype を使用してMaven プロジェクトをすばやく作成します。走る
mvn archetype:generate
この記事の主題ではないため、Maven に関する質問への回答はMaven ユーザー センターで見つけることができます。生成されたプロジェクトで、プロジェクト説明ファイル pom.xml を開いて編集します。uml-java-docklet インストールの説明の内容をこのファイルにコピーします。説明で使用されているアーティファクトが Maven Central リポジトリに見つかりません。しかし、次は私にとってはうまくいきました: https://mvnrepository.com/artifact/com.chfourie/uml-java-doclet/1.0.0。つまり、説明で groupId を「info.leadinglight」から「com.chfourie」に置き換え、バージョンを「1.0.0」に設定するだけです。その後、pom.xml ファイルのあるディレクトリで次のコマンドを実行できます。
mvn clean install
mvn javadoc: javadoc
GO TO FULL VERSION