互联网应用主流框架整合【Spring MVC异常处理机制】

Davieyang.D.Y

已于 2024-07-10 13:10:19 修改

阅读量2w

点赞数 3

分类专栏：互联网应用主流框架文章标签： 1024程序员节 SpringMVC异常处理接口 SpringMVC异常处理

于 2020-10-24 17:22:00 首次发布

本文链接：https://blog.csdn.net/dawei_yang000000/article/details/109260701

版权

互联网应用主流框架专栏收录该内容

63 篇文章 1 订阅

订阅专栏

Spring MVC异常处理机制

任何成熟的MVC框架都提供异常处理机制，当然可以在 Controller的请求处理方法中手动使用try…catch块捕捉异常，当捕捉到特定异常时，返回特定逻辑视图名，但这种处理方式非常烦琐，需要在请求处理方法中书写大量的catch块
最大的缺点还在于异常处理与代码耦合，一旦需要改变异常处理方式，必须修改大量代码，如下代码所示

public class XxController{
	...
	@RequestMapping("/davieyang")
	public String davieyang() throws Exception{
		try{
			...
		} catch(except1 e){
			return result1;
		} catch(except2 e){
			return result2;
		}
	}
}

Spring MVC中提供的异常处理方式有两种：

使用Spring MVC提供的简单异常处理器SimpleMappingExceptionResolver
使用@ExceptionHandler注解实现局部异常处理或使用@ControllerAdvice注解实现统一异常处理

Spring MVC异常处理接口以及实现类

HandlerExceptionResolver是Spring 3.0之后新增的一个重要接口，负责Spring MVC的异常处理,该接口只有一个方法签名:
ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, @Nullable java.lang.Object handler, java.lang.Exception ex)

resolveException方法处理程序执行期间被抛出的异常，返回一个模型和视图，视图通常是一个特定的错误处理页面。
AbstractHandlerExceptionResolver 抽象类实现了 HandlerExceptionResolver 接口，重写了HandlerExceptionResolver接口的 resolveException方法用于处理异常
AbstractHandlerMethodExceptionResolver抽象类继承了 AbstractHandlerExceptionResolver抽象类，该类主要就是为 HandlerMethod类服务，即handler参数是HandlerMethod类型
ExceptionHandlerExceptionResolver类继承自 AbstractHandlerMethodExceptionResolver，该类主要处理Controller中使用@ExceptionHandler注解的方法和@ControllerAdvice注解定义的类。该类也是＜mvc：annotation-driven/＞配置中定义的 HandlerExceptionResolver实现类之一，大多数异常处理都由该类操作
SimpleMappingExceptionResolver继承自 AbstractHandlerExceptionResolver抽象类，是一个根据配置来解析异常
的类，包括异常类型、默认的错误视图、默认的响应码及异常映射等配置属性

在Spring MVC中进行异常处理，如果选择XML配置，则使用SimpleMapping-ExceptionResolver类
如果使用@ExceptionHandler 注解和@ControllerAdvice 注解，则由ExceptionHandlerExceptionResolver 类进行处理
两种异常处理方式在项目中不能共存，在开发中通常根据实际情况l来选择

SimpleMappingExceptionResolver处理异常

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!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">
<title>异常处理示例</title>
</head>
<body>
<br>
<a href="hello">没有异常处理</a><br><br>
<a href="test">使用简单异常处理器处理异常</a><br><br>
<a href="find">使用简单异常处理器处理特定异常</a><br><br>
</body>
</html>

index.jsp中有3个超链接，分别测试没有异常处理、有异常处理、特定异常处理3种情况

package org.davieyang.controller;


import java.sql.SQLException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class TestController{
	
	@GetMapping("/hello")
	public String hello() throws Exception{
		// 抛出异常
		throw new Exception();
	}
	
	@GetMapping("/test")
	public String test() throws Exception{
		// 模拟异常
		int i = 5/0;
		return "success";
	}
	
	@GetMapping("/find")
	public String find() throws Exception{
		try {
			// 模拟异常
			int i = 5/0;
			return "success";
		} catch (Exception e) {
			throw new SQLException("查找数据失败!");
		}
	}
}

