SpringMVC异常处理

系统的 dao、service、controller 出现都通过 throws Exception 向上抛出,最后由 springmvc 前端控制器交由异常处理器进行异常处理,如下图:


SpringMVC异常处理.png

常用的springmvc异常处理方式主要有三种:

  • 使用系统定义好的异常处理器 SimpleMappingExceptionResolver
  • 使用自定义异常处理器
  • 使用异常处理注解

异常处理思路:
Controller调用service,service调用dao,异常都是向上抛出的,最终由DispatcherServlet找异常处理器进行异常的处理。

一、SimpleMappingExceptionResolver异常处理器

该方式只需要在 SpringMVC 配置文件中注册该异常处理器 Bean 即可。该 Bean 比较特殊,没有 id 属性,无需显式调用或被注入给其它,当异常发生时会自动执行该类。

提示:当请求参数的值与接收该参数的处理器方法形参的类型不匹配时,会抛出类型匹
配有误异常 TypeMismatchException。

1.1自定义异常类

定义三个异常类:NameException、AgeException、StudentException。其中 StudentException
是另外两个异常的父类。

StudentException:

public class StudentException extends Exception{
    
    public StudentException(){
        super();
    }
    
    public StudentException(String message){
        super(message);
    }
    
}

NameException:

public class NameException extends StudentException{
    
    public NameException(){
        super();
    }
    
    public NameException(String message){
        super(message);
    }
        
}

AgeException:

public class AgeException extends StudentException{
    
    public AgeException(){
        super();
    }
    
    public AgeException(String message){
        super(message);
    }
        
}

1.2 修改controller

@Controller
@RequestMapping("/test")
public class MyController{
    
    @RequestMapping(value="/register.do")
    public ModelAndView register(String name,int age) throws StudentException{
        
        if(!"张三".equals(name)){
            throw new NameException("姓名不正确");
        }
        
        if(age>50){
            throw new AgeException("年龄太大");
        }
        
        return new ModelAndView("/WEB-INF/jsp/show.jsp");
    }
    
}

1.3注册异常处理器



    
        
            /errors/nameErrors.jsp
            /errors/ageErrors.jsp
        
    
    
    

  • exceptionMappings:Properties 类型属性,用于指定具体的不同类型的异常所对应的异常响应页面。Key 为异常类的全限定性类名,value 则为响应页面路径
  • defaultErrorView:指定默认的异常响应页面。若发生的异常不是 exceptionMappings 中指定的异常,则使用默认异常响应页面。
  • exceptionAttribute:捕获到的异常对象。一般异常响应页面中使用。

1.4定义异常响应页面

在WebRoot下新建一个目录errors,在其中定义三个异常响应页面。

image.png

二、自定义异常处理器

使用 SpringMVC 定义好的 SimpleMappingExceptionResolver 异常处理器,可以实现发生指定异常后的跳转。但若要实现在捕获到指定异常时,执行一些操作的目的,它是完成不了的。此时,就需要自定义异常处理器。自定义异常处理器,需要实现HandlerExceptionResolver接口,并且该类需要在SpringMVC配置文件中进行注册。
demo1:
2.1定义异常处理器

当一个类实现了 HandlerExceptionResolver 接口后,只要有异常发生,无论什么异常,都会自动执行接口方法 resolveException()。

public class MyExceptionResolver implements HandlerExceptionResolver{
    
     public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
         
         ModelAndView mv = new ModelAndView();
         //将异常对象加入数据模型中
         mv.addObject("ex",ex);
         
         //设置默认错误响应页面
         mv.setViewName("/errors/defaultErrors.jsp");
         
         //设置NameException响应页面
         if(ex instanceof NameException){
             mv.setViewName("/errors/nameErrors.jsp");
         }
         
         //设置AgeException响应页面
         if(ex instanceof AgeException){
             mv.setViewName("/errors/ageErrors.jsp");
         }
         return mv;
     }
}

2.2注册异常处理器



当希望在出现异常后,返回json而不是ModelAndView,可以通过response对象的Writer实现

