開発環境の準備

本記事では、Eclipse Oxygenをベースに、Mavenを利用してSpring MVCの基本的なWebアプリケーションを構築する手順について解説します。プロジェクトの作成から、依存関係の設定、ディスパッチャーサーブレットの構成、そしてコントローラーの実装までを網羅します。

Mavenプロジェクトの作成と設定

まず、Eclipseから「Maven Project」を作成します。アーキタイプとして maven-archetype-webapp を選択し、プロジェクトの骨格を生成します。生成されたディレクトリ構造を確認し、必要に応じてJavaソースフォルダ（src/main/java）などの不足ディレクトリを追加してください。

依存関係の定義 (pom.xml)

次に、pom.xml を編集し、Spring MVCの動作に必要なライブラリを追加します。ここでは、Spring FrameworkのWebモジュール、サーブレットAPI、およびテスト用ライブラリを定義します。バージョン番号やグループIDは環境に合わせて適宜変更してください。

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example.demo</groupId>
    <artifactId>spring-mvc-app</artifactId>
    <version>1.0.0</version>
    <packaging>war</packaging>

    <dependencies>
        <!-- Spring Web MVC -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>3.0.5.RELEASE</version>
        </dependency>
        
        <!-- Servlet API (Provided scope) -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>

        <!-- JUnit for testing -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>spring-mvc-app</finalName>
    </build>
</project>

Webアプリケーション設定 (web.xml)

web.xml にて、Spring MVCのエントリポイントである DispatcherServlet を登録します。同時に、ルートアプリケーションコンテキストをロードするための ContextLoaderListener も設定します。これにより、アプリケーション起動時にSpringコンテナが初期化されます。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
    version="2.4">

    <!-- Root Application Context -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/root-context.xml</param-value>
    </context-param>
    
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <!-- DispatcherServlet -->
    <servlet>
        <servlet-name>app</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>app</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

Spring設定ファイルの作成

ContextLoaderListener が参照するルートコンテキスト設定 (root-context.xml) と、DispatcherServlet が参照するサーブレットコンテキスト設定 (app-servlet.xml) を作成します。

ルートコンテキスト (root-context.xml)

このプロジェクトでは主にサーブレットコンテキストでの設定を行うため、ルートコンテキストは空で構いませんが、ファイルの存在が必要です。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans">
    
</beans>

サーブレットコンテキスト (app-servlet.xml)

こちらのファイルでSpring MVC固有の設定を行います。アノテーション駆動開発を有効化し、コントローラーのパッケージスキャン、およびビューリゾルバの設定を定義します。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-3.0.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

    <!-- Enables MVC annotations like @RequestMapping -->
    <mvc:annotation-driven />

    <!-- Scans for controllers within the specified package -->
    <context:component-scan base-package="com.example.demo.controller" />

    <!-- View Resolver configuration -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/views/" />
        <property name="suffix" value=".jsp" />
    </bean>
</beans>

コントローラーの実装

リクエストを処理するコントローラークラスを作成します。@Controller アノテーションを付与し、@RequestMapping でURLマッピングを定義します。ここでは、ルートURL（/）へのアクセス時にビューとメッセージデータを返すメソッドを実装します。

package com.example.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class HomeController {

    @RequestMapping(value = {"/", "/home"})
    public String displayHomePage(Model model) {
        // Adding data to the model
        model.addAttribute("greeting", "Spring MVCへのようこそ！");
        // Returning the logical view name
        return "welcome";
    }
}

ビュー (JSP) の作成

最後に、コントローラーから返されたビュー名に対応するJSPファイルを作成します。app-servlet.xml で設定したプレフィックスに従い、/WEB-INF/views/ ディレクトリ内に配置します。

配置場所: src/main/webapp/WEB-INF/views/welcome.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Spring MVC Demo</title>
</head>
<body>
    <h1>${greeting}</h1>
</body>
</html>

以上で設定は完了です。サーバー（Tomcatなど）にデプロイし、ブラウザからアプリケーションのルートURLにアクセスすると、JSPに設定されたメッセージが表示されます。