Spring MVC 项目中使用log4j统一记录异常到日志文件

在之前的文章中有讲过在项目中使用日志的重要性,而且也总结了在Spring框架的Java Web 项目中使用log4j日志框架来记录日志的方法,如果不清楚log4j的使用方法,在阅读本文前可以前往:http://www.jianshu.com/p/6eb61fdfc5dd 进行了解。

1. 不在项目中使用统一的异常处理

一般情况下,我们在项目中遇到的异常可以分为:

  1. 代码进行编译时产生的异常
  2. 项目在实际运行时遇到的异常

对于前者,我们可以在项目的开发阶段时进行定位和解决,但是对于后者,我们要想定位异常,通常都会去服务器(例如Tomcat)的log日志中寻找。但是这种方法并不方便,试想如果你的服务器中部署了多个Web应用程序,那么关于这些应用程序的所有的日志都集中在一起,那么当应用程序出现问题时,寻找起来势必是非常的费力。那么我们可不可以对于某个特定的应用程序,指定一个文件夹来单独存放有关于它的异常错误日志呢?答案当然是肯定的,而且借助于log4j日志框架,我们可以实现这个功能。下面的例子展示了使用log4j来记录异常的方法。(有关于log4j的具体配置请参考:http://www.jianshu.com/p/6eb61fdfc5dd
我们在可能出现异常的地方使用try...catch的方法来抛出和处理异常。
我们可以在Service层类中可能出现异常的地方使用try...catch:
ValidateName.java

package service;
import org.apache.log4j.Logger;
import org.springframework.stereotype.Service;

/** 
* Created by xiangang on 2016/11/25. 
*/

@Service
public class ValidateName {   
  private static final Logger logger = Logger.getLogger(ValidateName.class);    
  public boolean validation(String name) {        
    boolean flag = false;       
    //故意设置为空,以便抛出异常        
    String storedName = null;        

    //使用try..catch        
    try {            
      if (storedName.equals(name)){                
        flag = true;               
        return flag;            
      }else {                
        return flag;            
      }        
    }catch (Exception e){            
      logger.error("错误信息",e);            
      return flag;        
      }    
    }
}

编写对应的JSP页面,编辑log4j的配置文件,在相关的Controller里面调用Service层中的这个方法,配置本地服务器,运行。可以在指定的日志文件里发现程序出错的信息:

程序运行错误日志

通过阅读日志我们可以很清楚的定位程序出错的位置。这样是可以解决我们的问题,但是通过这种方法来输出错误日志时会带来代码冗余,降低代码的可读性,影响程序的执行速度。而且对于有些代码我们在编写的时候并不知道是否会出现异常。试想如果我们要在没有个可能出错的地方使用try...catch语句手动的记录日志,那么一个项目中有这么多的业务逻辑的代码,如此一来,整个项目的代码量势必会增加很多,被这不是一个很好的方法。其实我们通过使用Spring MVC的异常统一处理器就能很好的解决这个问题。

2. 使用Spring MVC的统一异常处理器

Spring MVC定义了异常的统一处理机制,其工作原理是:

Spring MVC统一异常处理流程.png

不管是应用程序的哪里出现异常,都向上层抛出异常,最后异常被提交到Spring MVC的Dispatcher Servlet中,Dispatcher Servlet在调用系统统一的异常处理器来处理异常。

借助Spring MVC的异常处理机制,我们通过实现HandlerExceptionResolver接口来定义我们自己的异常处理器,然后在异常处理器里使用log4j对所有的异常进行统一的处理,这样我们就不需要向上面一样在每个可能出现异常的地方都是用try..catch来记录异常。

实现自己的异常处理器:
MyExceptionHandler.java

package exceptionHandler;

import org.apache.log4j.Logger;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/** 
* Created by xiangang on 2016/11/25. 
*/

public class MyExceptionHandler implements HandlerExceptionResolver {    

  private static final Logger logger = Logger.getLogger(MyExceptionHandler.class);   
 
 /** 
  * 通过实现借口HandlerExceptionResolver的resolveException方法,
  * 来完成日志的记录,而且还可以指定程序发生错误后跳转的web页面
  */
 @Override    
  public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {          
    logger.error("",ex);        
    return new ModelAndView("error").addObject("exception",ex);    
  }
}

在Spring MVC的配置文件里通过bean声明注册到IoC容器,

省略了其他的配置信息
<!--配置自定义异常处理类-->
<bean id="handlerExceptionResolver" class="exceptionHandler.MyExceptionHandler"/>

修改我们Service层中的方法:
ValidateName.java

package service;
import org.apache.log4j.Logger;
import org.springframework.stereotype.Service;

/** 
* Created by xiangang on 2016/11/25. 
*/

@Service
public class ValidateName {   
  private static final Logger logger = Logger.getLogger(ValidateName.class);    
  public boolean validation(String name) {        
    boolean flag = false;       
    //故意设置为空,以便抛出异常        
    String storedName = null;      
  
    if (storedName.equals(name)){                
      flag = true;               
      return flag;            
    }else {                
      return flag;            
    }        
  }
}

配置发生错误时的页面:
error.jsp

<%--  
Created by IntelliJ IDEA.  
User: xiangang  
Date: 2016/11/25  
Time: 下午1:40  
To change this template use File | Settings | File Templates.
--%>

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>    
<title>错误页面!</title>
</head>
<body>
<h1>不好意思,你请求的页面被怪兽吃掉了!</h1>
</body>
</html>

在相关的Controller里面调用Service层中的这个方法,配置本地服务器,运行应用程序,得到如下页面:

出现错误后的跳转页面

对应的日志文件记录的错误日志:

程序运行出现错误的日志

3. 总结

对于异常的统一处理还有其他的方法,本篇文章只是根据作者自己的经历而总结的一种方法,如有不当之处还请指出、见谅。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,679评论 6 342
  • spring官方文档:http://docs.spring.io/spring/docs/current/spri...
    牛马风情阅读 1,635评论 0 3
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,907评论 1 13
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,944评论 0 6