public class MyExceptionHandler implements HandlerExceptionResolver {
  
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,
                                 Exception ex) {

        Json json = new Json();
        json.setSuccess(false);
        json.setMessage("出錯了");

        PrintWriter writer = null;
        try {
            writer = response.getWriter();
            writer.write(new Gson().toJson(json));
        } catch (IOException e) {
            e.printStackTrace();
        }finally {
            if(writer!=null)
            {
                writer.close();
            }
        }
        return null;
    }
}

demo2:
UserException:

@Data
@ToString
@AllArgsConstructor
public class UserException extends Exception{
    private String message;
}

ExceptionResolver:

package com.hcx.exception;

import org.springframework.lang.Nullable;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 异常处理器
 * Created by hongcaixia on 2020/1/3.
 */
public class ExceptionResolver implements HandlerExceptionResolver{

    @Nullable
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, @Nullable Object o, Exception e) {

        //获取异常对象
        UserException userException = null;
        if(e instanceof UserException){
            userException = (UserException) e;
        }else {
            userException = new UserException("系统正在维护");
        }
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("errorMsg",userException.getMessage());
        modelAndView.setViewName("error");
        return modelAndView;
    }
}

springmvc.xml文件中配置异常处理器:

    
    

error.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %>


    error


    ${errorMsg}


页面:

异常处理

三、异常处理注解

使用注解@ExceptionHandler 可以将一个方法指定为异常处理方法。该注解只有一个可选属性 value,为一个 Class数组,用于指定该注解的方法所要处理的异常类,即所要匹配的异常。而被注解的方法,其返回值可以是 ModelAndView、String,或 void,方法名随意,方法参数可以是 Exception 及其子类对象、HttpServletRequest、HttpServletResponse 等。系统会自动为这些方法参数赋值。对于异常处理注解的用法,也可以直接将异常处理方法注解于 Controller 之中。

@Controller
@RequestMapping("/test")
public class MyController {

    @RequestMapping(value="/register.do")
    public ModelAndView register(String name,int age) throws StudentException{
        if(!"张三".equals(name)){
            throw new NameException("姓名不正确");
        }
        return new ModelAndView("/WEB-INF/jsp/show.jsp");
    }
    
    //NameException异常处理
    @ExceptionHandler(NameException.class)
    public ModelAndView handleNameException(Exception ex){
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex",ex);
        mv.setViewName("/errors/nameErrors.jsp");
        return mv;
    }
}

不过,一般不这样使用。而是将异常处理方法专门定义在一个 Controller 中,让其它Controller 继承该 Controller 即可。但是,这种用法的弊端也很明显:Java 是“单继承多实现”的,这个 Controller 的继承将这唯一的一个继承机会使用了,使得若再有其它类需要继承,将无法直接实现。

3.1定义异常处理的controller

@Controller
public class MyExceptionResolver {
    //NameException异常处理
    @RequestHandler(NameException.class)
    public ModelAndView handleNameException(Exception ex){
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex",ex);
        mv.setViewName("/errors/nameErrors.jsp");
        return mv;
    }

    //AgeException异常处理
    @ExceptionHandler(AgeException.class)
    public ModelAndView handleAgeException(Exception ex){
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex",ex);
        mv.setViewName("/errors/ageErrors.jsp");
        return mv;
    }
    
    //其他异常处理
    @ExceptionHandler
    public ModelAndView handleOtherException(Exception ex){
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex",ex);
        mv.setViewName("/errors/defaultErrors.jsp");
        return mv;
    }
    
}

2.修改controller

让普通Controller继承自定义好的异常处理Controller。

@Controller
@RequestMapping("/test")
public class MyController extends MyExceptionResolver{
    
    @RequestMapping(value="/register.do")
    public ModelAndView register(String name,int age) throws StudentException{
        
        if(!"张三".equals(name)){
            throw new NameException("姓名不正确");
        }
        
        if(age>50){
            throw new AgeException("年龄太大");
        }
        
        return new ModelAndView("/WEB-INF/jsp/show.jsp");
    }
}

你可能感兴趣的:(SpringMVC异常处理)