【SpringMVC】設定ファイルその3

  • pom.xml
    mavenのプロジェクト定義ファイルで
    ビルドする際に依存する外部jarファイルの設定やJDKのバージョンを定義します。

    • 基本設定

      <?xml version="1.0" encoding="UTF-8"?>
      <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/maven-v4_0_0.xsd">
        <!-- モデルバージョン -->
        <modelVersion>4.0.0</modelVersion>
        <!-- パッケージ名 -->
        <groupId>jp.co</groupId>
        <!-- コンテキスト名 -->
        <artifactId>sample</artifactId>
        <!-- プロジェクト名 -->
        <name>Sample</name>
        <!-- 展開用拡張子 -->
        <packaging>war</packaging>
        <!-- バージョン -->
        <version>1.0.0-BUILD-SNAPSHOT</version>
        <!-- バージョン情報外だし -->
        <properties>
          <java-version>1.6</java-version>
          <org.springframework-version>3.1.1.RELEASE</org.springframework-version>
          <org.aspectj-version>1.6.10</org.aspectj-version>
          <org.slf4j-version>1.6.6</org.slf4j-version>
        </properties>
        <!-- 各種設定 -->
        <dependencies>後述の各種設定をタグ内に記載</dependencies>
        <!-- ビルド -->
        <build>省略</build>
      </project>
      

    「dependencies」タグの中に下記内容を記載していきます。

    • Web開発に必要なライブラリー

      <!-- Servlet -->
      <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <version>2.5</version>
        <scope>provided</scope>
      </dependency>
      <dependency>
        <groupId>javax.servlet.jsp</groupId>
        <artifactId>jsp-api</artifactId>
        <version>2.1</version>
        <scope>provided</scope>
      </dependency>
      
      <!-- Tag Library -->
      <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>jstl</artifactId>
        <version>1.2</version>
      </dependency>
      
      <!-- Logging -->
      <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>${org.slf4j-version}</version>
      </dependency>
      <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>jcl-over-slf4j</artifactId>
        <version>${org.slf4j-version}</version>
        <scope>runtime</scope>
      </dependency>
      <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>${org.slf4j-version}</version>
        <scope>runtime</scope>
      </dependency>
      <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.15</version>
        <exclusions>
          <exclusion>
            <groupId>javax.mail</groupId>
            <artifactId>mail</artifactId>
          </exclusion>
          <exclusion>
            <groupId>javax.jms</groupId>
            <artifactId>jms</artifactId>
          </exclusion>
          <exclusion>
            <groupId>com.sun.jdmk</groupId>
            <artifactId>jmxtools</artifactId>
          </exclusion>
          <exclusion>
            <groupId>com.sun.jmx</groupId>
            <artifactId>jmxri</artifactId>
          </exclusion>
        </exclusions>
        <scope>runtime</scope>
      </dependency>
      
    • SpringFrameWorkのライブラリー

      <!-- Spring -->
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${org.springframework-version}</version>
        <exclusions>
          <!-- Exclude Commons Logging in favor of SLF4j -->
          <exclusion>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
           </exclusion>
        </exclusions>
      </dependency>
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${org.springframework-version}</version>
      </dependency>
      <!-- AOP関連(AspectJ) -->
      <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjrt</artifactId>
        <version>${org.aspectj-version}</version>
      </dependency>
      <!-- AOP関連(cglib) -->
      <dependency>
        <groupId>cglib</groupId>
        <artifactId>cglib</artifactId>
        <version>2.2.2</version>
      </dependency>
      

