dddjava / jig Goto Github PK

View Code? Open in Web Editor NEW

278.0 17.0 23.0 7.17 MB

Home Page: https://dddjava.github.io/jig/

License: Apache License 2.0

Java 95.85% Kotlin 0.10% CSS 0.42% HTML 2.90% JavaScript 0.28% Groovy 0.45%

jig's Introduction

JIG

JIGはコードでの設計を支援するツールです。思い浮かんだ設計をコーディングすればいい感じに可視化される世界を目指しています。

主にバイトコード（classファイル）から一覧や図を出力します。バイトコードが対象なので、JVM言語であれば主要機能は動作します。

サンプル

サンプルリポジトリを参照してください。

使い方

実行方法はコマンドラインとGradleプラグインがあります。それぞれのREADMEを参照してください。

実行には Java11以降と Graphviz が必要です。より詳しい情報はWikiを参照してください。うまく動かない場合などは issue でお問い合わせください。

コンセプト

三層＋ドメインモデルのアーキテクチャで実装されたコードから、以下の分析・設計情報を生成します。

ドメインモデルのクラスに記述された業務の概念とビジネスルール
アプリケーション層に記述された業務機能

想定するアーキテクチャ

三層＋ドメインモデルのアーキテクチャでの使用を想定しています。

JIGドキュメント

JIGの生成する分析・設計情報をJIGドキュメントと呼んでいます。

種類は JigDocument を参照してください。
サンプルは JIGのドッグフーディングを参照してください。

LICENSE

Apache License 2.0

jig's People

Contributors

Stargazers

Watchers

jig's Issues

JDK10でビルドエラー

java.nio.file.FileSystemNotFoundException
	at jdk.zipfs/jdk.nio.zipfs.ZipFileSystemProvider.getFileSystem(ZipFileSystemProvider.java:169)
	at jdk.zipfs/jdk.nio.zipfs.ZipFileSystemProvider.getPath(ZipFileSystemProvider.java:155)
	at java.base/java.nio.file.Paths.get(Paths.java:143)
	at jig.infrastructure.mybatis.MyBatisSqlResolver.resolve(MyBatisSqlResolver.java:72)

一覧の同じ項目に同じものが出力される

使用箇所やテーブル名が該当。
複数使用していたらその分だけ出る。

一覧出力時に省く。

クラス名の表記：完全修飾からミニマム修飾に変える

classリストのクラス名の完全修飾名が冗長

*.service
*.domain.[model|basic]

までの修飾は、非表示にしたい。
service, domain.model も非表示

その他のアイデア

完全修飾名は、オプションで表示する（デフォルトは、表示しない）
完全修飾名と最少修飾名を２つのカラムに出力し、使う側がカラムの非表示などの対応をする

MODELの条件を外から指定できるようにする

.domain.model. 固定にしてるので。

https://github.com/irof/Jig/blob/5dae6d7950225daf378e545581ac41050b462328/jig-core/src/main/java/jig/domain/model/specification/Specification.java#L73-L76

バリエーションモデルを作る

それっぽいものが出るところまでがスコープ

enumを列挙する
javadoc?

処理時間の計測とか

手動で確認しているが、そこそこ大きなプロジェクトを対象に自動実行させたい。

サンプルアプリケーション

選ぶか作るか

状態遷移図出力を独立して動かせるようにする

statemachine.groovy は同じプロジェクトのどこかしらに置いて実行する形になってる

gradleから独立させる

https://github.com/irof/Jig/blob/2fb5dff35d5971ec4a5c749c127d70ef43e113e5/packagedependencies.sh#L10

要望：依存関係のないパッケージも、孤立パッケージとして表示したい

model 以下のパッケージは、依存関係がない場合も、孤立したパッケージとして、存在だけは、パッケージ図に表示したい

依存パッケージがない場合の出し方

依存がないパッケージは表示されない
全部独立したパッケージだと何も出せなくて落ちる → f094b8f で落ちなくなった（空っぽの画像が出る）

依存がなくてもパッケージがあれば出したいところ

Java9,10に対応する

実行時に --add-modules java.xml.bind が要る。

以下は #37 で片付く。

compile files("${System.getProperty('java.home')}/../lib/tools.jar") は意味がない。
jdepsは jdk.jdeps.jmod になり、指定自体が不要。
java9でビルドすると tools.jar がアーカイブに入らず、このjarをjava8で java -jar するとjdepsのクラスロードに失敗する。
java -cp package-diagram-cli.jar:{...}/tools.jar org.springframework.boot.loader.JarLauncher の形でならば実行可。（ tools.jar がアーカイブに含まれるの自体が問題）
jdepsの出力フォーマットが変わる。バージョンで読み方を変えるか、-dotoutputした方を読むか。