本教程源码请访问: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>
btn").click(function () {
//发送ajax请求
KaTeX parse error: Expected '}', got 'EOF' at end of input: … url: "{pageContext.request.contextPath}/test3",
contentType: “application/json;charset=UTF-8”,
data: ‘{“flag”:false}’,
dataType: “JSON”,
type: “POST”,
success: function(data) {
console.log(data);
}
});
});
});