SpringMVC全局異常處理小結(jié)

更新時(shí)間：2024年03月29日 14:26:29 作者：周大福ye

在開(kāi)發(fā)中,不管是dao層、service層還是controller層,都有可能拋出異常,在springmvc中,能將所有類(lèi)型的異常處理從各處理過(guò)程解耦出來(lái),既保證了相關(guān)處理過(guò)程的功能較單一,也實(shí)現(xiàn)了異常信息的統(tǒng)一處理和維護(hù),本文介紹SpringMVC全局異常處理,感興趣的朋友一起看看吧

一、為什么要全局異常處理？

我們知道，系統(tǒng)中異常包括：編譯時(shí)異常和運(yùn)行時(shí)異常RuntimeException，前者通過(guò)捕獲異常從而獲取異常信息，后者主要通過(guò)規(guī)范代碼開(kāi)發(fā)、測(cè)試通過(guò)手段減少運(yùn)行時(shí)異常的發(fā)生。在開(kāi)發(fā)中，不管是dao層、service層還是controller層，都有可能拋出異常，在springmvc中，能將所有類(lèi)型的異常處理從各處理過(guò)程解耦出來(lái)，既保證了相關(guān)處理過(guò)程的功能較單一，也實(shí)現(xiàn)了異常信息的統(tǒng)一處理和維護(hù)。

二、異常處理思路（參考下圖）

三、SpringMVC異常分類(lèi)

1）使用Spring MVC提供的簡(jiǎn)單異常處理器SimpleMappingExceptionResolver；
2）實(shí)現(xiàn)Spring的異常處理接口HandlerExceptionResolver自定義自己的異常處理器；
3）使用@ControllerAdvice + @ExceptionHandler

四、綜合案例

1、首先創(chuàng)建一個(gè)error頁(yè)面，為方便后面異常處理操作

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<h1>
    系統(tǒng)錯(cuò)誤，請(qǐng)聯(lián)系管理員??！
</h1>
${msg}
</body>
</html>

4.1 SpringMVC自帶的簡(jiǎn)單異常處理器

SpringMVC中自帶了一個(gè)異常處理器叫SimpleMappingExceptionResolver，該處理器實(shí)現(xiàn)了HandlerExceptionResolver 接口，全局異常處理器都需要實(shí)現(xiàn)該接口

1）配置SpringMVC簡(jiǎn)單異常處理器

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
       <!-- 定義默認(rèn)的異常處理頁(yè)面 -->
       <property name="defaultErrorView" value="error"/>
       <!-- 定義異常處理頁(yè)面用來(lái)獲取異常信息的變量名，也可不定義，默認(rèn)名為exception --> 
       <property name="exceptionAttribute" value="ex"/>
       <!-- 定義需要特殊處理的異常，這是重要點(diǎn) --> 
       <property name="exceptionMappings">
           <props> <!--異常類(lèi)型 錯(cuò)誤視圖-->       
               <prop key="java.lang.RuntimeException">error</prop>
           </props>
           <!-- 還可以定義其他的自定義異常 -->
       </property>
   </bean>

2）方法中拋出此異常

 /**
     * 返回實(shí)體類(lèi)的JSON數(shù)據(jù)
     * @param bookId
     * @return
     */
   @RequestMapping("/querySingleBook")
   @ResponseBody
   public Book querySingleBook(Integer bookId){
       Book book = bookService.selectByPrimaryKey(bookId);
       book.setCreatedate(new Date());
       //此處只是為了進(jìn)行案例演示
       if(bookId<100){
           throw new RuntimeException("查詢(xún)的書(shū)本編號(hào)小于100，異常拋出??！");
       }
       return book;
   }

3）頁(yè)面效果

4.2 通過(guò)HandlerExceptionResovler接口實(shí)現(xiàn)全局異常

注：
1）通過(guò)instanceof判斷異常類(lèi)型
2）通過(guò)設(shè)置mv.setView(new MappingJackson2JsonView())方式返回JSON數(shù)據(jù)；

