SpringBoot从小白到精通(十一)统一异常处理-阿里云开发者社区

开发者社区> 章为忠学架构> 正文

SpringBoot从小白到精通(十一)统一异常处理

简介: 如何在SpringBoot应用中使用统一异常处理。如何实现对异常数据与正常的业务数据统一以json形式返回?
+关注继续查看

前面介绍了Spring Boot 如何整合定时任务已经Spring Boot 如何创建异步任务和定时任务。

接下来主要讲解如何在SpringBoot应用中使用统一异常处理。如何实现对异常数据与正常的业务数据统一以json形式返回?

 

一、为什么要统一异常处理

当前我们项目架构基本上都是前后端分离的模式,采用Restful接口形式协议开发,前台不管任何业务逻辑,只是接受现实数据。但是如果后台发生异常像数据库异常、权限问题、Redis缓存异常、业务处理错误等各种异常时,前端通常会显示一个非常难看的错误页面。这对于用户来说非常不友好,也影响业务的正常进行。所以我们需要对各种系统异常进行统一处理,然后返回我们想要的结果。

image.png

 

 

二、如何实现统一异常处理

Spring Boot 实现统一异常处理的方法主要有以下两种:

第一种:使用@ControllerAdvice和@ExceptionHandler注解

第二种:使用ErrorController类来实现。

使用ErrorController的方式比较简单,这里就不介绍了。今天主要就讲讲如何使用@ControllerAdvice和@ExceptionHandler注解的方式实现统一异常处理。

1.统一异常处理类

package com.weiz.exception;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;
import com.weiz.utils.JSONResult;
@ControllerAdvice
public class GlobalExceptionHandler  {
    public static final String ERROR_VIEW = "error";
    @ExceptionHandler(value = Exception.class)
    public Object errorHandler(HttpServletRequest reqest, 
            HttpServletResponse response, Exception e) throws Exception {
        
        e.printStackTrace();
        // 是否ajax请求
        if (isAjax(reqest)) {
            return JSONResult.errorException(e.getMessage());
        } else {
            ModelAndView mav = new ModelAndView();
            mav.addObject("exception", e);
            mav.addObject("url", reqest.getRequestURL());
            mav.setViewName(ERROR_VIEW);
            return mav;
        }
    }
   
    public static boolean isAjax(HttpServletRequest httpRequest){
        return  (httpRequest.getHeader("X-Requested-With") != null  
                    && "XMLHttpRequest"
                        .equals( httpRequest.getHeader("X-Requested-With")) );
    }
}

说明:

  1、注解@ControllerAdvice表示这是一个控制器增强类,当控制器发生异常就会被此拦截器被拦截。

  2、注解@ExceptionHandler 定义拦截的异常类,可以获取抛出的异常信息。这里可以定义多个拦截方法,拦截不同的异常类,并且可以获取抛出的异常信息,自由度更大。

 

2. 错误页面

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8" />
    <title>捕获全局异常</title>
</head>
<body>
    <h1 style="color: red">发生错误:</h1>
    <div th:text="${url}"></div>
    <div th:text="${exception.message}"></div>
</body>
</html>

说明:这里用的是thymeleaf 模板,这个之前介绍过:《SpringBoot入门系列(四)整合模板引擎Thymeleaf

 

3. 测试类

创建一个测试异常的controller

package com.weiz.controller;
import com.weiz.utils.JSONResult;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequestMapping("err")
public class ErrorController {
    @RequestMapping("/error")
    public String error() {
        
        int a = 1 / 0;
        
        return "thymeleaf/error";
    }
    
    @RequestMapping("/ajaxerror")
    public String ajaxerror() {
        
        return "thymeleaf/ajaxerror";
    }
    
    @RequestMapping("/getAjaxerror")
    @ResponseBody
    public JSONResult getAjaxerror() {
        
        int a = 1 / 0;
        
        return JSONResult.ok();
    }
}

 

三、验证测试

在浏览器中输入:http://localhost:8088/err/error

image.png

我们看到,发生错误之后,系统捕获到异常并自动跳转到之前设置的错误页面。

 

 最后

以上,就把Spring Boot统一异常处理讲完了。这里只介绍了使用@ControllerAdvice注解实现异常处理的方法,还有ErrorController的实现方式,大家可以去了解。

注解@ControllerAdvice方式只能处理控制器抛出的异常,而类ErrorController方式可以处理所有的异常,包括未进入控制器的错误,比如404,401等错误。



推荐阅读:

SpringBoot从小白到精通(十)使用Interceptor拦截器,一学就会!

SpringBoot从小白到精通(九)使用@Async实现异步执行任务

SpringBoot从小白到精通(八)熟悉@EnableScheduling,一秒搞定定时任务

SpringBoot从小白到精通(七)使用Redis实现高速缓存架构

SpringBoot从小白到精通(六)使用Mybatis实现增删改查【附详细步骤】

SpringBoot从小白到精通(五)Thymeleaf的语法及常用标签

SpringBoot从小白到精通(四)Thymeleaf页面模板引擎

SpringBoot从小白到精通(三)系统配置及自定义配置

SpringBoot从小白到精通(二)如何返回统一的数据格式

SpringBoot从小白到精通(一)如何快速创建SpringBoot项目

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
基于spring注解AOP的异常处理
一、前言   项目刚刚开发的时候,并没有做好充足的准备。开发到一定程度的时候才会想到还有一些问题没有解决。就比如今天我要说的一个问题:异常的处理。写程序的时候一般都会通过try...catch...finally对异常进行处理,但是我们真的能在写程序的时候处理掉所有可能发生的异常吗? 以及发生异常的时候执行什么逻辑,返回什么提示信息,跳转到什么页面,这些都是要考虑到的。
826 0
Mono For Android安装后报参数空异常!
安装完mono for android 4.2.5后,启动vs2010,显示一个错误对话框,内容是: There was an error attempting to initialize the MonoAndroidPackage: System.ArgumentNullException: 值不能为null。
626 0
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
7744 0
Spring MVC 之请求处理方法可接收参数(三)
请求处理方法可接收参数 今天学习了前三个方法。   1、作用域对象2、单个表单提交数据3、表单数据封装的Bean对象 首先创建一个实体对象。 1 package com.cy.springannotation.
592 0
Spring-Aop处理记录日志
AOP的几种通知类型: 1,前置通知(Before advice):在某连接点(JoinPoint)之前执行的通知,但这个通知不能阻止连接点前的执行 配置文件中使用 &lt;aop:before&gt;进行声明 注解使用 @Before 进行声明 2,后置通知(After advice):当某连接点退出的时候执行的通知(不论是正常返回还是异常退出)。
2455 0
SpringBoot-08-之统一化json输出与自定义异常捕获
为及时了解异常,以及避免返回的json格式不统,将每次请求的结果都返还一样的形式。 此处统一为:{"code":响应代号码,"msg":信息,"data":数据} 具体效果如下: result--format.
1262 0
+关注
章为忠学架构
获取源码、资料,请关注我的微信公众号(架构师精进)
67
文章
2
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载