Spring全局异常处理的三种方式

在J2EE项目的开发中,不管是对底层的数据库操作过程,还是业务层的处理过程,还是控制层的处理过程,都不可避免会遇到各种可预知的、不可预知的异常需要处理。每个过程都单独处理异常,系统的代码耦合度高,工作量大且不好统一,维护的工作量也很大。 那么,能不能将所有类型的异常处理从各处理过程解耦出来,这样既保证了相关处理过程的功能较单一,也实现了异常信息的统一处理和维护?答案是肯定的。下面将介绍使用Spring MVC统一处理异常的解决和实现过程

  • 使用Spring MVC提供的SimpleMappingExceptionResolver
  • 实现Spring的异常处理接口HandlerExceptionResolver 自定义自己的异常处理器
  • 使用@ExceptionHandler注解实现异常处理
    **(一) SimpleMappingExceptionResolver **
    使用这种方式具有集成简单、有良好的扩展性、对已有代码没有入侵性等优点,但该方法仅能获取到异常信息,若在出现异常时,对需要获取除异常以外的数据的情况不适用。
@Configuration
@EnableWebMvc
@ComponentScan(basePackages = {"com.balbala.mvc.web"})
public class WebMVCConfig extends WebMvcConfigurerAdapter{
  @Bean
    public SimpleMappingExceptionResolver simpleMappingExceptionResolver()
    {
        SimpleMappingExceptionResolver b = new SimpleMappingExceptionResolver();
        Properties mappings = new Properties();
        mappings.put("org.springframework.web.servlet.PageNotFound", "page-404");
        mappings.put("org.springframework.dao.DataAccessException", "data-access");
        mappings.put("org.springframework.transaction.TransactionException", "transaction-Failure");
        b.setExceptionMappings(mappings);
        return b;
    }
}

(二) HandlerExceptionResolver
相比第一种来说,HandlerExceptionResolver能准确显示定义的异常处理页面,达到了统一异常处理的目标
1.定义一个类实现HandlerExceptionResolver接口,这次贴一个自己以前的代码

package com.athena.common.handler;
import com.athena.common.constants.ResponseCode;
import com.athena.common.exception.AthenaException;
import com.athena.common.http.RspMsg;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
/** 
  * Created by sam on 15/4/14. 
 */
public class GlobalHandlerExceptionResolver implements HandlerExceptionResolver {   
 private static final Logger LOG = LoggerFactory.getLogger(GlobalHandlerExceptionResolver.class);                 
   /**     
    * 在这里处理所有得异常信息     
    */    
   @Override    
   public ModelAndView resolveException(HttpServletRequest req,                                         HttpServletResponse resp, Object o, Exception ex) {   
       ex.printStackTrace();     
       if (ex instanceof AthenaException) {    
           //AthenaException为一个自定义异常
           ex.printStackTrace();         
           printWrite(ex.toString(), resp);     
           return new ModelAndView();  
        }    
       //RspMsg为一个自定义处理异常信息的类  
       //ResponseCode为一个自定义错误码的接口
       RspMsg unknownException = null;      
       if (ex instanceof NullPointerException) {        
           unknownException = new RspMsg(ResponseCode.CODE_UNKNOWN, "业务判空异常", null);
       } else {          
           unknownException = new RspMsg(ResponseCode.CODE_UNKNOWN, ex.getMessage(), null);        }      
           printWrite(unknownException.toString(), resp);   
           return new ModelAndView();   
   }  

   /**     
   * 将错误信息添加到response中     
   *     
   * @param msg     
   * @param response     
   * @throws IOException     
   */   
    public static void printWrite(String msg, HttpServletResponse response) {      
         try {           
             PrintWriter pw = response.getWriter();        
             pw.write(msg);       
             pw.flush();       
             pw.close();      
          } catch (Exception e) {          
             e.printStackTrace();      
          }   
    }
}

2.加入spring的配置中,这里只贴出了相关部分


import com.athena.common.handler.GlobalHandlerExceptionResolver;
import org.springframework.context.annotation.Bean;
import com.athena.common.handler.GlobalHandlerExceptionResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
/** 
  * Created by sam on 15/4/14. 
 */
public class WebSpringMvcConfig extends WebMvcConfigurerAdapter {