1）通過(guò)HandlerExceptionResovler接口實(shí)現(xiàn)全局異常處理器

package com.zking.ssm.book.exception;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
 * SpingMVC提供的第二種全局異常處理方式  ,實(shí)現(xiàn)HandlerExceptionResolver接口
 */
@Component
public class GlobalException implements HandlerExceptionResolver {
    /**
     *
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o 異常處理的目標(biāo)
     * @param e 異常處理的類(lèi)型
     * @return
     */
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) {
        ModelAndView mv=new ModelAndView();
        mv.setViewName("error");
        //判斷異常的分類(lèi)
        if(e instanceof RuntimeException){
                RuntimeException ex=(RuntimeException)e;
                System.out.println(ex.getMessage());
                mv.addObject("msg",ex.getMessage());
        }
        return mv;
    }
}

2）創(chuàng)建異常類(lèi)

package com.zking.ssm.book.exception;
public class BusinessException extends RuntimeException {
    public BusinessException() {
    }
    public BusinessException(String message) {
        super(message);
    }
    public BusinessException(String message, Throwable cause) {
        super(message, cause);
    }
    public BusinessException(Throwable cause) {
        super(cause);
    }
}

@RequestMapping("/querySingleBook")
    @ResponseBody
    public Book querySingleBook(Integer bookId){
        Book book = bookService.selectByPrimaryKey(bookId);
        if(bookId>100)
            throw new BusinessException("書(shū)本編號(hào)小于100,異常拋出?。。?);
        book.setDate(new Date());
        return book;
    }

3）頁(yè)面效果

4.3 使用@ControllerAdvice+@ExceptionHandler實(shí)現(xiàn)全局異常

1）創(chuàng)建全局異常處理器

package com.zking.ssm.book.exception;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.json.MappingJackson2JsonView;
import java.util.HashMap;
import java.util.Map;
/**
 * SpingMVC提供的第三種種全局異常處理方式
 * 1）@ControllerAdvice +@ExceptionHandler
 * 2）@RestControllerAdvice +@ExceptionHandler
 *      @RestControllerAdvice ==@Controller +@ResponseBody 返回JSON的數(shù)據(jù)格式，繞開(kāi)視圖解析器
 */
@ControllerAdvice
public class GlobalException2{
        @ExceptionHandler
        public ModelAndView exceptionHandler(Exception e){
            ModelAndView mv=new ModelAndView();
            //設(shè)置錯(cuò)誤頁(yè)面
            mv.setViewName("error");
            //判斷異常類(lèi)型
            if(e instanceof BusinessException){
            BusinessException ex=(BusinessException)e;
                mv.addObject("msg","系統(tǒng)繁忙，請(qǐng)稍后再試.......");
            }
            mv.setView(new MappingJackson2JsonView());
            return mv;
        }
}

2）頁(yè)面效果

3)返回異常信息和狀態(tài)碼、返回JSON數(shù)據(jù)格式

package com.zking.ssm.book.exception;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.json.MappingJackson2JsonView;
import java.util.HashMap;
import java.util.Map;
/**
 * SpingMVC提供的第三種種全局異常處理方式
 * 1）@ControllerAdvice +@ExceptionHandler
 * 2）@RestControllerAdvice +@ExceptionHandler
 *      @RestControllerAdvice ==@Controller +@ResponseBody 返回JSON的數(shù)據(jù)格式，繞開(kāi)視圖解析器
 */
@RestControllerAdvice
public class GlobalException2{
        @ExceptionHandler
        public Map<String, Object> exceptionHandler(Exception e){
            Map<String, Object> json=new HashMap();
            //判斷異常類(lèi)型
            if(e instanceof BusinessException){
                json.put("msg","系統(tǒng)繁忙，請(qǐng)稍后再試.......");
                json.put("code",500);
            }
            return json;
        }
}

4）頁(yè)面效果