Spring Framework 入門

このドキュメントでは、Spring Framework を使用して、簡単な Web MVC アプリケーションを構築する方法を説明します。このアプリケーションでは、ユーザーが自分の名前をテキストフィールドに入力して「OK」をクリックすると、名前が返され、2 ページ目に挨拶メッセージとともにその名前を表示できます。

Spring Framework は普及しているオープンソースアプリケーションフレームワークで、J2EE 開発に役立ちます。このフレームワークはコンテナ、コンポーネント管理フレームワーク、および Web ユーザーインタフェース、トランザクション、持続性のためのスナップインサービスセットから構成されます。Spring Framework の一部は Spring Web MVC です。これは Web アプリケーション作成用の拡張可能な MVC フレームワークです。

IDE には Spring Framework 2.5 のサポートが組み込まれています。フレームワークライブラリは IDE とともにパッケージ化されており、フレームワークを選択するときに、プロジェクトクラスパスに自動的に追加されます。また、Spring Web MVC DispatcherServlet の命名やマッピングなどの構成設定が用意されています。JSTL ライブラリは自動的に登録されます。Spring XML Bean 構成ファイルのサポートも用意されており、これには次の機能が含まれます。

• コードの補完。Spring XML 構成ファイル内の Java クラスや Bean 参照に対して起動します。
• ナビゲーション。Spring Bean 定義に含まれる Java クラスやプロパティーのハイパーリンクや、ほかの Spring Bean 参照へのハイパーリンク。
• リファクタリング。Spring XML 構成ファイル内の Java クラスへの参照の名前の変更。

Spring Framework の詳細については、http://www.springframework.org を参照してください。Spring Framework の成果物の動作方法と、アプリケーション内のほかのオブジェクトとの連携方法に関するさらに詳しい説明については、Spring Framework Reference Documentation または Spring Framework API のページを参照してください。

目次

• Spring Web MVC サポートを使用した新規プロジェクトの設定
  • Spring Web MVC スケルトンプロジェクトの作成
  • スケルトンプロジェクトの実行
• アプリケーションの概要
• サービスの実装
• コントローラとモデルの実装
• ビューの実装
• 関連項目

このチュートリアルに従うには、次のソフトウェアとリソースが必要です。

注:

• Web および Java EE インストール版では、GlassFish V2 アプリケーションサーバーおよび Apache Tomcat サーブレットコンテナ 6.0.x を任意でインストールできます。このチュートリアルの手順を最後まで実行するには、IDE にサーバーを登録してください。
• プロジェクトを、正常に機能するソリューションと比較する必要がある場合は、サンプルアプリケーションをダウンロードできます。

Spring Web MVC サポートを使用した新規プロジェクトの設定

• Spring Web MVC スケルトンプロジェクトの作成
• スケルトンプロジェクトの実行

<welcome-file-list>
    <welcome-file>redirect.jsp</welcome-file>
</welcome-file-list>

<% response.sendRedirect("index.htm"); %>

<servlet>
    <servlet-name>dispatcher</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>2</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
    <url-pattern>*.htm</url-pattern>
</servlet-mapping>

<bean id="urlMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
    <property name="mappings">
        <props>
            <prop key="/index.htm">indexController</prop>
        </props>
    </property>
</bean>

<bean id="viewResolver"
      class="org.springframework.web.servlet.view.InternalResourceViewResolver"
      p:prefix="/WEB-INF/jsp/"
      p:suffix=".jsp" />

<bean name="indexController"
      class="org.springframework.web.servlet.mvc.ParameterizableViewController"
      p:viewName="index" />

アプリケーションの概要

作成するアプリケーションは、Spring Web MVC テクノロジの views で名前が付けられる 2 つの JSP ページから構成されます。最初のビューには、ユーザー名の入力を求める入力フィールドがある HTML フォームが含まれます。2 番目のビューは、ユーザー名を含む挨拶メッセージのみを表示するページです。

これらのビューは、アプリケーションへの要求を受信し、返すビューを判定するコントローラによって管理されます。また、表示する必要がある情報をビューに渡します (モデルと呼ばれる)。このアプリケーションのコントローラは、HelloController と命名されています。