TestController中有3个方法，分别对应index.jsp页面的3个请求： hello方法什么都没做，直接抛出一个异常，test方法模拟了一个除数不能为0异常，find方法模拟了一个除数不能为0异常之后，在catch块中抛出了一个SQLException异常
部署SimpleMappingExceptionResolverTest这个Web应用，在浏览器中输入如下URL来测试应用http://localhost:8080/SimpleMappingExceptionResolverTest/
在这里插入图片描述
单击“没有异常处理”超链接，发送“hello”请求，此时没有异常处理程序，异常被直接抛给了浏览器，页面上显示一大堆错误堆栈信息，用户看到这些错误堆栈信息，而且错误堆栈信息由于暴露了后台方法的调用关系，对应用来说这是存在一定潜在风险的
在这里插入图片描述
虽然在web.xml中可以配置处理异常的jsp页面，但这还是远远不够的，Spring MVC对错误处理提供了更好的解决方案，接下来，在springmvc-config.xml中加入异常处理的配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xmlns:context="http://www.springframework.org/schema/context"
    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可以自动去扫描base-pack下面的包或者子包下面的java文件，
    	如果扫描到有Spring的相关注解的类，则把这些类注册为Spring的bean -->
    <context:component-scan base-package="org.davieyang.controller"/>
    <!-- 默认配置方案 -->
    <mvc:annotation-driven/>
	<!-- 静态资源处理 -->
    <mvc:default-servlet-handler/>
    
    <!-- 视图解析器  p:prefix属性表示前缀  p:suffix 表示后缀  -->
     <bean id="viewResolver"
          class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          p:prefix="/WEB-INF/content/" p:suffix=".jsp"/> 
    
    <!-- 异常处理
    	p:defaultErrorView="error"表示所有没有指定的异常,都跳转到异常处理页面error
    	p:exceptionAttribute="ex"表示异常处理页面中访问的异常对象变量名是ex
     -->
    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver"
    	p:defaultErrorView="error"
    	p:exceptionAttribute="ex">
    	<!-- 异常映射 
    		exceptionMappings表示映射的异常，接受参数是一个Properties
    		key是异常类名，value是处理异常的页面
    	-->
    	<property name="exceptionMappings">
    		<props>
    			<prop key="IOException">ioerror</prop>
    			<prop key="SQLException">sqlerror</prop>
    		</props>
    	</property>
    </bean>
    
</beans>

重点是异常处理的配置。SimpleMappingExceptionResolver是Spring 提供的处理异常的类，所有抛出的异常都会被该类捕获p： defaultErrorView=＂error＂表示所有没有指定的异常都跳转到异常处理页面error，p：exceptionAttribute=＂ex＂表示在异常处理页面中可以访问的异常对象变量名是ex。如果需要为一些特定的异常指定异常处理页面，可以使用exceptionMappings属性，该属性接受的参数是一个Properties对象，key是异常类名或者包名加类名，value是异常处理页面。例如上面的配置指明，如果是IOException则跳转到ioerror页面，是SQLException则跳转到sqlerror页面，是其他异常则全部跳转到error页面，在所有异常页面中可以通过ex变量访问异常对象Exception

error.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!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">
<title>异常处理示例</title>
</head>
<body>
<h3>异常处理页面</h3>
抛出异常信息：${requestScope.ex.message}
</body>
</html>

sqlerror.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!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">
<title>异常处理示例</title>
</head>
<body>
<h3>特定异常处理页面</h3>
抛出异常信息：${requestScope.ex.message}
</body>
</html>

再次运行SimpleMappingExceptionResolverTest这个Web应用，在浏览器中输入如下URL来测试应用http://localhost:8080/SimpleMappingExceptionResolverTest/单击“使用简单异常处理器处理异常”超链接，发送“test”请求，抛出的异常被SimpleMappingExceptionResolver捕获，转发到异常处理页面error.jsp
在这里插入图片描述
单击“使用简单异常处理器处理特定异常”超链接，发送“find”请求，请求处理方法抛出的是 SQLException 异常，被 SimpleMappingExceptionResolver捕获，转发到异常处理页面 sqlerror.jsp

@ResponseStatus注解

org.springframework.web.bind.annotation.ExceptionHandle.ResponseStatus注解是处理异常最简单的方式，其可以修饰一个类或者一个方法，当修饰一个类的时候，通常修饰的是一个异常类,使用@ResponseStatus注解可指定如下表所示的属性

属性	类型	是否必要	说明
code	HttpStatus	否	http状态码，如HttpStatus.CREATE、HttpStatus.OK等
value	String	否	同Code属性
reason	HttpStatus	否	错误信息

使用时，先声明一个自定义异常类，在自定义异常类上面加上 @ResponseStatus注解，就表示在系统运行期间，当抛出自定义异常的时候，使用@ResponseStatus 注解中声明的 value属性和reason属性将异常信息返回给客户端，提高可读性

@ResponseStatus处理异常

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!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">
<title>异常处理示例</title>
</head>
<body>
<br>
<a href="find">@ResponseStatus异常处理</a><br><br>
</body>
</html>

package org. daviejava.exception;

