| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="An introduction to using the Spring Framework |
| in NetBeans IDE"> |
| <meta name="keywords" content="NetBeans, IDE, integrated development environment, |
| Spring framework, frameworks, MVC, Model View Controller, web application"> |
| |
| <link rel="stylesheet" type="text/css" href="../../../netbeans.css"> |
| |
| <title>Spring Web MVC入門 - NetBeans IDEチュートリアル</title> |
| </head> |
| |
| <body> |
| |
| <!-- |
| Copyright (c) 2009, 2010, 2011, Oracle and/or its affiliates. All rights reserved. |
| --> |
| |
| <h1>Spring Web MVC入門</h1> |
| |
| <p>このドキュメントでは、<a href="http://www.springframework.org/">Spring Framework</a>を使用して、単純なWeb <a href="http://www.oracle.com/technetwork/articles/javase/index-142890.html">MVC</a>アプリケーションを構築する方法を説明します。このアプリケーションでは、ユーザーが自分の名前をテキスト・フィールドに入力して「OK」をクリックすると、名前が返され、2ページ目に挨拶メッセージとともにその名前を表示できます。</p> |
| |
| <p>Spring Frameworkはポピュラなオープン・ソース・アプリケーション・フレームワークで、Java EE開発に役立ちます。このフレームワークはコンテナ、コンポーネント管理フレームワーク、およびWebユーザー・インタフェース、トランザクション、持続性のためのスナップイン・サービス・セットから構成されます。Spring Frameworkの一部はSpring Web MVCです。これはWebアプリケーション作成用の拡張可能なMVCフレームワークです。</p> |
| |
| <p>IDEには、Spring Framework 4.xおよび3.xに対するサポートが組み込まれています。フレームワーク・ライブラリはIDEにパッケージ化されており、フレームワークが選択されると、プロジェクト・クラスパスに自動的に追加されます。また、Spring Web MVC<code>DispatcherServlet</code>の命名やマッピングなどの構成設定が用意されています。JSTLライブラリは、プロジェクト作成時にオプションで登録できます。Spring XML Bean構成ファイルのサポートも用意されており、これには次の機能が含まれます。</p> |
| |
| <ul> |
| <li><strong>コードの補完</strong>。Spring XML構成ファイル内のJavaクラスやBean参照に対して起動される。</li> |
| |
| <li><strong>ナビゲーション</strong>。Spring Bean定義に含まれるJavaクラスやプロパティのハイパーリンクや、他のSpring Bean参照へのハイパーリンク。</li> |
| |
| <li><strong>リファクタリング</strong>。Spring XML構成ファイル内のJavaクラスへの参照の名前の変更。</li> |
| </ul> |
| |
| <p>Spring Frameworkの詳細は、<a href="http://www.springsource.org/">http://www.springsource.org/</a>を参照してください。Spring Frameworkアーティファクトの動作方法と、アプリケーション内の他のオブジェクトとの連携方法に関するさらに詳しい説明は、<a href="http://static.springsource.org/spring/docs/3.1.x/spring-framework-reference/html/">Spring Frameworkリファレンス・ドキュメント</a>または<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/">Spring Framework APIドキュメント</a>を参照してください。</p> |
| |
| <p><strong>目次</strong></p> |
| |
| <img alt="このページの内容は、NetBeans IDE 7.2、7.3、7.4および8.0に適用されます" class="stamp" src="../../../images_www/articles/73/netbeans-stamp-80-74-73.png" title="このページの内容は、NetBeans IDE 7.2、7.3、7.4および8.0に適用されます"> |
| |
| <ul class="toc"> |
| <li><a href="#setting">Spring Web MVCサポートを使用した新規プロジェクトの設定</a> |
| |
| <ul> |
| <li><a href="#creating">Spring Web MVCスケルトン・プロジェクトの作成</a></li> |
| <li><a href="#running">スケルトン・プロジェクトの実行</a></li> |
| </ul></li> |
| |
| <li><a href="#overview">アプリケーションの概要</a></li> |
| <li><a href="#service">サービスの実装</a></li> |
| <li><a href="#controller">コントローラとモデルの実装</a></li> |
| <li><a href="#view">ビューの実装</a></li> |
| <li><a href="#seeAlso">関連項目</a></li> |
| </ul> |
| |
| <p><strong>このチュートリアルを完了するには、次のソフトウェアとリソースが必要です。</strong></p> |
| |
| <table> |
| <tbody> |
| <tr> |
| <th class="tblheader" scope="col">ソフトウェアまたはリソース</th> |
| <th class="tblheader" scope="col">必須バージョン</th> |
| </tr> |
| <tr> |
| <td class="tbltd1"><a href="https://netbeans.org/downloads/index.html">NetBeans IDE</a></td> |
| <td class="tbltd1">7.2、7.3、7.4、8.0、Java EE</td> |
| </tr> |
| <tr> |
| <td class="tbltd1"><a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java Development Kit (JDK)</a></td> |
| <td class="tbltd1">バージョン7または8</td> |
| </tr> |
| <tr> |
| <td class="tbltd1"><a href="http://glassfish.dev.java.net/public/downloadsindex.html">GlassFishサーバー</a></td> |
| <td class="tbltd1">3.x、4.x</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <p><strong class="notes">注意: </strong></p> |
| |
| <ul> |
| <li>IDEのJavaインストール版では、IDEとともにGlassFishサーバーをインストールして登録することもできます。</li> |
| <li>プロジェクトを、正常に機能するソリューションと比較する必要がある場合は、<a href="https://netbeans.org/projects/samples/downloads/download/Samples%252FJava%2520Web%252FHelloSpring69.zip">サンプル・アプリケーションをダウンロード</a>できます。</li> |
| </ul> |
| |
| |
| <h2 id="setting">Spring Web MVCサポートを使用した新規プロジェクトの設定</h2> |
| |
| <ul> |
| <li><a href="#creating">Spring Web MVCスケルトン・プロジェクトの作成</a></li> |
| <li><a href="#running">スケルトン・プロジェクトの実行</a></li> |
| </ul> |
| |
| <div class="indent"> |
| |
| <h3 id="creating">Spring Web MVCスケルトン・プロジェクトの作成</h3> |
| |
| <p>Spring Frameworkを使用し、Webアプリケーションの新規プロジェクトを次のように作成します。</p> |
| |
| <ol> |
| <li>IDEの「ファイル」メニューから「新規プロジェクト」([Ctrl]-[Shift]-[N]、Macの場合は[⌘]-[Shift]-[N])を選択します。「Java Web」カテゴリを選択し、「プロジェクト」で「Webアプリケーション」を選択します。「次」をクリックします。</li> |
| |
| <li>「プロジェクト名」に「<strong>HelloSpring</strong>」と入力します。「次」をクリックします。</li> |
| |
| <li>このチュートリアルでは<a href="http://jcp.org/en/jsr/detail?id=299">JSR-299</a>仕様を使用しないため、ステップ3の「サーバーと設定」の「コンテキストと依存性の注入を有効にする」オプションは無効にします。</li> |
| |
| <li>「サーバー」ドロップダウン・リストで「GlassFish Server」が選択されていることを確認します。「次」をクリックします。 |
| <p>Java EEのバージョンは、選択したサーバーのバージョンによって異なります。選択したサーバーがGlassFish Server 4.0の場合、デフォルトJava EEバージョンはJava EE 7 Webです。 |
| </p></li> |
| |
| <li>ステップ4の「フレームワーク」パネルで、「Spring Web MVC」を選択します。</li> |
| <li>「Springライブラリ」ドロップダウン・リストで<strong>「Spring Framework 3.x」</strong>を選択します。<br> <img alt="「フレームワーク」パネルに表示された「Spring Web MVC」" class="margin-around b-all" src="../../../images_www/articles/80/web/spring/frameworks-window.png" title="「フレームワーク」パネルに表示された「Spring Web MVC」"> |
| |
| <p class="alert"> |
| IDEではSpring 4.xライブラリをプロジェクトに追加できますが、このチュートリアルではSpring 4.xでサポートされていないSimpleFormControllerを使用します。また、Spring Web MVCを選択すると、デフォルトでプロジェクト作成時にJSTL (JavaServer Pages Standard Tag Library)ライブラリがクラスパスに追加されます。このチュートリアルではJSTLは必要ないため、このオプションの選択を解除します(上のスクリーンショットを参照)。 </p></li> |
| |
| <li>「構成」タブをクリックすると、このウィザードでSpring Dispatcherサーブレットの名前とマッピングを指定できます。<br> <img alt="Springの構成オプション" class="margin-around b-all" src="../../../images_www/articles/72/web/spring/spring-configuration.png" title="「構成」タブでのSpring Dispatcherサーブレットの名前とマッピングの指定"></li> |
| |
| <li>「終了」をクリックします。IDEでアプリケーション全体のプロジェクトが作成されます。このプロジェクトには、すべてのメタデータに加え、「ファイル」ウィンドウ([Ctrl]-[2]、Macの場合は[⌘]-[2])から検査できる、プロジェクトのAntビルド・スクリプトが含まれます。テンプレート構造は「プロジェクト」ウィンドウ([Ctrl]-[1]、Macの場合は[⌘]-[1])から表示できます。また、IDEのエディタで<code>dispatcher-servlet.xml</code>、<code>applicationContext.xml</code>、<code>redirect.jsp</code>および<code>index.jsp</code>の4つのファイルがデフォルトで開きます。</li> |
| |
| <li>「プロジェクト」ウィンドウで新規プロジェクトの「ライブラリ」ノードを展開すると、Spring JARがプロジェクトのクラスパスに含まれていることが確認できます。<br> <img alt="プロジェクトの「ライブラリ」ノードに一覧表示されているSpring JAR" class="margin-around b-all" src="../../../images_www/articles/72/web/spring/spring-libraries.png" title="プロジェクトの「ライブラリ」ノードに一覧表示されているSpring JAR"> |
| </li> |
| </ol> |
| |
| |
| <h3 id="running">スケルトン・プロジェクトの実行</h3> |
| |
| <p>プロジェクト・ファイルになんらかの変更を加える前に、次のようにIDEで新規プロジェクトの実行を試します。</p> |
| |
| <ol> |
| <li>IDEのメイン・ツールバーにある「プロジェクトの実行」(<img alt="「プロジェクトの実行」ボタン" src="../../../images_www/articles/72/web/spring/run-project-btn.png">)をクリックします。GlassFishサーバーが実行されていない場合は、IDEが自動的にGlassFishサーバーを起動し、プロジェクトをコンパイルしてサーバーにデプロイします。出力内容は、IDEの出力ウィンドウ([Ctrl]-[4]、Macの場合は[⌘]-[4])に表示されます。生成された出力は、「<code>BUILD SUCCESSFUL</code>」のメッセージが表示されて完了します。<br><img alt="プロジェクト実行時の情報が表示された「出力」ウィンドウ" class="margin-around b-all" src="../../../images_www/articles/72/web/spring/output.png" title="プロジェクト実行時の情報が表示された「出力」ウィンドウ"><br> IDEのデフォルト・ブラウザが開始され、開始ページのビュー(<code>/WEB-INF/jsp/index.jsp</code>)からコンテンツが表示されます。<br><img alt="ブラウザに表示された開始ページ出力" class="margin-around b-all" src="../../../images_www/articles/72/web/spring/browser-output.png" title="ブラウザに表示された開始ページ出力"></li> |
| </ol> |
| |
| <p class="tips">IDEでプロジェクトを実行すると、コンパイルされたプロジェクトがサーバーにデプロイされ、デフォルトのブラウザで開かれます。また、IDEには「保存時にデプロイ」機能が用意されており、Webプロジェクトに対してデフォルトでアクティブ化されています。ファイルをエディタで保存すると、プロジェクトが自動的に再コンパイルされ、サーバーにデプロイされます。変更の確認は、ブラウザでページを単純にリフレッシュするのみで表示できます。</p> |
| |
| <p>実行内容を理解するために、プロジェクトのデプロイメント・ディスクリプタ(<code>web.xml</code>)を調べることから始めます。このファイルをソース・エディタで開くには、「<code>WEB-INF</code>」>「<code>web.xml</code>」ノードを「プロジェクト」ウィンドウで右クリックし、「編集」を選択します。アプリケーションのデフォルトのエントリ・ポイントは「<code>redirect.jsp</code>」です。</p> |
| |
| <div class="indent"> |
| <pre class="examplecode"> |
| <welcome-file-list> |
| <welcome-file>redirect.jsp</welcome-file> |
| </welcome-file-list></pre> |
| </div> |
| |
| <p><code>redirect.jsp</code>内には、すべてのリクエストを<code>index.htm</code>に向ける次のredirect文があります。</p> |
| |
| <div class="indent"> |
| <pre class="examplecode"><% response.sendRedirect("index.htm"); %></pre> |
| </div> |
| |
| <p>デプロイメント・ディスクリプタ内で、<code>*.htm</code>に一致するURLパターンのすべてのリクエストは、次のようにSpringの<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html"><code>DispatcherServlet</code></a>にマップされます。</p> |
| |
| <div class="indent"> |
| <pre class="examplecode"> |
| <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></pre> |
| </div> |
| |
| <p class="tips">dispatcherサーブレットの完全修飾名は、前述のとおり<code>org.springframework.web.servlet.DispatcherServlet</code>です。このクラスはSpringライブラリに含まれ、このライブラリはプロジェクトの作成時にプロジェクト・クラスパスに追加されています。「プロジェクト」ウィンドウでこのことを確認するには、「ライブラリ」ノードをドリルダウンします。<code>spring-webmvc-3.1.1.RELEASE.jar</code>を探し、「<code>org」>「springframework」>「web」>「servlet</code>」と展開して、<code>DispatcherServlet</code>を探します。</p> |
| |
| <p><code>DispatcherServlet</code>では、受信するリクエストが<code>dispatcher-servlet.xml</code>にある構成設定に基づいて処理されます。エディタでタブをクリックして、<code>dispatcher-servlet.xml</code>を開きます。次のコードを確認します。</p> |
| |
| <div class="indent"> |
| <pre class="examplecode"> |
| <bean id="urlMapping" class="org.springframework.web.servlet.handler.<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/handler/SimpleUrlHandlerMapping.html">SimpleUrlHandlerMapping</a>"> |
| <property name="mappings"> |
| <props> |
| <prop key="/index.htm">indexController</prop> |
| </props> |
| </property> |
| </bean> |
| |
| <bean id="viewResolver" |
| class="org.springframework.web.servlet.view.<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/view/InternalResourceViewResolver.html">InternalResourceViewResolver</a>" |
| p:prefix="/WEB-INF/jsp/" |
| p:suffix=".jsp" /> |
| |
| <bean name="indexController" |
| class="org.springframework.web.servlet.mvc.<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/ParameterizableViewController.html">ParameterizableViewController</a>" |
| p:viewName="index" /></pre> |
| </div> |
| |
| <p>このファイルには、<code>indexController</code>、<code>viewResolver</code>、および<code>urlMapping</code>の3つのBeansが定義されています。<code>DispatcherServlet</code>で、<code>index.htm</code>など「<code>*.htm</code>」と一致するリクエストが受信されると、リクエストに対応する<code>urlMapping</code>内のコントローラが検索されます。上記のコードに、<code>/index.htm</code>から<code>indexController</code>へのリンクを行う<code>mappings</code>プロパティがあります。</p> |
| |
| <p>次に、実行時環境で<code>indexController</code>というBeanの定義が検索されます。このBeanは、スケルトン・プロジェクトによって必要なタイミングにあわせて提供されます。<code>indexController</code>は、<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/ParameterizableViewController.html"><code>ParameterizableViewController</code></a>を拡張します。これがSpringで提供されるもう1つのクラスで、単純に表示を返すためのものです。上記のコードでは、<code>p:viewName="index"</code>で論理ビュー名が指定され、この名前の前に<code>/WEB-INF/jsp/</code>、後ろに<code>.jsp</code>が付加されることで、<code>viewResolver</code>を使用して解決されます。これにより、実行時にアプリケーション・ディレクトリでファイルが特定されるようになり、開始ページのビュー(<code>/WEB-INF/jsp/index.jsp</code>)に応答できます。</p> |
| </div> |
| |
| |
| <h2 id="overview">アプリケーションの概要</h2> |
| |
| <p>作成するアプリケーションは、2つのJSPページ(<a href="http://www.oracle.com/technetwork/articles/javase/index-142890.html">MVC</a>の用語では<em>ビュー</em>とも表現)で構成されます。最初のビューには、ユーザー名の入力を求める入力フィールドがあるHTMLフォームが含まれます。2番目のビューは、ユーザー名を含む挨拶メッセージのみを表示するページです。</p> |
| |
| <p>これらのビューは、アプリケーションへのリクエストを受信し、返すビューを判定する<em>コントローラ</em>によって管理されます。また、表示する必要がある情報をビューに渡します(<em>モデル</em>と呼ばれる)。このアプリケーションのコントローラは、<code>HelloController</code>と命名されています。</p> |
| |
| <p>複雑なWebアプリケーションの場合、ビジネス・ロジックは直接コントローラには格納されません。かわりに、コントローラでなんらかのビジネス・ロジックの実行が必要になったときに、<em>service</em>という名前の別のエンティティがコントローラによって使用されます。このアプリケーションでは、ビジネス・ロジックは挨拶メッセージの処理の実行に限定されているため、この目的にあわせて<code>HelloService</code>を作成します。<a name="service"></a> |
| <h2>サービスの実装</h2> |
| |
| <p>これまでの手順で、環境を適切に設定できたため、次は必要に応じてスケルトン・プロジェクトを拡張します。<code>HelloService</code>クラスの作成から始めます。</p> |
| |
| <ol> |
| <li>IDEのメイン・ツールバーにある「新規ファイル」(<img alt="「新規ファイル」ボタン" src="../../../images_www/articles/72/web/spring/new-file-btn.png">)ボタンをクリックします。または、[Ctrl]-[N] (Macの場合は[⌘]-[N])を押します。</li> |
| |
| <li>「<strong>Java</strong>」カテゴリを選択し、「<strong>Javaクラス</strong>」を選択して、「次」をクリックします。</li> |
| |
| <li>表示された新規Javaクラス・ウィザードで、「クラス名」に「<strong>HelloService</strong>」、「パッケージ」に「<strong>service</strong>」と入力して、このクラスの新規パッケージを作成します。</li> |
| |
| <li>「終了」をクリックします。IDEによって新しいクラスが生成され、エディタで開きます。</li> |
| </ol> |
| |
| <p><code>HelloService</code>クラスで実行されるサービスは、ごく基本的なものです。名前をパラメータとして取得し、その名前を格納する<code>String</code>を処理して返します。エディタで、クラスに次の<code>sayHello()</code>メソッドを作成します(<strong>太字</strong>で表示)。</p> |
| |
| <div class="indent"> |
| <pre class="examplecode"> |
| public class HelloService { |
| |
| <strong>public static String sayHello(String name) { |
| return "Hello " + name + "!"; |
| }</strong> |
| }</pre></div> |
| |
| |
| <h2 id="controller">コントローラとモデルの実装</h2> |
| |
| <p><a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/SimpleFormController.html"><code>SimpleFormController</code></a>を使用して、ユーザー・データを処理し、どのビューを返すかを判定できます。</p> |
| <p class="notes"><strong>注意: </strong>SimpleFormControllerはSpring 3.xで非推奨になっています。このチュートリアルでは、デモの目的でのみ使用されます。ただし、注釈の付いたコントローラをXMLファイルのかわりに使用してください。</p> |
| <ol> |
| <li>[Ctrl]-[N] (Macの場合は[⌘]-[N])を押して、新規ファイル・ウィザードを開きます。「カテゴリ」で「<strong>Spring Framework</strong>」を選択します。または、「ファイル・タイプ」で「<strong>単純フォーム・コントローラ</strong>」を選択します。<br><img alt="新規ファイル・ウィザード - 「Spring Framework」カテゴリ" class="b-all margin-around" src="../../../images_www/articles/72/web/spring/simple-form-controller.png" style="width:668px" title="NetBeans IDEで提供される様々なSpringアーティファクト用のテンプレート"><br><span class="tips">NetBeans IDEには、「Spring XML構成ファイル」、「<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/AbstractController.html"><code>抽象コントローラ</code></a>」、「<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/SimpleFormController.html"><code>単純フォーム・コントローラ</code></a>」など、様々なSpringアーティファクト用のテンプレートが用意されています。</span> |
| |
| </li> |
| |
| |
| <li>「次」をクリックします。</li> |
| |
| <li>クラスに「<strong>HelloController</strong>」という名前を付け、「パッケージ」テキスト・フィールドに「<strong>controller</strong>」と入力してクラスの新規パッケージを作成します。「終了」をクリックします。IDEによって新しいクラスが生成され、エディタで開きます。</li> |
| |
| <li>クラス・テンプレートのデフォルトで表示する取得メソッドのコメントを解除し、コントローラ・プロパティを指定します。コード・スニペットのコメントを解除するには、次のイメージに示すようにコードを強調表示して、[Ctrl]-[/] (Macの場合は[⌘]-[/])を押します。<br><img alt="エディタで強調表示されたコード・スニペット" class="b-all margin-around" src="../../../images_www/articles/72/web/spring/comment-out.png" title="コード・スニペットを強調表示した後の[Ctrl]-[/]の押下によるコメントの切替え"><br><span class="tips">[Ctrl]-[/] (Macの場合は[⌘]-[/])を押して、エディタ内のコメントを切り替えます。</span> |
| </li> |
| |
| <li>次のように変更を加えます(<strong>太字</strong>で表示)。 |
| |
| <pre class="examplecode"> |
| public HelloController() { |
| <a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/BaseCommandController.html#setCommandClass(java.lang.Class)">setCommandClass</a>(<strong>Name</strong>.class); |
| <a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/BaseCommandController.html#setCommandName(java.lang.String)">setCommandName</a>("<strong>name</strong>"); |
| <a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/SimpleFormController.html#setSuccessView(java.lang.String)">setSuccessView</a>("<strong>hello</strong>View"); |
| <a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/SimpleFormController.html#setFormView(java.lang.String)">setFormView</a>("<strong>name</strong>View"); |
| }</pre> |
| |
| <p><code>FormView</code>を設定することで、フォームの表示に使用されるビュー名を設定できます。これは、ユーザーが自分の名前を入力できるテキスト・フィールドがあるページです。同様に、<code>SuccessView</code>を設定することによって、送信の成功時に表示されるべきビュー名を設定できます。<code>CommandName</code>の設定時、モデル内でコマンド名を定義します。この場合、このコマンドは、バインドされるリクエスト・パラメータを持つフォーム・オブジェクトです。<code>CommandClass</code>を設定することで、コマンド・クラス名を設定できます。このクラスのインスタンスは、各リクエストと同時に生成および検証されます。</p> |
| |
| <p>エラーのフラグが<code>setCommandClass()</code>メソッド内の<code>Name</code>に表示されます。</p> |
| |
| <img alt="setCommandClass()のエラーが表示されたエディタ" class="b-all margin-around" src="../../../images_www/articles/72/web/spring/set-command-class.png" title="setCommandClass()に表示されたエラー・バッジ"> |
| |
| <p> |
| ここで、各リクエストの情報を保持するための単純なBeanとして、<code>Name</code>クラスを作成する必要があります。</p></li> |
| |
| <li>「プロジェクト」ウィンドウでプロジェクト・ノードを右クリックし、「新規」>「Javaクラス」を選択します。新規Javaクラス・ウィザードが表示されます。</li> |
| |
| <li>「クラス名」に「<strong>Name</strong>」と入力し、「パッケージ」のドロップダウン・リストから「<strong>controller</strong>」を選択します。</li> |
| |
| <li>「終了」をクリックします。<code>Name</code>クラスが作成され、エディタで開きます。</li> |
| |
| <li><code>Name</code>クラスに対し、<code>value</code>という名前のフィールドを作成し、このフィールドのアクセッサ・メソッド(取得メソッドと設定メソッド)を作成します。まず、<code>value</code>フィールドを宣言します。 |
| |
| <pre class="examplecode"> |
| public class Name { |
| |
| <strong>private String value;</strong> |
| |
| }</pre> |
| <p class="tips">すばやく「<code>private</code>」と入力するには、「<code>pr</code>」と入力してから[Tab]を押します。「<code>private</code>」アクセス修飾子が自動的に行に追加されます。これは、エディタのコード・テンプレートの使用例です。コード・テンプレートの一覧を確認するには、「ヘルプ」>「キーボード・ショートカット・カード」を選択します。</p> |
| |
| <br><a name="createAccessors"></a>IDEでアクセッサ・メソッドが作成されます。エディタ内で<code>value</code>を右クリックし、「コードを挿入」を選択するか、[Alt]-[Insert] (Macの場合は[Ctrl]-[I])を押します。ポップアップ・メニューで、「取得メソッドおよび設定メソッド」を選択します。<br> <img alt="エディタに表示された「コードを生成」ポップアップ・メニュー" class="margin-around b-all" src="../../../images_www/articles/72/web/spring/generate-code.png" title="「コードを生成」ポップアップ・メニューから使用できるアクセッサ・メソッドの設定"></li> |
| |
| |
| <li>表示されるダイアログで、「<code>value: String</code>」オプションを選択し、「OK」をクリックします。<code>getValue()</code>および<code>setValue()</code>メソッドが<code>Name</code>クラスに追加されます。 |
| |
| <pre class="examplecode"> |
| public String getValue() { |
| return value; |
| } |
| |
| public void setValue(String value) { |
| this.value = value; |
| }</pre></li> |
| |
| <li>[Ctrl]-[Tab]を押し、<code>HelloController</code>を選択して、<code>HelloController</code>クラスに切り替えます。<code>Name</code>クラスが存在するようになったため、以前のエラー・バッジは表示されなくなります。</li> |
| <li><code>doSubmitAction()</code>メソッドを削除し、<a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/mvc/SimpleFormController.html#setFormView(java.lang.String)"><code>onSubmit()</code></a>メソッドのコメントを解除します。<code>onSubmit()</code>メソッドを使用し、ここで必要な独自の<code>ModelAndView</code>を作成できます。次の変更を加えます。 |
| |
| <pre class="examplecode">@Override |
| protected ModelAndView onSubmit( |
| HttpServletRequest request, |
| HttpServletResponse response, |
| Object command, |
| BindException errors) throws Exception { |
| |
| Name name = (Name) command; |
| ModelAndView mv = new ModelAndView(getSuccessView()); |
| mv.addObject("helloMessage", helloService.sayHello(name.getValue())); |
| return mv; |
| }</pre> |
| |
| 上記に示すとおり、<code>command</code>は<code>Name</code>オブジェクトにキャストされます。<code>ModelAndView</code>のインスタンスが作成され、成功ビューが<code>SimpleFormController</code>の取得メソッドを使用して取得されます。最後に、モデルにデータが取り込まれます。このモデル内の唯一の項目は、以前の手順で作成した<code>HelloService</code>から取得された挨拶メッセージです。<code>addObject()</code>メソッドを使用し、<code>helloMessage</code>という名前のモデルに挨拶メッセージを追加します。</li> |
| |
| <li>エディタ内を右クリックし、「インポートを修正」([Ctrl]-[Shift]-[I]、Macの場合は[⌘]-[Shift]-[I])を選択してインポート・エラーを修正します。<br> <img alt="「すべてのインポートを修正」ダイアログ" class="margin-around b-all" src="../../../images_www/articles/72/web/spring/fix-imports70.png" title="[Ctrl]-[Shift]-[I]の押下によるファイルのインポートの修正"> |
| <p class="notes"><strong>注意:</strong>「すべてのインポートを修正」ダイアログ・ボックスで<strong><tt>org.springframework.validation.BindException</tt></strong>と<strong><tt>org.springframework.web.servlet.ModelAndView</tt></strong>が選択されていることを確認してください。</p></li> |
| |
| <li>「OK」をクリックします。次のインポート文がファイルの最初に追加されます。 |
| |
| <pre class="examplecode">import <a href="http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/web/servlet/ModelAndView.html">org.springframework.web.servlet.ModelAndView</a>;</pre> |
| |
| APIドキュメントで説明されているように、このクラスは「ハンドラによって返されるモデルとビューを示しており、<code>DispatcherServlet</code>によって解決されます。このビューは、<code>ViewResolver</code>によって解決される必要がある<code>String</code>ビュー名か、または直接指定できる<code>View</code>オブジェクトの形を取ることができます。モデルは<code>Map</code>であるため、名前をキーとする複数のオブジェクトが使用できます」。<br><br>この時点では、クラスで<code>HelloService</code>クラスを特定することも、<code>sayHello()</code>メソッドを使用することもできないため、すべてのエラーが修正されるわけではありません。</li> |
| |
| <li><code>HelloController</code>内で<code>HelloService</code>という名前のprivateフィールドを宣言します。 |
| |
| <pre class="examplecode">private HelloService helloService;</pre> |
| |
| 次に、このフィールドのpublic取得メソッドを作成します。 |
| |
| <pre class="examplecode">public void setHelloService(HelloService helloService) { |
| this.helloService = helloService; |
| }</pre> |
| |
| 最後に、エディタを右クリックし、「インポートを修正」を選択します([Ctrl]-[Shift]-[I]、Macの場合は[⌘]-[Shift]-[I])。次の文がファイルの最初に追加されます。 |
| |
| <pre class="examplecode">import service.HelloService;</pre> |
| |
| 今度はすべてのエラーが修正されるはずです。</li> |
| |
| <li><code>HelloService</code>を<code>applicationContext.xml</code>に登録します。<code>applicationContext.xml</code>をエディタで開き、次のBean宣言を入力します。 |
| |
| <pre class="examplecode"> |
| <bean name="helloService" class="service.HelloService" /></pre> |
| |
| <div class="tips">IDE内のSpringサポートには、Bean参照と同様に、JavaクラスのXML構成ファイル内でのコード補完が含まれています。コード補完を呼び出すには、エディタでの作業時に[Ctrl]-[Space]を押します。<br> <img alt="[Ctrl]-[Space]を押して呼び出されたコード補完" class="b-all margin-around" src="../../../images_www/articles/72/web/spring/code-completion.png" title="[Ctrl]-[Space]を押して呼び出されたコード補完"></div></li> |
| |
| <li><code>HelloController</code>を<code>dispatcher-servlet.xml</code>に登録します。<code>dispatcher-servlet.xml</code>をエディタで開き、次のBean宣言を入力します。 |
| |
| <pre class="examplecode"> |
| <bean class="controller.HelloController" p:helloService-ref="helloService"/></pre></li> |
| </ol> |
| |
| |
| <h2 id="view">ビューの実装</h2> |
| |
| <p>このプロジェクトのビューを実装するには、2つのJSPページを作成する必要があります。1つ目は<code>nameView.jsp</code>で、開始ページとして機能し、ユーザーはここに名前を入力できます。もう1つのページは<code>helloView.jsp</code>で、入力された名前を含む挨拶メッセージがここに表示されます。最初に<code>helloView.jsp</code>を作成します。</p> |
| |
| <ol> |
| <li id="create-jsp">「プロジェクト」ウィンドウで「WEB-INF」>「<code>jsp</code>」ノードを右クリックし、「新規」>「JSP」を選択します。新規JSPファイル・ウィザードが開きます。ファイルに「<strong>helloView</strong>」という名前を付けます。</li> |
| |
| <li>「終了」をクリックします。新規JSPページが<code>jsp</code>フォルダに作成され、エディタに表示されます。</li> |
| |
| <li>エディタで、ファイルのtitleを「<code>Hello</code>」に変更し、<code>HelloController</code>で作成される<code>ModelandView</code>オブジェクトの<code>helloMessage</code>を取得するよう、出力メッセージを変更します。 |
| |
| |
| <pre class="examplecode"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title><strong>Hello</strong></title> |
| </head> |
| <body> |
| <h1><strong>${helloMessage}</strong></h1> |
| </body> |
| </pre></li> |
| |
| <li>もう1つのJSPページを<a href="#create-jsp">上記</a>と同じ方法で作成し、名前は「<code>nameView</code>」とします。</li> |
| |
| <li>エディタで、次のSpringタグ・ライブラリ宣言を<code>nameView.jsp</code>に追加します。 |
| |
| <pre class="examplecode"><%@taglib uri="http://www.springframework.org/tags" prefix="spring" %></pre> |
| |
| これにより、<a href="http://static.springframework.org/spring/docs/2.5.x/reference/spring.tld.html">Springタグ・ライブラリ</a>がインポートされます。このライブラリには、ビューをJSPページとして実装する際に役立つタグが格納されます。 |
| |
| <li>「<code>Enter your name</code>」の入力を読み取るように、<code><title></code>タグと<code><h1></code>タグの内容を変更します。</li> |
| |
| <li><code><h1></code>タグの下に次のコードを入力します。 |
| |
| <pre class="examplecode"> |
| <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> |
| </pre> |
| |
| <a href="http://static.springframework.org/spring/docs/2.5.x/reference/spring.tld.html#spring.tld.bind">spring:bind</a>を使用することで、Beanプロパティをバインドできます。bindタグによってバインド・ステータスと値が提供され、これが入力フィールドの名前および値として使用されます。この方法で、フォームの送信時に、送信された値の抽出方法がSpringで識別されます。ここで、コマンド・クラス(<code>controller.Name</code>)に<code>value</code>プロパティが追加されるため、「<code>path</code>」を「<code>value</code>」に設定します。<br><br><a href="http://static.springframework.org/spring/docs/2.5.x/reference/spring.tld.html#spring.tld.nestedPath">spring:nestedPath</a>を使用することで、指定したパスをBeanの前に付加できます。そのため、上記のように<code>spring:bind</code>と一緒に使用すると、Beanへのパスは<code>name.value</code>になります。再コール時、<code>HelloController</code>コマンドの名前は<code>name</code>になります。そのため、ページ範囲内の<code>name</code>という名前のBeanの<code>value</code>プロパティがこのパスから参照されます。 |
| |
| <li>アプリケーションの相対エントリ・ポイントを変更します。現在、プロジェクトのエントリ・ポイントは依然として<code>index.htm</code>であり、前述の<a href="#running">スケルトン・プロジェクトの実行</a>にあるとおり、このページから<code>WEB-INF/jsp/index.jsp</code>にリダイレクトされます。プロジェクトのデプロイおよび実行時のエントリ・ポイントを指定できます。「プロジェクト」ウィンドウでプロジェクト・ノードを右クリックし、「プロパティ」を選択します。「プロジェクト・プロパティ」ダイアログが表示されます。「カテゴリ」で「実行」を選択します。「相対URL」フィールドに「<code>/hello.htm</code>」と入力し、「OK」をクリックします。<br><br>この時点では、<code>hello.htm</code>から<code>HelloController</code>へのマッピングがどこにあるか疑問に感じるかもしれません。<code>urlMapping</code> Beanへのマッピングは、スケルトン・プロジェクトの開始ページである<code>index.htm</code>の場合と同様に、まだ追加していません。この処理は、次のようにBeanを<code>dispatcher-servlet.xml</code>に定義することで実現できるSpringの機能を使用すれば可能になります。 |
| |
| <pre class="examplecode"><bean class="org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping"/></pre> |
| |
| このBeanには、このファイルに登録されたすべてのコントローラに対してURLマッピングを自動的に作成する役割があります。コントローラ(ここでは<code>controller.HelloController</code>)の完全修飾クラス名が取得され、パッケージ名と<code>Controller</code>接尾辞が取り除かれて、その結果がURLマッピングに使用されます。そのため、<code>HelloController</code>の場合は<code>hello.htm</code>というマッピングが作成されます。しかしこの機能は、<code>ParameterizableViewController</code>のようなSpring Frameworkに含まれるコントローラには機能しません。これらには、明示的なマッピングが必要になります。</li> |
| |
| <li>「プロジェクト」ウィンドウでプロジェクト・ノードを右クリックし、「実行」を選択します。これにより、プロジェクトがコンパイル、デプロイおよび実行されます。デフォルト・ブラウザが開き、<code>hello.htm</code>がプロジェクトの<code>nameView</code>として表示されます。<br><img alt="ブラウザに表示されたnameView" class="b-all margin-around" src="../../../images_www/articles/72/web/spring/name-view.png" title="ブラウザでのnameViewの表示"><br>テキスト・フィールドに名前を入力し、[Enter]を押します。<code>helloView</code>が次のように挨拶メッセージと一緒に表示されます。<br><img alt="ブラウザに表示されたhelloView" class="b-all margin-around" src="../../../images_www/articles/72/web/spring/hello-view.png" title="ブラウザでのhelloViewの表示"></li> |
| </ol> |
| |
| |
| <div class="feedback-box"> |
| <a href="/about/contact_form.html?to=3&subject=Feedback:%20Introduction%20to%20Spring">ご意見をお寄せください</a></div> |
| |
| <br style="clear:both;"> |
| |
| |
| <h2 id="seeAlso">関連項目</h2> |
| |
| <p>これで、NetBeans IDEでのSpring Framework入門は終わりです。このドキュメントでは、Spring Frameworkを使用してNetBeans IDEで単純なWeb MVCアプリケーションを構築する方法をデモし、Webアプリケーション開発用のIDEインタフェースを紹介しました。</p> |
| |
| <p><a href="http://sites.google.com/site/springmvcnetbeans/step-by-step/">NetBeansおよびGlassFishサーバーによるSpring Framework MVCアプリケーションの手順を追った開発</a>などの他のNetBeans IDEチュートリアル全般を実行し、Spring Frameworkの学習を続けることをお薦めします。これはThomas Risbergによる公式な<a href="http://static.springframework.org/docs/Spring-MVC-step-by-step/">Spring Frameworkチュートリアル</a>であり、Arulazi DhesiaseelanによってNetBeans IDEのために改訂されました。</p> |
| |
| <p>Spring NetBeansモジュール機能の多くは、Webベース以外のSpring Frameworkアプリケーションにも適用できます。 |
| |
| <p>その他の関連チュートリアルについては、次のリソースを参照してください。</p> |
| |
| <ul> |
| <li><a href="../../docs/web/framework-adding-support.html">Webフレームワークのためのサポートの追加</a>。NetBeans更新センターを使用してWebフレームワークのプラグインをインストールすることによるサポート追加方法を説明した基本ガイドです。</li> |
| |
| <li><a href="jsf20-intro.html">JavaServer Faces 2.0入門</a>。JSF 2.0サポートを既存のプロジェクトに追加し、管理対象Beanを接続し、Faceletsテンプレートを利用する方法を説明しています。</li> |
| </ul> |
| |
| </body> |
| </html> |