    @Bean
   public GlobalHandlerExceptionResolver globalHandlerExceptionResolver() {
      return new GlobalHandlerExceptionResolver();
   }
}

(三)@ExceptionHandler
这是笔者现在项目的使用方式,这里也仅贴出了相关部分
1.首先定义一个父类,实现一些基础的方法

package com.balabala.poet.base.spring;
import com.google.common.base.Throwables;
import com.raiyee.poet.base.exception.MessageException;
import com.raiyee.poet.base.utils.Ajax;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Date;

public class BaseGlobalExceptionHandler {    
     protected static final Logger logger = null;   
     protected static final String DEFAULT_ERROR_MESSAGE = "系统忙,请稍后再试"; 
   
     protected ModelAndView handleError(HttpServletRequest req, HttpServletResponse rsp, Exception e, String viewName, HttpStatus status) throws Exception {    
         if (AnnotationUtils.findAnnotation(e.getClass(), ResponseStatus.class) != null)       
         throw e;     
         String errorMsg = e instanceof MessageException ? e.getMessage() : DEFAULT_ERROR_MESSAGE;        
         String errorStack = Throwables.getStackTraceAsString(e);   
        
         getLogger().error("Request: {} raised {}", req.getRequestURI(), errorStack);       
         if (Ajax.isAjax(req)) {        
              return handleAjaxError(rsp, errorMsg, status);   
         }        
         return handleViewError(req.getRequestURL().toString(), errorStack, errorMsg, viewName);  
     }   
 
     protected ModelAndView handleViewError(String url, String errorStack, String errorMessage, String viewName) {        
          ModelAndView mav = new ModelAndView();       
          mav.addObject("exception", errorStack);        
          mav.addObject("url", url);     
          mav.addObject("message", errorMessage);  
          mav.addObject("timestamp", new Date());        
          mav.setViewName(viewName);    
          return mav;   
       }    
 
     protected ModelAndView handleAjaxError(HttpServletResponse rsp, String errorMessage, HttpStatus status) throws IOException {        
            rsp.setCharacterEncoding("UTF-8");       
            rsp.setStatus(status.value());      
            PrintWriter writer = rsp.getWriter();
            writer.write(errorMessage);        
            writer.flush();        
            return null;    
      }    

     public Logger getLogger() {       
           return LoggerFactory.getLogger(BaseGlobalExceptionHandler.class);
     } 
}

2.针对你需要捕捉的异常实现相对应的处理方式

package com.balabala.poet.base.spring;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.NoHandlerFoundException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@ControllerAdvice
public class GlobalExceptionHandler extends BaseGlobalExceptionHandler {    
      
      //比如404的异常就会被这个方法捕获
      @ExceptionHandler(NoHandlerFoundException.class)    
      @ResponseStatus(HttpStatus.NOT_FOUND)    
       public ModelAndView handle404Error(HttpServletRequest req, HttpServletResponse rsp, Exception e) throws Exception {    
             return handleError(req, rsp, e, "error-front", HttpStatus.NOT_FOUND);    
       }    
      
      //500的异常会被这个方法捕获
      @ExceptionHandler(Exception.class)      
      @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) 
      public ModelAndView handleError(HttpServletRequest req, HttpServletResponse rsp, Exception e) throws Exception { 
             return handleError(req, rsp, e, "error-front", HttpStatus.INTERNAL_SERVER_ERROR);  
      }    
    
     //TODO  你也可以再写一个方法来捕获你的自定义异常
     //TRY NOW!!!

      @Override    
      public Logger getLogger() {      
            return LoggerFactory.getLogger(GlobalExceptionHandler.class);    
      }

  }

以上就三种处理方式,希望对大家有点帮助~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,050评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,184评论 6 345
  • (转载) 原文连接 1 描述 在J2EE项目的开发中,不管是对底层的数据库操作过程,还是业务层的处理过程,还是控制...
    zjk_00阅读 1,805评论 0 8
  • 回忆拉长了缠绵却断了肠 深夜成了买醉的惆怅 在这一场沾不到边的战役 我输给了你影子的把戏 想着花开之时花却依旧不动...
    一只有野心的狐狸阅读 182评论 0 0
  • 我想透过叶与叶之间的缝隙 找到你 嘴角微微上扬 参杂着淡秋的金色 渲染你 在我心中的芳香 宁静的湖水如那远遁的...
    湖雨阅读 657评论 60 66