import org.springframework.web.bind.annotation.ResponseStatus;

@ResponseStatus(reason="查询数据失败")
public class BookException extends RuntimeException {
}

package org.davieyang.controller;


import org.daviejava.exception.BookException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class BookController{
	
	@GetMapping("/find")
	public String find() throws Exception{
		try {
			int i = 5/0;
			return "success";
		} catch (Exception e) {
			throw new BookException();
		}
		
		
	}

}

BookException是自定义异常类，使用了@ResponseStatus注解修饰，reason表示抛出异常时显示的错误信息，此处没有使用value属性，表示适用于所有http状态码;find方法模拟了一个异常，发生异常时抛出自定义异常 BookException。部署ResponseStatusTest这个Web应用，在浏览器中输入URL:http://localhost:8080/ResponseStatusTest/来测试应用
在这里插入图片描述
单击“@ResponseStatus 异常处理”超链接，发送“find”请求，请求处理方法抛出自定义BookException异常，显示异常信息

@ExceptionHandle注解

org.springframework.web.bind.annotation.ExceptionHandle 注解的作用对象为方法，并且在运行时有效，value()可以指定异常类,@ExceptionHandler注解的源代码如下

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler{
	Class<? extends Throwable>[] value() default{};
}

@ExceptionHandler注解的方法可以支持的参数除了HttpServletRequest、HttpServletResponse等对象之外，还支持一个异常参数，包括一般的异常或自定义异常。如果注解没有指定异常类，会默认进行映射

@ExceptionHandler处理异常

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!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">
<title>异常处理示例</title>
<script type="text/javascript" src="js/jquery-1.11.0.min.js"></script>
<script type="text/javascript">
       $(function(){
    	   $("#btn").click(function(){
    			  $.post("${pageContext.request.contextPath}/search",null,
    						function(data){ 
    				// 处理异常
    					if (data.message)
    					{
    						alert("与服务器交互出现异常：" + data.message);
    					}
    					else
    					{
    						// 获取服务器响应，将所有图书显示在页面
    						
    					}
    				},"json");
  				});
       })
	</script>
</head>
<body>
<a href="test">@ExceptionHandler处理异常</a><br><br>
<hr>
<a href="login">UserController：父级Controller异常处理</a><br><br>
<a href="find">BookController：父级Controller异常处理</a><br><br>
</body>
</html>

index.jsp中有3个超链接，分别用于测试@ExceptionHandler异常处理和使用父级Controller异常处理

package org.davieyang.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class TestController{

	@GetMapping("/test")
	public String test() throws Exception{
		// 模拟异常
		int i = 5/0;
		return "success";
	}
	
	/**
	 * 在异常抛出的时候，Controller会使用@ExceptionHandler注解的方法去处理异常
	 * */
	@ExceptionHandler(value = Exception.class)
	public ModelAndView testErrorHandler(Exception e)  {
		ModelAndView mav = new ModelAndView();
        mav.setViewName("error");
        mav.addObject("ex", e);
        return mav;
	}
	
}

TestController中test（）方法是index.jsp页面的超链接“@ExceptionHandler处理异常”的请求处理方法，模拟了一个除数不能为0的异常。
testErrorHandler（）方法使用了@ExceptionHandler注解，value=Exception.class表示处理所有的Exception类型异常。
当TestController类抛出异常的时候，会使用@ExceptionHandler注解的方法去处理异常，而不会直接抛给浏览器。testErrorHandler()方法将捕捉到的异常对象保存到ModelAndView当中，传递到JSP页面

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!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">
<title>测试@ExceptionHandler注解</title>
</head>
<body>
<h3>异常处理页面</h3>
抛出异常信息：${requestScope.ex.message}
</body>
</html>

部署ExceptionHandlerTest这个Web应用，在浏览器中输入URLhttp://localhost:8080/ExceptionHandlerTest/来测试应用
在这里插入图片描述
单击“@ExceptionHandler 处理异常”超链接，发送“test”请求，
TestController 的 test()方法处理请求，抛出异常，异常被 @ExceptionHandler 注解修饰的 testErrorHandler 方法捕获，处理之后跳转到error.jsp页面

基于Controller的@ExceptionHandler注解方法在进行异常处理时，对于每个Controller都需要写@ExceptionHandler注解的异常处理方法,在实际开发当中这非常烦琐。可以写一个父类，在父类中完成 @ExceptionHandler注解的异常处理方法，所有的Controller继承这个父类，则所有的Controller就都拥有了@ExceptionHandler注解的异常处理方法

package org.davieyang.controller;


import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;

public class BaseController {