複雑な Web アプリケーションの場合、ビジネスロジックは直接コントローラには格納されません。その代わり、コントローラでビジネスロジックの実行が必要になったときに、service という名前の別のエンティティーがコントローラによって使用されます。このアプリケーションでは、ビジネスロジックは挨拶メッセージの処理であるため、この目的に合わせて HelloService を作成します。

サービスの実装

これまでの手順で、環境を適切に設定できたため、次は必要に合わせてスケルトンプロジェクトを拡張します。HelloService クラスの作成から始めます。

1. 「プロジェクト」ウィンドウでプロジェクトノードを右クリックし、「新規」>「Java クラス」を選択します。
2. 表示される「新規 Java クラス」ウィザードで、「クラス名」に「HelloService」と入力し、「パッケージ名」に「service」と入力してクラスの新規パッケージを作成します。「完了」をクリックします。IDE によって新しいクラスが生成され、ソースエディタで開きます。また、「プロジェクト」ウィンドウは、変更内容を反映して自動的に更新されます。

HelloService クラスで実行されるサービスは、ごく簡単なものです。名前をパラメータとして取得し、その名前を格納する String を処理して返します。ソースエディタで、クラスに次の sayHello() メソッドを作成します (ボールドで表示)。

public class HelloService {

    public String sayHello(String name) {
        return "Hello " + name + "!";
    }
}

コントローラとモデルの実装

SimpleFormController を使用し、ユーザーデータの処理と、どのビューを返すかの判定を行うことができます。

1. Ctrl-N キーを押して「新規ファイル」ウィザードを開きます。「カテゴリ」の「Spring Framework」を選択し、「ファイルの種類」の「単純フォームコントローラ」を選択します。「次へ」をクリックします。
2. クラスに「HelloController」という名前を付け、「パッケージ」テキストフィールドに「controller」と入力してクラスの新規パッケージを作成します。「完了」をクリックします。IDE によって新しいクラスが生成され、ソースエディタで開きます。
3. クラステンプレートのデフォルトで表示する取得メソッドのコメントを解除し、コントローラプロパティーを指定します。次のように変更を加えます (ボールドの変更)。

   public HelloController() {
       setCommandClass(Name.class);
       setCommandName("name");
       setSuccessView("helloView");
       setFormView("nameView");
   }

   FormView を設定することによって、フォームの表示に使用されるビュー名を設定できます。これは、ユーザーが自分の名前を入力できるテキストフィールドがあるページです。同様に、SuccessView を設定することによって、送信の成功時に表示されるべきビュー名を設定できます。CommandName の設定時、モデル内でコマンド名を定義します。この場合、このコマンドは、バインドされる要求パラメータを持つフォームオブジェクトです。CommandClass を設定することで、コマンドクラス名を設定できます。このクラスのインスタンスは、各要求と同時に生成および検証されます。
   
   エラーのフラグが setCommandClass() メソッド内の Name に表示されます。
   
   各要求の情報を保持するための簡単な Bean として、Name クラスを作成する必要があります。
