SpringBoot拦截器实现对404和500等错误的拦截

今天给大家介绍一下SpringBoot中拦截器的用法,相比Struts2中的拦截器,SpringBoot的拦截器就显得更加方便简单了。

只需要写几个实现类就可以轻轻松松实现拦截器的功能了,而且不需要配置任何多余的信息,对程序员来说简直是一种福利啊。

废话不多说,下面开始介绍拦截器的实现过程:

第一步:创建我们自己的拦截器类并实现 HandlerInterceptor 接口。

package example.Interceptor; 
import javax.servlet.http.HttpServletRequest; 
import javax.servlet.http.HttpServletResponse; 
import org.springframework.stereotype.Controller; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.servlet.HandlerInterceptor; 
import org.springframework.web.servlet.ModelAndView; 
 
/** 
 * 自定义拦截器1 
 * 
 * @author  林志强(208017534) 
 * @create  2016年9月20日 
 */ 
@Controller 
public class ErrorInterceptor implements HandlerInterceptor { 
 
  /** 
   * preHandle方法是进行处理器拦截用的,顾名思义,该方法将在Controller处理之前进行调用,SpringMVC中的Interceptor拦截器是链式的,可以同时存在 
   * 多个Interceptor,然后SpringMVC会根据声明的前后顺序一个接一个的执行,而且所有的Interceptor中的preHandle方法都会在 
   * Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的,这种中断方式是令preHandle的返 
   * 回值为false,当preHandle的返回值为false的时候整个请求就结束了。 
   */  
  @Override 
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 
      throws Exception { 
    System.out.println(">>>MyInterceptor1>>>>>>>在请求处理之前进行调用(Controller方法调用之前)"); 
    return true;// 只有返回true才会继续向下执行,返回false取消当前请求 
  } 
 
  /** 
   * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的,它的执行时间是在处理器进行处理之 
   * 后,也就是在Controller的方法调用之后执行,但是它会在DispatcherServlet进行视图的渲染之前执行,也就是说在这个方法中你可以对ModelAndView进行操 
   * 作。这个方法的链式结构跟正常访问的方向是相反的,也就是说先声明的Interceptor拦截器该方法反而会后调用,这跟Struts2里面的拦截器的执行过程有点像, 
   * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法,Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor 
   * 或者是调用action,然后要在Interceptor之前调用的内容都写在调用invoke之前,要在Interceptor之后调用的内容都写在调用invoke方法之后。 
   */  
  @Override 
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, 
              ModelAndView modelAndView) throws Exception { 
    System.out.println(">>>MyInterceptor1>>>>>>>请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之后)"); 
    if(response.getStatus()==500){ 
      modelAndView.setViewName("/errorpage/500"); 
    }else if(response.getStatus()==404){ 
      modelAndView.setViewName("/errorpage/404"); 
    } 
  } 
 
  /** 
   * 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后,也就是DispatcherServlet渲染了视图执行, 
   * 这个方法的主要作用是用于清理资源的,当然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。 
   */  
  @Override 
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) 
      throws Exception { 
    System.out.println(">>>MyInterceptor1>>>>>>>在整个请求结束之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)"); 
  } 
} 

拦截器实现类中几个函数的作用,以及调用的先后顺序都很明确,我这里就不多介绍了。

第二部:创建一个Java类继承WebMvcConfigurerAdapter,并重写 addInterceptors 方法。实例化我们自定义的拦截器,然后将对像手动添加到拦截器链中(在addInterceptors方法中添加)。

package example.configuration; 
import example.Interceptor.ErrorInterceptor; 
import example.Interceptor.MyInterceptor2; 
import org.springframework.context.annotation.Configuration; 
import org.springframework.web.servlet.config.annotation.InterceptorRegistry; 
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; 
@Configuration 
public class MyWebAppConfigurer extends WebMvcConfigurerAdapter { 
  @Override 
  public void addInterceptors(InterceptorRegistry registry) { 
    // 多个拦截器组成一个拦截器链 
    // addPathPatterns 用于添加拦截规则 
    // excludePathPatterns 用户排除拦截 
    registry.addInterceptor(new ErrorInterceptor()).addPathPatterns("/**"); 
    super.addInterceptors(registry); 
  } 
 
} 

到这里拦截器就基本实现了,我上面给出的例子中是可以实现对404或者500的拦截。

不过需要注意的是,这种拦截有时候也会出现特别大问题。例如一个网页中如果需要加载很多的图片或者js文件资源,可是正好没有这个资源,也就是找不到这么多个资源报一堆的404错误。这个时候如果还是单纯的使用这种拦截就会出现null指针异常的情况。

针对这种情况,我研究了一种方法可以解决这样类似的问题。

解决方案就是:创建一个类并实现ErrorController接口,这样就可以利用这个类来处理上面发生的问题了。

下面给出代码:

package example.controller; 
import org.springframework.boot.autoconfigure.web.ErrorController; 
import org.springframework.stereotype.Controller; 
import org.springframework.web.bind.annotation.RequestMapping; 
@Controller 
public class MainsiteErrorController implements ErrorController { 
  private static final String ERROR_PATH = "/error"; 
  @RequestMapping(value=ERROR_PATH) 
  public String handleError(){ 
    return "errorpage/error"; 
  } 
  @Override 
  public String getErrorPath() { 
    return ERROR_PATH; 
  } 
} 

这样就可以实现对404,500等错误信息的拦截了,而且也不会发生那种空指针异常的情况了,是不是特别方便啊!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持编程小技巧。

代码技巧

转载请关注公众号:代码技巧 回复:授权

本文链接地址:https://www.oudahe.com/p/54457/