Jakarta EEプロジェクトのディレクトリ構成を理解しよう！初心者向け完全ガイド

1. Jakarta EEプロジェクトの基本構成を理解しよう

1. Jakarta EEプロジェクトの基本構成を理解しよう

Jakarta EE（旧Java EE）では、Webアプリケーションを構築する際に一定のディレクトリ構成に従うのが一般的です。特にMavenやGradleのようなビルドツールを使う場合は、ディレクトリの場所や名前が重要になります。

ここでは、Jakarta EEの標準的なプロジェクト構造について、初心者でも理解できるように丁寧に説明していきます。

2. Mavenを使ったJakarta EEプロジェクトの構成例

2. Mavenを使ったJakarta EEプロジェクトの構成例

以下は、Mavenを利用してJakarta EEアプリケーションを開発する際の代表的なディレクトリ構成です。

my-jakartaee-app/
├── src/
│   ├── main/
│   │   ├── java/           // Javaソースコード
│   │   ├── resources/      // 設定ファイル（properties, XMLなど）
│   │   └── webapp/         // HTML, JSP, WEB-INFなど
│   └── test/
│       └── java/           // 単体テストコード
├── target/                 // ビルド成果物（自動生成）
├── pom.xml                 // Mavenの設定ファイル

src/main/javaにはServletやFilter、Controllerといったアプリのロジックが入ります。

src/main/webappにはindex.jspやWEB-INF/web.xmlなど、WebアプリのUIや設定ファイルを配置します。

3. 各ディレクトリの役割とJakarta EEとの関係

3. 各ディレクトリの役割とJakarta EEとの関係

それぞれのディレクトリには明確な役割があります。Jakarta EEはServletやJSP、JPA、CDIなど複数の仕様に対応しており、これらを正しい場所に配置することでアプリが正しく動作します。

• java： Jakarta Servlet、EJB、RESTなどのJavaコードを配置
• resources： CDI用のbeans.xmlやロギング設定ファイルを置く
• webapp： HTML、JSP、JavaScript、CSSなどのUI関連リソースを配置
• WEB-INF： web.xmlを置く特殊なディレクトリ。外部からアクセスできない

4. web.xmlとJakarta EEの連携

4. web.xmlとJakarta EEの連携

Jakarta EEのWebアプリでは、WEB-INF/web.xmlがアプリの入り口を定義する重要なファイルです。例えばServletのマッピングや起動時の初期化パラメータを記述します。

<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
         version="5.0">

    <servlet>
        <servlet-name>HelloServlet</servlet-name>
        <servlet-class>com.example.HelloServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>HelloServlet</servlet-name>
        <url-pattern>/hello</url-pattern>
    </servlet-mapping>

</web-app>

このようにServletを登録し、URLパターンを設定することで、ブラウザからのリクエストを処理できます。

5. Gradleの場合の構成はどうなる？

5. Gradleの場合の構成はどうなる？

Jakarta EEプロジェクトをGradleで構築する場合も、基本的な構成はMavenと同じです。ただし、build.gradleを使って依存関係を管理します。

my-jakartaee-app/
├── src/
│   ├── main/
│   │   ├── java/
│   │   ├── resources/
│   │   └── webapp/
│   └── test/
│       └── java/
├── build.gradle

Gradleを使う場合でも、Jakarta EEのライブラリ（Servlet API、JSP APIなど）をdependenciesで指定する必要があります。

6. Jakarta EEとMaven/Gradleの連携ポイント

6. Jakarta EEとMaven/Gradleの連携ポイント

Jakarta EEで開発するには、Servlet APIやJSP APIなどの依存関係をMavenやGradleで明示的に追加する必要があります。

Mavenならpom.xmlに以下のように記述します：

<dependency>
    <groupId>jakarta.platform</groupId>
    <artifactId>jakarta.jakartaee-web-api</artifactId>
    <version>10.0.0</version>
    <scope>provided</scope>
</dependency>

Gradleの場合はbuild.gradleに以下のように記述します：

dependencies {
    providedCompile 'jakarta.platform:jakarta.jakartaee-web-api:10.0.0'
}

