🗃️

【Spring Boot + Maven】基本ディレクトリ構成例

2022/11/13に公開

概要

  • Spring BootプロジェクトをMavenで構築する際のディレクトリ構成例のメモ
  • Spring Bootで簡易なAPIを作成するだけのプロジェクト
  • MVCでController, Service, Repositoryで構成し、MybatisなどのMapperを使用する想定
  • 設定ファイル配置も記載

Mavenの基本ディレクトリ構成

Maven公式によるディレクトリレイアウトがあり、これをベースにする。
https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

ディレクトリ構成例

プロジェクト名: Sample-Project
ドメイン: example.com

Sample-Project
  |--- README.txt
  |--- pom.xml
  |
  |--- src
  |  |--- main
  |  |  |--- java
  |  |  |  |--- com
  |  |  |     |--- example
  |  |  |       |--- SampleProjectApplication.java
  |  |  |       |--- common
  |  |  |       |  |--- config
  |  |  |       |  |--- enums
  |  |  |       |  |--- exception
  |  |  |       |  |--- CommonConst.java
  |  |  |       |
  |  |  |       |--- controller
  |  |  |       |--- form
  |  |  |       |--- mapper
  |  |  |       |--- repository
  |  |  |       |--- response
  |  |  |       |--- service
  |  |  |       |--- util
  |  |  |
  |  |  |--- resources
  |  |  |  |--- application.yml (application.properties)
  |  |  |  |--- logback.xml
  |  |
  |  |--- test
  |  |  |--- java
  |  |  |  |--- com
  |  |  |     |--- example
  |  |  |       |--- controller
  |  |  |       |--- repository
  |  |  |       |--- service
  |  |  |
  |  |  |--- resources
  |  |
  |  |--- config
  |
  |--- target

Discussion