	@ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(Exception e) throws Exception {
		ModelAndView mav = new ModelAndView();
        mav.addObject("ex", e);
        mav.setViewName("error");
        return mav;
    }
	
}

BaseController作为父类，定义了一个@ExceptionHandler注解修饰的方法

package org.davieyang.controller;


import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class UserController extends BaseController{
	
	@GetMapping("/login")
	public String login(String username) throws Exception{
		if(username == null ){
			throw new NullPointerException("用户名不存在!");
		}
		return "success";
	}
}

UserController继承BaseController，如果抛出异常，将使用父类的 @ExceptionHandler注解修饰的方法处理异常

package org.davieyang.controller;


import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;

public class BaseController {

	@ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(Exception e) throws Exception {
		ModelAndView mav = new ModelAndView();
        mav.addObject("ex", e);
        mav.setViewName("error");
        return mav;
    }
	
}

BookController继承BaseController，如果抛出异常，将使用父类的 @ExceptionHandler注解修饰的方法处理异常,再次部署Exception2Test这个Web应用，在浏览器中输入如下URL来测试应用，如图3.29所示。单击“UserController：父级Controller异常处理”超链接，发送“login”请求，异常处理之后跳转到error.jsp页面
在这里插入图片描述
再次请求index.jsp页面，如图3.29所示。单击“BookController：父级Controller异常处理”超链接，发送“find”请求，异常处理之后跳转到 error.jsp页面

@ControllerAdvice注解

org.springframework.web.bind.annotation.ControllerAdvice注解是Spring 3.2提供的新注解，它是一个控制器增强功能注解。该注解源代码如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice{
	@AliasFor("basePackages")
	String[] value() default {};
	@AliasFor("value")
	String[] basePackages() default {};
	Class<?>[] basePackageClasses() default {};
	Class<?>[] assignableTypes() default{};
	Class<? extends Annotation>[] annotations() default{};
}

该注解使用@Component 注解，也就是说可以使用＜context： component-scan＞扫描该注解。Spring官方文档说明，扫描到 @ControllerAdvice注解之后，会将@ControllerAdvice注解修饰的类的内部使用@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法应用到所有的请求处理方法上。在实际开发中，@ExceptionHandler注解的功能最强大，另外两个用处不大

@ControllerAdvice处理异常

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!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">
<title>异常处理示例</title>
<script type="text/javascript" src="js/jquery-1.11.0.min.js"></script>
<script type="text/javascript">
       $(function(){
    	   $("#search").click(function(){
    			  $.post("${pageContext.request.contextPath}/search",null,
    						function(data){ 
    				// 处理异常
    					if (data.message)
    					{
    						alert("与服务器交互出现异常：" + data.message);
    					}
    					else
    					{
    						// 获取服务器响应，显示所有订单信息
    						
    					}
    				},"json");
  				});
       })
	</script>
</head>
<body>
<br>
<a href="find">@ControllerAdvice异常处理</a><br><br>
<hr>
<button id="search">查询订单（返回JSON）</button>
</body>
</html>

index.jsp 中有两个超链接，分别用来测试@ControllerAdvice 异常处理和异常处理时返回JSON 的两种情况。需要注意 id=“search”的按钮，使用 jQuery进行异步查询订单时，如果抛出异常，则获取返回的JSON 数据并提示错误

package org.davieyang.controller;


import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class BookController{
	
	@GetMapping("/find")
	public String find() throws Exception{
		int i = 5/0;
		return "success";
	}

}

BookController处理“find”请求，在请求处理方法中简单地模拟了一个异常。BookController中并没有@ExceptionHandler注解修饰的方法，抛出的异常会由@ControllerAdvice注解修饰的类中的@ExceptionHandler 注解修饰的方法进行处理

package org.davieyang.controller;

public class OrderException extends RuntimeException {

	public OrderException() {
		super();
		// TODO Auto-generated constructor stub
	}

	public OrderException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
		super(message, cause, enableSuppression, writableStackTrace);
		// TODO Auto-generated constructor stub
	}

	public OrderException(String message, Throwable cause) {
		super(message, cause);
		// TODO Auto-generated constructor stub
	}

	public OrderException(String message) {
		super(message);
		// TODO Auto-generated constructor stub
	}

	public OrderException(Throwable cause) {
		super(cause);
		// TODO Auto-generated constructor stub
	}

}

OrderException是一个自定义异常类型，继承自RuntimeException

package org.davieyang.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;

@Controller
public class OrderController {

	@PostMapping("/search")
	public String search() throws Exception{
		try {
			int i = 5/0;
			return "success";
		} catch (Exception e) {
			e.printStackTrace();
			throw new OrderException("订单查询失败!");
		}
		
	}
	
}