これにより、Jakarta EEのAPIにアクセスできるようになり、IDEの補完機能やビルドが正常に行えるようになります。

7. 初心者がつまずきやすいポイントと対策

7. 初心者がつまずきやすいポイントと対策

初心者がJakarta EEのプロジェクト構成でよくつまずくのが以下の点です：

• JavaソースとJSPファイルの配置場所が混在する
• web.xmlが正しく配置されていない
• MavenやGradleで依存関係が通らない

上記のようなトラブルを防ぐためには、テンプレートプロジェクトを使って始めるのが効果的です。また、EclipseやIntelliJ IDEAのJakarta EEサポート機能を使うことで、自動生成される構成を参考にできます。

8. Jakarta EEのディレクトリ構成を覚えるコツ

8. Jakarta EEのディレクトリ構成を覚えるコツ

最後に、構成をしっかり覚えるコツは「役割ごとに整理すること」です。Javaコードはmain/java、画面はwebapp、設定はresourcesというように、決まったルールを守ることがJakarta EEアプリの成功への第一歩です。

将来的にServlet、JSP、CDI、JPAなどの各機能を使うときにも、このディレクトリ構成が基本となるので、今のうちにしっかり理解しておきましょう！

まとめ

まとめ

Jakarta EEプロジェクトのディレクトリ構成は、アプリケーション開発をスムーズに進めるための基礎となる重要なポイントです。特に初心者にとって、src/main/javaやsrc/main/webapp、WEB-INFなどの役割が明確に理解できているかどうかは、ServletやJSP、JPA、CDIといったJakarta EE技術を扱う際の作業効率やトラブル回避に直結します。正しい場所に正しいファイルを配置することは、アプリケーションが正常に動作するための第一条件であり、開発全体の品質にも影響します。

さらに、MavenやGradleといったビルドツールとディレクトリ構造は深く結びついています。設定ファイルであるpom.xmlやbuild.gradleは、Jakarta EEで利用するAPIを適切に参照するために欠かせない存在です。依存関係の追加、WARファイルの生成、リソース管理など、ビルドツールが担う役割を理解しておくことで、アプリケーション全体の構成をより体系的に把握できるようになります。特にJakarta EEのAPIをprovidedとして扱う理由や、web.xmlの配置場所の重要性といった基礎知識は、確実に身につけておきたい内容です。

また、ディレクトリ構成がしっかり理解できていると、ServletをはじめとするWebコンポーネントがどのように読み込まれ、どこでマッピングされ、どのようにリクエスト処理が流れていくのかも自然と理解しやすくなります。WEB-INF配下のセキュリティやアクセス制御の仕組み、JSPファイルがどのようにビルドされるかといった動作も、構成を押さえていれば直感的に把握できます。開発効率を高めるうえで、ディレクトリごとの役割を正確に把握することは非常に重要なのです。

さらに、将来的にJakarta EEの多機能な仕様を扱う際にも、今回学んだ構成が確実に役立ちます。CDIのbeans.xml、JPAの設定ファイル、JAX-RSの構成クラスなど、各種設定を適切な場所に配置することで、Jakarta EEが提供する豊富な機能を正確に利用できます。複雑になりがちな企業システムでも、基礎構造を理解しているだけでトラブルの早期発見や保守性の向上に大きく貢献します。

Jakarta EE開発では、コードを書く前にプロジェクト全体の構造を理解することが非常に大切です。ディレクトリ構成は開発工程全体の土台であり、アプリケーションの品質や開発速度を左右します。今回学んだ標準構成を確実におさえておけば、MavenでもGradleでも迷うことなく安定したWebアプリケーションを構築できるようになるでしょう。

サンプル設定ファイル（補足コード）

<!-- web.xml の基本構成サンプル -->
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
         version="5.0">

    <servlet>
        <servlet-name>SampleServlet</servlet-name>
        <servlet-class>com.example.SampleServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>SampleServlet</servlet-name>
        <url-pattern>/sample</url-pattern>
    </servlet-mapping>

</web-app>

// Gradle で Jakarta EE の依存を追加する例
dependencies {
    providedCompile 'jakarta.platform:jakarta.jakartaee-web-api:10.0.0'
}