【SpringMVC】設定ファイルその2

  • src/main/webapp/WEB-INF/spring/root-context.xml
    アプリケーションの共通設定として、
    ファンクション層(F層:Service)、データ層(D層:Dao)の定義を行う。

    • 「@Autowire」「@Component」「@Service」のアノテーションを有効にする設定

      <context:annotation-config />
      
    • アノテーションでScan対象とするパッケージを指定

      <context:component-scan base-package="jp.co.sample.service" />
      <context:component-scan base-package="jp.co.sample.dao" />
      

      上記パッケージにJavaファイルを配置すると、
      JavaファイルにSpringの管理を示す「S」マークがつきます。

      このファイルは共通設定なので、パッケージにcontrollerが
      格納されている場所を指定すれば「@Controller」も利用可能ですが、
      SpringMVCの考え方として、通常は「@Controller」が属するパッケージは
      後述のservlet-context.xmlに定義します。

    • 共通設定

      <beans:bean id="commonProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
        <beans:property name="locations" value="classpath:common.properties" />
      </beans:bean>
      

      上記記述を行うことでJavaファイル内でcommon.propertiesに
      「commonProperties」という名前でアクセスできるようになります。

      @Autowired
      private Properties commonProperties;
      
  • src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml
    プレゼンテーション層(P層:Controller)の定義を行う

    • 「@Controller」のアノテーションを有効にする設定

      <annotation-driven />
      
    • アノテーションでScan対象とするパッケージを指定

      <context:component-scan base-package="jp.co.sample.controller" />
      

      上記パッケージにJavaファイルを配置すると、
      JavaファイルにSpringの管理を示す「S」マークがつきます。

    • 静的ファイルにHTTP GETリクエストが来た場合の動作定義

      <resources mapping="/resources/**" location="/resources/" />
      
    • コントローラーの処理終了後に呼び出される画面用ファイルの指定

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

【SpringMVC】設定ファイルその1

  • src/main/webapp/WEB-INF/web.xml

    Springの共通Bean設定ファイルの定義
    アプリケーションの共通設定を行う。
    root-context.xmlではファンクション層(F層:Service)、データ層(D層:Dao)の定義を行う。

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

    SpringMVCのBean設定ファイルの定義
    リクエストとサーブレットクラスのマッピングを行う。
    servlet-context.xmlではプレゼンテーション層(P層:Controller)の定義を行う。

    <servlet>
      <servlet-name>appServlet</servlet-name>
      <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
      <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/spring/appServlet/servlet-context.xml</param-value>
      </init-param>
      <load-on-startup>1</load-on-startup>
    </servlet>
    
    <servlet-mapping>
      <servlet-name>appServlet</servlet-name>
      <url-pattern>/</url-pattern>
    </servlet-mapping>
    

    Spring MVCではリクエストはすべて「DispatcherServlet.java」が受け取り、
    どのコントローラーを利用するかは「HandlerMapping.java」に委譲している。
    マッピングする際に設定値として、「servlet-context.xml」が指定されている。

【SpringMVC】プロジェクト作成

  • Spring MVCプロジェクト作成

    「ファイル」-「新規」-「Spring」-「Springプロジェクト」を選択します。

    テンプレートは「Spring MVC Project」を選択します。
    ここで最初はテンプレートが見つからなかったので、インストールした覚えがあります。
    (後で別マシンで検証)

    インストール場所は自動で下記に配置されました。
    「C:\Users\ユーザ名\.m2」

    パッケージ名は最低3階層まで作成しないとエラーになります。
    例:「jp.co.sample」

    作成後のパッケージ構成は下記の通り。

    src/main/java:コントローラーJava配置用
    src/main/resources:Spring用設定ファイル配置用(log4.xmlあり)
    src/test/java:JUnit実施用
    src/test/resources:JUnit実施用
    src/main/webapp/WEB-INF/views:JSP配置用
    src/main/webapp/WEB-INF/classes:プロパティファイル配置用
    
  • JREシステムライブラリー変更
    Eclipseの設定によってはJREシステムライブラリーが1.6になっているので、
    プロジェクトを右クリックして「Javaのビルド・パス」で
    JREシステムライブラリー1.6を除去して、
    JREシステムライブラリー1.7を追加します。

【SpringMVC】導入

  • Spring MVC導入

    普段は軽さ重視で「Eclipse 3.7 Indigo」を利用しているのですが、
    プラグインの追加で「Eclipse 3.7 Indigo」用の
    「Spring Tool Suite」を選択しても
    プロジェクト・エクスプローラーの表示がバグったりしたので、
    「Eclipse 4.3 Kepler」を利用することにしました。

    「Eclipse 4.3 Kepler」を立ち上げたら
    「ヘルプ」-「Eclipse マーケットプレース」を選択。
    「検索」タブで「STS」を入力し、
    「Eclipse 4.3 Kepler」用の「Spring Tool Suite」を選択してインストールします。

    「Spring UAA Integration」はチェックを外してインストールしました。
    規約に同意してEclipseを再起動すれば導入完了です。