本教程源碼請訪問:tutorial_demo 一、概述 系統的dao、service、controller出現都通過throws Exception向上拋出,最後由springmvc前端控制器交由異常處理器進行異常處理,如下圖: 二、環境搭建 2.1、創建工程 在idea中從原型創建Maven工程, ...
本教程源碼請訪問:tutorial_demo
一、概述
系統的dao、service、controller出現都通過throws Exception向上拋出,最後由springmvc前端控制器交由異常處理器進行異常處理,如下圖:
二、環境搭建
2.1、創建工程
在idea中從原型創建Maven工程,選擇org.apache.maven.archetypes:maven-archetype-webapp
,在pom.xml中添加如下的坐標:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<!-- Servlet -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
<scope>provided</scope>
</dependency>
<!-- JSP -->
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.9.0</version>
</dependency>
由於控制器要響應JSON數據,一定要添加JSON處理的坐標。
2.2、在項目中創建存放源碼和配置文件的目錄
在src/main目錄下創建java和resources兩個目錄,java目錄用來存放Java源碼,resources用來存放配置文件。這樣創建的目錄是普通目錄,編譯時不能被正確識別,此時還需要進行如下操作:
- 在java目錄上右鍵-->Make Directory as-->Sources root;
- 在resources目錄上右鍵-->Make Directory as-->Resources Root;
以後的教程裡面,只要涉及到Maven的Java Web工程,都要這樣做。
2.3、編寫SpringMVC的配置文件
在resources目錄下新建springmvc.xml。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!-- 配置spring創建容器時要掃描的包 -->
<context:component-scan base-package="org.codeaction"></context:component-scan>
<!-- 配置視圖解析器 -->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/pages/"></property>
<property name="suffix" value=".jsp"></property>
</bean>
<!--
配置靜態資源不過濾
location:表示路徑
mapping:表示文件
**表示該目錄下的文件以及子目錄文件
-->
<mvc:resources location="/css/" mapping="/css/**" />
<mvc:resources location="/images/" mapping="/images/**" />
<mvc:resources location="/js/" mapping="/js/**" />
<!-- 配置spring開啟註解mvc的支持-->
<mvc:annotation-driven></mvc:annotation-driven>
</beans>
2.4、在web.xml中添加配置
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<!-- SpringMVC的核心控制器 -->
<servlet>
<servlet-name>dispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 配置Servlet的初始化參數,讀取springmvc的配置文件,創建spring容器 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc.xml</param-value>
</init-param>
<!-- 配置servlet啟動時載入對象 -->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!-- 解決POST請求亂碼 -->
<filter>
<filter-name>characterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
2.5、自定義異常類及響應類
自定義MyException異常類,代碼如下:
package org.codeaction.exception;
/**
* 自定義異常
*/
public class MyException extends Exception{
public MyException() {
super();
}
public MyException(String msg) {
super(msg);
}
}
自定義MyJSONException異常類,代碼如下:
package org.codeaction.exception;
/**
* 自定義異常
*/
public class MyJSONException extends Exception{
public MyJSONException() {
}
public MyJSONException(String message) {
super(message);
}
}
自定義響應類Resp,代碼如下:
package org.codeaction.bean;
/**
* 自定義響應類,用於響應JSON數據
*/
public class Resp {
private String msg;
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
@Override
public String toString() {
return "Resp{" +
"msg='" + msg + '\'' +
'}';
}
}
三、通過註解方式捕獲異常
3.1、配置控制器異常處理
配置控制器異常處理,使用@Controller+@ExceptionHandler
。
3.1.1、編寫控制器類
package org.codeaction.controller;
import org.codeaction.exception.MyException;
import org.codeaction.exception.MyJSONException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class UserController {
/**
* 控制器內部異常處理,只能處理本控制器內部的MyException
* @param e
* @return
*/
@ExceptionHandler(MyException.class)
public String handleRuntimeException(MyException e) {
System.out.println("MyException----UserController內部異常處理...");
return "error";
}
//用來測試控制器內部異常處理
@RequestMapping("/test1")
public String test1(boolean flag) throws MyException {
System.out.println("test1...");
if (flag == false) {
throw new MyException("test1...");
}
return "success";
}
}
我們定義了一個控制器類UserController,同時做瞭如下操作:
- 定義test1方法,用來處理請求,在flag為false時,拋出自定義異常給核心控制器DispatcherServlet,用來模擬Controller調用Service時,Service出現的異常;
- @ExceptionHandler用來定義異常處理,這個異常處理在控制器內部,只能處理控制器內部方法出現的異常,@ExceptionHandler的參數是Throwable實現類的Class數組,可以填多個值,但是要加大括弧。
3.1.2、編寫頁面
<p>
<a href="${pageContext.request.contextPath}/test1?flag=false">測試控制器內部異常處理,返回邏輯視圖</a>
</p>
3.2、配置全局異常處理
控制器的異常處理只能處理控制器內部的異常,如果希望處理控制器拋出的所有異常而不希望在控制器內部處理,這就需要配置全局異常處理。配置全局異常處理,使用@ControllerAdvice+@ExceptionHandler
。
3.2.1、編寫控制器類
package org.codeaction.controller;
import org.codeaction.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class DeptController {
//用來測試全局異常處理
@RequestMapping("/test2")
public String test2(boolean flag) throws MyException {
System.out.println("test2...");
if (flag == false) {
throw new MyException("test2...");
}
return "success";
}
}
這裡我們定義了一個控制器類,在特定的情況下test2方法會拋出異常,並且控制器內部沒有進行異常處理的方法。
3.2.2、編寫全局異常處理類
package org.codeaction.exceptionhandler;
import org.codeaction.bean.Resp;
import org.codeaction.exception.MyException;
import org.codeaction.exception.MyJSONException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
@ControllerAdvice
public class WebExceptionHandler {
/**
* 全局異常處理,處理MyException
* @param e
* @return 返回ModelAndView
*/
@ExceptionHandler(MyException.class)
public ModelAndView handleRuntimeException(MyException e) {
System.out.println("MyException----全局異常處理...");
ModelAndView mv = new ModelAndView();
mv.setViewName("error");
mv.addObject("msg", e.getMessage());
return mv;
}
}
3.2.3、編寫頁面
<p>
<a href="${pageContext.request.contextPath}/test2?flag=false">測試全局異常處理,返回ModelAndView</a>
</p>
四、對異常進行處理
對異常進行處理,其實就是以不同的方式將異常結果返回給調用者,常用方式如下:
- 返回頁面的邏輯視圖,配置控制器異常處理使用的此方式;
- 返回ModelAndView,配置全局異常處理使用的此方式;
- 返回JSON數據。
我們重點看一下返回JSON數據,這裡涉及JSON數據處理,pom.xml中要配置Jackson的坐標。
4.1、修改全局異常處理類
/**
* 全局異常處理,處理MyJSONException
* @param e
* @return 返回JSON
*/
@ExceptionHandler(MyJSONException.class)
@ResponseBody
public Resp handleMyJSONException(MyJSONException e) {
Resp resp = new Resp();
resp.setMsg(e.getMessage());
return resp;
}
@ResponseBody用來將異常處理返回的對象轉化成JSON。
4.2、修改頁面
添加按鈕
<p>
<button id="btn" type="button">測試全局異常處理,返回JSON</button>
</p>
添加Ajax處理
<script src="${pageContext.request.contextPath}/js/jquery.min.js"></script>
<script>
$(function () {
$("#btn").click(function () {
//發送ajax請求
$.ajax({
url: "${pageContext.request.contextPath}/test3",
contentType: "application/json;charset=UTF-8",
data: '{"flag":false}',
dataType: "JSON",
type: "POST",
success: function(data) {
console.log(data);
}
});
});
});
</script>