対象ファイル
-
docs/01_Project_Map.md(プロジェクト構成およびディレクトリマップ)
はじめに
今回は boot_two_sale プロジェクトの全体的なディレクトリ構造、パッケージレイアウト、および各構成要素の役割を定義した「プロジェクト構成マップ」を整理した。
Spring Boot、MyBatis、Oracle DB を連携させた商品・販売管理関連の Web アプリケーションにおいて、コントローラーから永続化層(DAO/Mapper)、データベースに至るまでのデータ処理フローと体系的なドキュメント管理構造の全体像を確認してみた。
概要と基本情報
-
プロジェクト名:
boot_two_sale - 目的: Spring Boot、MyBatis、Oracle DB を連携させた商品・販売管理 Web アプリケーションの構築および動作検証
-
主要検証範囲: Controller ~ DAO/Mapper ~ DB に至るデータ処理フローの確立と、
docs/配下での体系的なドキュメント管理
プロジェクト構成(Project Directory Tree)
boot_two_sale
├── src/main/java
│ └── co.kr.sale
│ ├── BootTwoSaleApplication.java
│ ├── ProductController.java
│ ├── TestController.java
│ ├── dto/
│ │ └── ProductDto.java
│ └── mapper/
│ └── ProductDaoMapper.java
├── src/main/resources
│ ├── static/
│ ├── templates/
│ └── application.properties
├── src/test/java
│ └── co.kr.sale
│ └── BootTwoSaleApplicationTests.java
├── docs/
│ ├── 00_Developer_Terms.md
│ └── 01_Project_Map.md
├── gradle/
│ └── wrapper/
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── build.gradle
├── settings.gradle
├── gradlew
└── gradlew.bat
詳細構成要素および役割の詳細
| 階層・ディレクトリ | 主要ファイル / パッケージ | 役割および説明 |
|---|---|---|
Java Root (src/main/java/co.kr.sale) |
BootTwoSaleApplication.java |
Spring Boot アプリケーションのメイン実行クラス(エントリーポイント) |
| Controller Layer |
ProductController.javaTestController.java
|
商品関連の HTTP リクエスト制御、動作確認およびルーティング検証 |
DTO Package (co.kr.sale.dto) |
ProductDto.java |
各層間で商品情報を保持して安全に伝送するデータ転送オブジェクト |
Mapper Layer (co.kr.sale.mapper) |
ProductDaoMapper.java |
MyBatis マッパーインターフェースによるデータベースアクセス層の制御 |
Resources (src/main/resources) |
application.properties 他 |
データベース接続情報、サーバーポートなどの環境設定およびリソース管理 |
Test (src/test/java) |
BootTwoSaleApplicationTests.java |
Spring Context の正常読み込みおよび統合テストを行う JUnit テストクラス |
Documents (docs/) |
00_Developer_Terms.md01_Project_Map.md
|
開発用語ノートやプロジェクト構成図などの設計・分析ドキュメント管理領域 |
技術的評価および改善ポイント
1. 体系的なディレクトリ構造と保守性
パッケージが co.kr.sale をルートとして dto や mapper に綺麗に分離されており、レイヤードアーキテクチャの原則に沿った見通しの良い構造になっている。
2. ドキュメント駆動による学習記録
docs/ ディレクトリ内にプロジェクトマップや用語集を配置することで、プロジェクトの変遷や学習内容を継続的かつ体系的に蓄積・管理できる仕組みが構築されている。
構成要素のまとめ
| 区分 | 主な要素 | 役割 |
|---|---|---|
| Entry Point | BootTwoSaleApplication |
アプリケーションの起動とコンテキスト初期化 |
| Web & Control |
ProductController, TestController
|
リクエストの受付とルーティング・画面遷移の制御 |
| Persistence |
ProductDaoMapper, ProductDto
|
MyBatis による DB 連携とデータオブジェクトの保持 |
| Management |
docs/, application.properties
|
設定管理および開発ドキュメントの体系化 |
今回学んだこと
-
boot_two_saleプロジェクト全体のディレクトリ構造と、各レイヤー(Controller、DTO、Mapper)の配置規則を再確認できた - プロジェクト全体の見通しを良くするパッケージング設計の重要性と、ドキュメント管理の意義を把握できた
- 次のファイル分析へと進んでいきたい。