4. 「プロジェクト」ウィンドウでプロジェクトノードを右クリックし、「新規」>「Java クラス」を選択します。「新規 Java クラス」ウィザードが表示されます。「クラス名」に「Name」と入力し、「パッケージ」のドロップダウンリストから「controller」を選択します。「完了」をクリックします。Name クラスが作成され、ソースエディタで開きます。
5. Name クラスに対し、value という名前のフィールドを作成し、次にこのフィールドのアクセス用メソッドを作成します。次のように入力します (ボールドの変更)。

   public class Name {
   
       private String value;

   IDE でアクセス用メソッドが作成されます。ソースエディタで「value」を右クリックし、「リファクタリング」>「フィールドをカプセル化」を選択します。「フィールドをカプセル化」ダイアログが表示されます。
   
   getValue() メソッドおよび setValue() メソッドは、可視性が public で作成されます。「リファクタリング」をクリックします。2 つのメソッドが Name クラスに追加されます。

   public String getValue() {
       return value;
   }
   
   public void setValue(String value) {
       this.value = value;
   }

6. ソースエディタで HelloController をクリックしてこのファイルに戻ると、Name クラスを作成したことで、前に表示されていたエラーバッジが消えたことがわかります。doSubmitAction() メソッドを削除し、onSubmit() メソッドのコメントを解除します。onSubmit() メソッドを使用し、ここで必要な独自の ModelAndView を作成できます。次の変更を加えます。

   @Override
   protected ModelAndView onSubmit(Object command) throws Exception {
       Name name = (Name)command;
       ModelAndView mv = new ModelAndView(getSuccessView());
       mv.addObject("helloMessage", helloService.sayHello(name.getValue()));
       return mv;
   }

   上記に示すとおり、command は Name オブジェクトにキャストされます。ModelAndView のインスタンスが作成され、成功ビューが SimpleFormController の取得メソッドを使用して取得されます。最後に、モデルにデータが取り込まれます。このモデル内の唯一の項目は、以前の手順で作成した HelloService から取得された挨拶メッセージです。addObject メソッドを使用し、helloMessage という名前のモデルに挨拶メッセージを追加します。
7. ソースエディタ内を右クリックし、「インポートを修正」(Ctrl-Shift-I) を選択してインポートエラーを修正します。次のインポート文がファイルの最初に追加されます。

   import org.springframework.web.servlet.ModelAndView;

   エラーがすべて修正されないのは、このクラスでまだ HelloService クラスが特定されず、sayHello メソッドが使用できないためです。
8. HelloController 内で HelloService という名前の private フィールドを宣言します。

   private HelloService helloService;

   次に、このフィールドの public 取得メソッドを作成します。

   public void setHelloService(HelloService helloService) {
       this.helloService = helloService;
   }

   最後に、ソースエディタ内を再度右クリックし、「インポートを修正」を選択します。次の文がファイルの最初に追加されます。

   import service.HelloService;

   今度はすべてのエラーが修正されるはずです。
9. HelloService を applicationContext.xml に登録します。applicationContext.xml をソースエディタで開き、次の Bean 宣言を入力します。

   <bean name="helloService" class="service.HelloService" />

10. HelloController を dispatcher-servlet.xml に登録します。dispatcher-servlet.xml をソースエディタで開き、次の Bean 宣言を入力します。

    <bean class="controller.HelloController" p:helloService-ref="helloService"/>

    
    IDE 内の Spring サポートには、Bean 参照と同様に、Java クラスでも XML 構成ファイル内でコード補完する機能が含まれます。コード補完を実行するには、ソースエディタ内の操作の実行時に Ctrl- スペースキーを押します。
    

ビューの実装

このプロジェクトのビューを実装するには、2 つの JSP クラスを作成する必要があります。最初のページは nameView.jsp で、開始ページとして機能し、ユーザーはここに名前を入力できます。もう 1 つのページは helloView.jsp で、入力された名前を含む挨拶メッセージがここに表示されます。

1. 「プロジェクト」ウィンドウで「WEB-INF」>「jsp」ノードを右クリックし、「新規」>「JSP」を選択します。「新規 JSP ファイル」ウィザードが開きます。ファイルに「helloView」という名前を付けます。「完了」をクリックします。新規 JSP ファイルが jsp フォルダに作成され、ソースエディタに表示されます。
2. ソースエディタで、ファイルの title を「Hello」に変更し、HelloController で作成される ModelandView オブジェクトの helloMessage を取得するよう、出力メッセージを 変更します。

   <head>
       <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
       <title>Hello</title>
   </head>
   <body>
       <h2>${helloMessage}</h2>
   </body>
   

3. もう 1 つの JSP ファイルを上記と同じ方法で作成し、名前は「nameView」とします。
4. ソースエディタで、次のタグライブラリ宣言を nameView.JSP に追加します。

   <%@taglib uri="http://www.springframework.org/tags" prefix="spring" %>

   これにより、Spring タグライブラリ がインポートされます。このライブラリには、ビューを JSP ページとして実装する際に役立つタグが格納されます。
5. 「Enter your name」の入力を読み取るよう、<title> タグと <h2> タグの内容を変更します。
6. h2 タグの下に次のコードを入力します。

   <spring:nestedPath path="name">
       <form action="" method="post">
           Name:
           <spring:bind path="value">
               <input type="text" name="${status.expression}" value="${status.value}">
           </spring:bind>
           <input type="submit" value="OK">
       </form>
   </spring:nestedPath>
   

   spring:bind を使用することで、Bean プロパティーをバインドできます。bind タグによってバインド状態と値が提供され、これが入力フィールドの名前および値として使用されます。この方法で、フォームの送信時、送信された値の抽出方法が Spring で識別されます。ここで、コマンドクラス (controller.Name) に value プロパティーが追加されるため、「path」を「value」に設定します。
   
   spring:nestedPath を使用することで、指定したパスを Bean の前に付加できます。そのため、上記のように spring:bind と一緒に使用すると、Bean へのパスは name.value になります。再呼び出し時、HelloController コマンドの名前は name になります。そのため、ページ範囲内の name という名前の Bean の value プロパティーがこのパスから参照されます。
7. アプリケーションの相対エントリポイントを変更します。現在、プロジェクトのエントリポイントはまだ index.htm であり、前述の「スケルトンプロジェクトの実行」にあるとおり、このページから WEB-INF/jsp/index.jsp にリダイレクトされます。プロジェクトの配備および実行時のエントリポイントを指定できます。「プロジェクト」ウィンドウでプロジェクトノードを右クリックし、「プロパティー」を選択します。「プロジェクトプロパティー」ダイアログが表示されます。「カテゴリ」で「実行」を選択します。「相対 URL」フィールドに「/hello.htm」と入力し、「了解」をクリックします。
   
   この時点では、hello.htm から HelloController へのマッピングがどこにあるか疑問に感じるかもしれません。urlMapping Bean へのマッピングは、スケルトンプロジェクトの開始ページである index.htm の場合と同様に、まだ追加していません。この処理は、次のように Bean を dispatcher-servlet.xml に定義することで実現できる Spring の機能を使えば可能になります。

   <bean class="org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping"/>
   

   この Bean には、このファイルに登録されたすべてのコントローラに対して URL マッピングを自動的に作成する役割があります。コントローラ (このチュートリアルでは controller.HelloController) の完全修飾クラス名が取得され、パッケージ名と Controller 接尾辞が取り除かれて、その結果が URL マッピングに使用されます。そのため、HelloController の場合は hello.htm というマッピングが作成されます。しかしこの機能は、ParameterizableViewController のような Spring Framework に含まれるコントローラには機能しません。これらには、明示的なマッピングが必要になります。
8. 「プロジェクト」ウィンドウでプロジェクトノードを右クリックし、「実行」(F6) を選択します。これにより、プロジェクトがコンパイル、配備、および実行されます。デフォルトブラウザが開き、hello.htm がプロジェクトの nameView として表示されるはずです。
   
   テキストフィールドに名前を入力し、「OK」をクリックします。helloView が次のように挨拶メッセージと一緒に表示されます。
   

関連項目

これで、NetBeans IDE での Spring Framework 入門は終わりです。このドキュメントでは、Spring Framework を使用して NetBeans IDE で簡単な Web MVC アプリケーションを構築する方法をデモし、Web アプリケーション開発用の IDE インタフェースを紹介しました。

「NetBeans および GlassFish による Spring Framework MVC アプリケーションの手順を追った開発」などのほかの NetBeans IDE チュートリアル全般を実行し、Spring Framework の学習を続けることをお勧めします。これは Thomas Risberg による公式な Spring Framework チュートリアルであり、Arulazi Dhesiaseelan によって NetBeans IDE のために改定されました。

Spring NetBeans モジュール機能の多くは、Web ベース以外の Spring Framework アプリケーションにも適用できます。

その他の関連チュートリアルについては、次のリソースを参照してください。

• Spring Framework ハンズオンラボ。NetBeans IDE で Spring Framework を使用する包括的講義と実習シリーズです。
• Web フレームワークのためのサポートの追加。NetBeans アップデートセンターを使用して Web フレームワークのプラグインをインストールすることによるサポート追加方法を説明した基本ガイドです。
• Web アプリケーションの NetBeans IDE 6.0 チュートリアル。この詳細チュートリアルでは、複合ビュー、フロントコントローラ、JSP ページ、およびサーブレットを使用して Web アプリケーション全体を構築する方法を説明します。
• JAX-WS Web サービス入門。このドキュメントでは、NetBeans IDE で Web アプリケーション向けの JAX-WS Web サービスの開発を始める方法を説明します。