美文网首页程序员
Spring MVC 项目中使用log4j统一记录异常到日志文件

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

作者: xiangang | 来源:发表于2016-11-25 17:10 被阅读3273次

    在之前的文章中有讲过在项目中使用日志的重要性,而且也总结了在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. 总结

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

    相关文章

      网友评论

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

        本文链接:https://www.haomeiwen.com/subject/vixwpttx.html