OrderController 处理“search”请求，在请求处理方法中简单地模拟了一个异常，被捕捉后抛出OrderException自定义异常类型

package org.davieyang.controller;


import java.util.HashMap;
import java.util.Map;
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 GlobalExceptionHandler {

	// 处理Exception类型异常
	@ExceptionHandler(value = Exception.class)
    public ModelAndView globalErrorHandler(Exception e) throws Exception {
		ModelAndView mav = new ModelAndView();
        mav.addObject("ex", e);
        mav.setViewName("error");
        return mav;
    }
	
	// 处理OrderException自定义异常
	@ExceptionHandler(value = OrderException.class)
	@ResponseBody
    public Object OrderErrorHandler(Exception e) throws Exception {
		// 创建返回对象Map并设置属性，会被@ResponseBody注解转换为JSON返回
		Map<String, Object> map = new HashMap<>();
		map.put("code", 100);
		map.put("message", e.getMessage());
		map.put("data", "请求失败");
        return map;
    }
	
}

GlobalExceptionHandler 类使用了@ControllerAdvice 注解来修饰，其会被＜context：component-scan＞扫描，该类中使用 @ExceptionHandler注解修饰的方法将被应用到所有请求处理方法上
GlobalExceptionHandler 类中定义了两个方法：

第一个方法 globalErrorHandler 使用@ExceptionHandler注解修饰时 value=Exception.class表示该方法处理所有Exception类型的异常，处理方式和之前一致，将异常信息对象保存到Model，并返回异常处理页面error.jsp
第二个方法OrderErrorHandler使用@ExceptionHandler注解修饰时，value=OrderException.class表示该方法处理OrderException自定义类型的异常，此处的处理方式和之前不同，这里创建一个Map对象保存信息并返回，由于方法使用了@ResponseBody注解，返回的Map对象会被转成JSON数据

部署ControllerAdviceTest这个Web应用，在浏览器中输入URLhttp://localhost:8080/ControllerAdviceTest/来测试应用
在这里插入图片描述
单击“@ControllerAdvice异常处理”超链接，发送“find”请求，BookController的find（）方法处理请求，抛出异常，异常被 @ControllerAdvice注解修饰的GlobalExceptionHandler类中 @ExceptionHandler（value=Exception.class）注解修饰的 globalErrorHandler方法捕获，处理之后跳转到error.jsp页面
在这里插入图片描述
再次请求index.jsp页面，单击“查询订单(返回JSON)”按钮，发送“search”请求，OrderController的search()方法处理请求，抛出自定义异常OrderException，异常被@ControllerAdvice 注解修饰的 GlobalExceptionHandler 类中 @ExceptionHandler(value=OrderException.class)注解修饰的 OrderErrorHandler方法捕获，返回JSON信息
在这里插入图片描述

@RestControllerAdvice注解

org.springframework.web.bind.annotation.RestController注解本身使用 @ControllerAdvice和@ResponseBody注解。使用了 @RestControllerAdvice注解的类会被看作一个ControllerAdvice，而该类中所有使用@ExceptionHandler注解的方法都默认使用@ResponseBody注解,@RestControllerAdvice注解的源代码如下

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ControllerAdvice
@ResponseBody
public @interface RestControllerAdvice{
	// ......
}

@RestControllerAdvice注解的使用

OrderController和OrderException与上例一致，修改GlobalExceptionHandler如下代码所示：

package org.davieyang.controller;


import java.util.HashMap;
import java.util.Map;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 * @RestController注解本身使用@ControllerAdvicer和@ResponseBody注解。
 * 使用了@RestControllerAdvice注解的类会被看作一个ControllerAdvicer，
 * 而该类中所有使用@ExceptionHandler注解的方法都默认使用了的@ResponseBody注解。
 * */
@RestControllerAdvice
public class GlobalExceptionHandler {
	
	// 处理OrderException自定义异常
	@ExceptionHandler(value = OrderException.class)
    public Object OrderErrorHandler(Exception e) throws Exception {
		// 创建返回对象Map并设置属性，会被@ResponseBody注解转换为JSON返回
		Map<String, Object> map = new HashMap<>();
		map.put("code", 100);
		map.put("message", e.getMessage());
		map.put("data", "请求失败");
        return map;
    }
	
}

GlobalExceptionHandler使用了@RestControllerAdvice注解，该类会被看成一个ControllerAdvice，同时该类中所有使用@ExceptionHandler 注解的方法都默认使用了@ResponseBody注解，OrderErrorHandler方法会将Map集合数据转换成JSON格式并返回客户端,测试结果和ControllerAdviceTest项目的测试结果一致