納品物としてのCRUD図

システムをお客様に納める場合、実行プログラム、ソースコード、各種仕様書を納めます。
この仕様書の中に、CRUDマトリックスが含まれることがあり、納品直前に慌てて準備したり、メンテ不十分の状態で納めてしまうことも少なくないと思います。
データベースアクセス処理はバグ改修や仕様変更によって頻繁に変更することがありますが、プログラムの改修と合わせて全てのドキュメントを最新状態に維持するのは大変なことです。特に、CRUDマトリックスの最新化は手間暇がかかります。なぜならCRUDマトリックスは単純な明細情報ではなく、ある単位で集計された情報だからです。あるロジックのデータベースアクセス処理を削除したからといって、その部分の修正内容だけではCRUDマトリックスを修正することができず、集計の単位内で見直す必要があります。
そのような問題の解決に役立つのが、CRUD Explorerです。
「CRUD解析」機能は、必要な時にソースコードからCRUDマトリックスを自動的に生成することができます。
データベースアクセス処理が変更になったら、再度CRUD解析を実行するだけです。
CRUD Explorerがあれば、CRUDマトリックスを常に最新状態に維持できるようになるので、いざという時に活用できる資料になります。

CRUDマトリックスの生成方法

事前準備等はCRUD Explorerマニュアルを参照してください。
CRUD Explorerを起動しましょう。

メニューの「CRUD解析」を実行します。

「ソースフォルダ」に、ソースファイルが格納されているフォルダを指定します。
「解析結果フォルダ」に、結果を出力するフォルダを指定します。

通常は、「CRUD解析開始」ボタンをクリックします。
必要に応じてオプションを変更してから「CRUD解析開始」をクリックしてください。オプションについて以下に説明します。
「処理選択」では、実行する処理を選ぶことができます。（通常は「全て」）
実行する処理を選択する場合、「全て」のチェックを外し、必要な処理のみチェックを付けます。
「Step1 動的SQLをの抽出」は、ソースコード中の文字列部分（シングルクォートで囲われた部分）を抽出し、SQLと解釈できる部分をCRUD解析の対象とします。動的SQLの解析は、不完全で解析精度が低いため、必要無い場合はチェックを外しましょう。動的SQLとして抽出された場合、元のファイル名+.dsqlというファイル名で、解析結果フォルダに保存されます。
「Step2 クエリーの抽出」は、ソースファイル中のクエリーを抽出します。解析結果フォルダ直下のソースファイルが処理対象となります。クエリー抽出結果は、解析結果フォルダ\querysフォルダ下に加格納されます。Step1で動的SQLの抽出を行った場合、処理対象となります。
「Step3 CRUDアクセス分析」は、Step2で抽出したクエリーを分析し、CRUD情報を出力します。テーブル単位のCRUD情報は、解析結果フォルダ\querys\CRUD.tsvファイルに、カラム単位のCRUD情報は、CRUDColumns.tsvファイルに出力されます。
「Step4 CRUDマトリクス生成」は、Step3で解析したCRUD情報を元に、CRUDマトリックスを生成します。テーブル単位のCRUDマトリックス情報は、解析結果フォルダ\querys\CRUDMatrix.tsvファイルに、カラム単位のCRUDマトリックス情報は、CRUDColumnsMatrix.tsvファイルに出力されます。