Spring-exception-handling-example

提供:Dev Guides
移動先:案内検索

Spring-例外処理の例

次の例は、Spring MVC Frameworkを使用して、コントローラー内で発生した1つ以上の例外を処理できる単純なWebベースのアプリケーションを作成する方法を示しています。 まず、動作するEclipse IDEを用意し、次の手順を実行して、Spring Web Frameworkを使用して動的なフォームベースのWebアプリケーションを開発します。

Step Description
1 Create a Dynamic Web Project with a name HelloWeb and create a package com.finddevguides under the src folder in the created project.
2 Drag and drop below mentioned Spring and other libraries into the folder WebContent/WEB-INF/lib.
3 Create a Java classes Student, StudentController and SpringException under the com.finddevguides package.
4 Create Spring configuration files Web.xml and HelloWeb-servlet.xml under the WebContent/WEB-INF folder.
5 Create a sub-folder with a name jsp under the WebContent/WEB-INF folder. Create a view files student.jsp, result.jsp, error.jsp, and ExceptionPage.jsp under jsp sub-folder.
6 The final step is to create the content of all the source and configuration files and export the application as explained below.

以下は Student.java ファイルの内容です

package com.finddevguides;

public class Student {
   private Integer age;
   private String name;
   private Integer id;

   public void setAge(Integer age) {
      this.age = age;
   }
   public Integer getAge() {
      return age;
   }
   public void setName(String name) {
      this.name = name;
   }
   public String getName() {
      return name;
   }
   public void setId(Integer id) {
      this.id = id;
   }
   public Integer getId() {
      return id;
   }
}

以下は SpringException.java ファイルの内容です

package com.finddevguides;

public class SpringException extends RuntimeException{
   private String exceptionMsg;

   public SpringException(String exceptionMsg) {
      this.exceptionMsg = exceptionMsg;
   }
   public String getExceptionMsg(){
      return this.exceptionMsg;
   }
   public void setExceptionMsg(String exceptionMsg) {
      this.exceptionMsg = exceptionMsg;
   }
}

以下は StudentController.java ファイルの内容です。 ここでは、_ @ ExceptionHandler_を使用してサービスメソッドに注釈を付ける必要があります。ここで、処理する1つ以上の例外を指定できます。 複数の例外を指定する場合は、カンマ区切りの値を使用できます。

package com.finddevguides;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.ui.ModelMap;

@Controller
public class StudentController {
   @RequestMapping(value = "/student", method = RequestMethod.GET)
   public ModelAndView student() {
      return new ModelAndView("student", "command", new Student());
   }
   @RequestMapping(value = "/addStudent", method = RequestMethod.POST)
   @ExceptionHandler({SpringException.class})
   public String addStudent( @ModelAttribute("HelloWeb")Student student,
      ModelMap model) {

      if(student.getName().length() < 5 ){
         throw new SpringException("Given name is too short");
      } else {
         model.addAttribute("name", student.getName());
      }

      if( student.getAge() < 10 ){
         throw new SpringException("Given age is too low");
      } else {
         model.addAttribute("age", student.getAge());
      }
      model.addAttribute("id", student.getId());
      return "result";
   }
}

以下は、Spring Web構成ファイル web.xml の内容です。

<web-app id = "WebApp_ID" version = "2.4"
   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">

   <display-name>Spring Exception Handling</display-name>

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

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

</web-app>

以下は、別のSpring Web構成ファイル HelloWeb-servlet.xml の内容です。

<beans xmlns = "http://www.springframework.org/schema/beans"
   xmlns:context = "http://www.springframework.org/schema/context"
   axmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   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">

   <context:component-scan base-package = "com.finddevguides"/>

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

   <bean class = "org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
      <property name = "exceptionMappings">
         <props>
            <prop key = "com.finddevguides.SpringException">
               ExceptionPage
            </prop>
         </props>
      </property>
      <property name = "defaultErrorView" value = "error"/>
   </bean>

</beans>

ここでは、SpringExceptionが発生した場合に例外ビューとして_ExceptionPage_を指定しました。他の種類の例外がある場合、汎用ビュー_error_が発生します。

以下は、Springビューファイル student.jsp のコンテンツです。

<%@taglib uri = "http://www.springframework.org/tags/form" prefix = "form"%>
<html>
   <head>
      <title>Spring MVC Exception Handling</title>
   </head>

   <body>
      <h2>Student Information</h2>
      <form:form method = "POST" action = "/HelloWeb/addStudent">
         <table>
            <tr>
               <td><form:label path = "name">Name</form:label></td>
               <td><form:input path = "name"/></td>
            </tr>
            <tr>
               <td><form:label path = "age">Age</form:label></td>
               <td><form:input path = "age"/></td>
            </tr>
            <tr>
               <td><form:label path = "id">id</form:label></td>
               <td><form:input path = "id"/></td>
            </tr>
            <tr>
               <td colspan = "2"><input type = "submit" value = "Submit"/></td>
            </tr>
         </table>
      </form:form>
   </body>

</html>

以下は、Springビューファイル error.jsp のコンテンツです。

<html>
   <head>
      <title>Spring Error Page</title>
   </head>

   <body>
      <p>An error occured, please contact webmaster.</p>
   </body>
</html>

次に、Springビューファイル ExceptionPage.jsp のコンテンツを示します。 ここでは、$ \ {exception}を介して例外インスタンスにアクセスします。

<%@taglib uri = "http://www.springframework.org/tags/form" prefix = "form"%>
<html>
   <head>
      <title>Spring MVC Exception Handling</title>
   </head>

   <body>
      <h2>Spring MVC Exception Handling</h2>
      <h3>${exception.exceptionMsg}</h3>
   </body>
</html>

次に、Springビューファイル result.jsp のコンテンツを示します。

<%@taglib uri = "http://www.springframework.org/tags/form" prefix = "form"%>
<html>
   <head>
      <title>Spring MVC Form Handling</title>
   </head>

   <body>
      <h2>Submitted Student Information</h2>

      <table>
         <tr>
            <td>Name</td>
            <td>${name}</td>
         </tr>
         <tr>
            <td>Age</td>
            <td>${age}</td>
         </tr>
         <tr>
            <td>ID</td>
            <td>${id}</td>
         </tr>
      </table>
   </body>

</html>

最後に、Webアプリケーションに含めるSpringおよびその他のライブラリのリストを次に示します。 これらのファイルをドラッグして、 WebContent/WEB-INF/lib フォルダーにドロップするだけです。

  • commons-logging-x.y.z.jar
  • org.springframework.asm-x.y.z.jar
  • org.springframework.beans-x.y.z.jar
  • org.springframework.context-x.y.z.jar
  • org.springframework.core-x.y.z.jar
  • org.springframework.expression-x.y.z.jar
  • org.springframework.web.servlet-x.y.z.jar
  • org.springframework.web-x.y.z.jar
  • spring-web.jar

ソースファイルと構成ファイルの作成が完了したら、アプリケーションをエクスポートします。 アプリケーションを右クリックし、[エクスポート]> [WARファイル]オプションを使用して、* HelloWeb.war *ファイルをTomcatの_webapps_フォルダーに保存します。

Tomcatサーバーを起動し、標準ブラウザを使用してwebappsフォルダーから他のWebページにアクセスできることを確認します。 ここで、URL http://localhost:8080/HelloWeb/student にアクセスしてみてください。 Spring Webアプリケーションで問題がなければ、次の結果が表示されます。

春学生フォーム

上記のように値を入力し、送信ボタンをクリックします。 Spring Webアプリケーションで問題がなければ、次の結果が表示されます。

春の例外結果