DOMA SQL Navigator
DOMAフレームワークを使用したJavaプロジェクトで、DAOインターフェースのメソッドから対応するSQLファイルを素早く開くためのVSCode拡張機能です。
機能
- JavaのDAOインターフェース上のメソッドから、対応するSQLファイルを開く
- SQLファイルが存在しない場合、新規作成の確認ダイアログを表示
- コンテキストメニューから簡単にアクセス可能
使用方法
- DOMAのDAOインターフェースファイルを開く
- SQLファイルを開きたいメソッド上にカーソルを置く
- 以下のいずれかの方法で実行:
- ショートカットキー:
Ctrl+K Ctrl+D (Mac: Cmd+K Cmd+D)
- コンテキストメニュー: 右クリックして「DOMAのSQLファイルを開く」を選択
- コマンドパレット:
Ctrl+Shift+P (Mac: Cmd+Shift+P) で「DOMAのSQLファイルを開く」を検索
ショートカットキーのカスタマイズ
デフォルトのショートカットキー Ctrl+K Ctrl+D を変更したい場合:
- VSCodeのメニューから「ファイル」→「ユーザー設定」→「キーボード ショートカット」を開く
- 検索ボックスで「DOMA」または「doma-sql-navigator.openSqlFile」を検索
- 既存のショートカットをクリックして、お好みのキーの組み合わせを設定
SQLファイルの配置規則
DOMAの規則に従い、SQLファイルは以下のパスに配置されている必要があります:
META-INF/{パッケージ名のパス}/{DAOクラス名}/{メソッド名}.sql
例
DAOインターフェース:
package aaa.bbb;
public interface EmployeeDao {
Employee selectById(Integer id);
}
対応するSQLファイルのパス:
src/main/resources/META-INF/aaa/bbb/EmployeeDao/selectById.sql
要件
- Visual Studio Code 1.85.0 以降
- Java言語サポート
ライセンス
MIT
更新履歴
0.0.3
- SQLファイル検索ロジックを改善
- binやbuildなどのビルド出力ディレクトリを検索対象から除外
- ソースディレクトリ(src/main/resources)にあるSQLファイルを優先的に開くように変更
- 複数のSQLファイルが見つかった場合の優先順位を実装(src/main/resources → src/test/resources)
0.0.2
- SQLファイルが見つからない場合に、新規作成の確認ダイアログを表示する機能を追加
- 「新規作成」を選択すると、適切なパスにSQLファイルを自動生成
- ショートカットキー
Ctrl+K Ctrl+D (Mac: Cmd+K Cmd+D) を追加
- ユーザーがショートカットキーをカスタマイズ可能
0.0.1
- 初回リリース
- DAOメソッドからSQLファイルを開く基本機能
| |