PART 01 — はじめに
CRUD図とはなにか・シリーズの目的と構成

CRUD図という言葉自体は知っていても、実際に自動生成しようとすると行と列の粒度をどう決めるかで意外と悩まされます。このシリーズでは、フレームワークに依存しない静的解析でCRUD図を作る一連の流れを最初から整理していきます。

CRUD図とは

図1: Java CRUD解析フロー — ソースからSQL抽出・テーブル解析・マトリクス表生成・HTMLレポート出力まで

CRUD図（CRUD Matrix / CRUD Diagram）とは、システム内の各機能・クラス・モジュールが、どのテーブルに対して Create（挿入）・Read（参照）・Update（更新）・Delete（削除） のどの操作を行うかを一覧化した図です。

縦軸に機能/クラス、横軸にテーブルを並べた行列（マトリクス）形式が最も一般的で、各セルに C / R / U / D を組み合わせた記号を書き入れます。

| クラス / テーブル    | users | orders | products | order_items |
|---------------------|-------|--------|----------|-------------|
| UserService         | CR    |        |          |             |
| OrderService        | R     | CRU    | R        | CRD         |
| ProductService      |       |        | CRUD     |             |
| ReportService       | R     | R      | R        | R           |

上表から「OrderService は order_items テーブルの Create・Read・Delete を行う」「ReportService はすべてのテーブルに対して Read のみ」といった依存関係が一目でわかります。

なぜCRUD図が必要か

CRUD図は次のような場面で特に力を発揮します。

既存ツールの限界

CRUD図を自動生成するツールはいくつか存在しますが、多くは特定フレームワークに依存しています。

このシリーズのアプローチ

本シリーズでは Javaソースコードの静的解析 によるアプローチを採ります。 ソースコードをASTに変換して文字列リテラルを走査し、SQL文を取り出してテーブル名と操作種別を判別します。 ORMやフレームワークに関係なく、SQLが文字列として現れるコードであればすべてが対象です。

シリーズ全体構成

使用技術スタック

Java CRUD図生成でよくある誤り

JavaソースからCRUD図を自動生成する際、シリーズ全体の設計方針を誤解したまま実装を始めると後工程で大きな手戻りが発生します。