SpringBoot優(yōu)雅捕捉異常的兩種方法小結(jié)

更新時(shí)間：2024年08月09日 09:34:16 作者：wx59bcc77095d22

SpringBoot框架對(duì)異常的處理提供了幾種很強(qiáng)大的方法,我們可以通過(guò)@ControllerAdvice和@ExceptionHandler注解實(shí)現(xiàn)全局異常的處理,下面就來(lái)介紹一下這兩種方法的實(shí)現(xiàn),感興趣的可以了解一下

一、前言

SpringBoot框架對(duì)異常的處理提供了幾種很強(qiáng)大的方法，我們可以通過(guò)@ControllerAdvice和@ExceptionHandler注解實(shí)現(xiàn)全局異常的處理，也可以通過(guò)實(shí)現(xiàn)HandlerExceptionResolve接口來(lái)完成全局異常的處理。

二、全局異常處理方式一

通過(guò)@ControllerAdvice和@ExceptionHandler注解實(shí)現(xiàn)全局異常攔截，它可以攔截controller層請(qǐng)求方法拋出的異常信息，同時(shí)外加@ ResponseBody注解，可以實(shí)現(xiàn)響應(yīng)類型為json格式。或者直接使用@RestControllerAdvice和@ExceptionHandler注解的方式實(shí)現(xiàn)響應(yīng)類型為json格式的數(shù)據(jù)。

1.添加依賴

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

2.自定義異常類

package com.example.dataproject.exception;

/**
 * @author qx
 * @date 2024/8/8
 * @des 自定義異常
 */
public class ServiceException extends RuntimeException {

    private Integer code;

    public Integer getCode() {
        return code;
    }

    public ServiceException(String message, Integer code) {
        super(message);
        this.code = code;
    }
}

3.全局異常處理類

包含對(duì)自定義異常和空指針異常的處理。

package com.example.dataproject.exception;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

/**
 * @author qx
 * @date 2024/8/8
 * @des 全局異常處理類
 */
@RestControllerAdvice
@Slf4j
public class GlobalException {


    @ExceptionHandler(value = {Exception.class})
    public Map<String, Object> exceptionHandler(HttpServletRequest request, Exception e) {
        log.info("未知異常,請(qǐng)求地址:{},錯(cuò)誤信息:{}", request.getRequestURI(), e.getMessage());
        Map<String, Object> map = new HashMap<>();
        map.put("code", 999);
        map.put("message", e.getMessage());
        return map;
    }

    @ExceptionHandler(value = {ServiceException.class})
    public Map<String, Object> serviceExceptionHandler(HttpServletRequest request, ServiceException e) {
        log.info("自定義異常,請(qǐng)求地址:{},錯(cuò)誤信息:{}", request.getRequestURI(), e.getMessage());
        Map<String, Object> map = new HashMap<>();
        map.put("code", e.getCode());
        map.put("message", e.getMessage());
        return map;
    }

    @ExceptionHandler(value = {NullPointerException.class})
    public Map<String, Object> nullPointExceptionHandler(HttpServletRequest request, NullPointerException e) {
        log.info("空指針異常,請(qǐng)求地址:{},錯(cuò)誤信息:{}", request.getRequestURI(), e.getMessage());
        Map<String, Object> map = new HashMap<>();
        map.put("code", 500);
        map.put("message", e.getMessage());
        return map;
    }

}

4.創(chuàng)建控制層測(cè)試

package com.example.dataproject.controller;

import com.example.dataproject.exception.ServiceException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author qx
 * @date 2024/8/8
 * @des 測(cè)試
 */
@RestController
public class IndexController {


    @GetMapping("/null")
    public String testNull() {
        String s = null;
        //拋出空指針異常 全局異常中的空指針異常處理會(huì)捕獲到這個(gè)異常
        if (true) {
            throw new NullPointerException("空指針異常");
        }
        return "null success";
    }

    @GetMapping("/service")
    public String testService() {
        if (true) {
            //拋出自定義異常 全局異常中的自定義異常處理會(huì)捕獲到這個(gè)異常
            throw new ServiceException("自定義服務(wù)異常", 888);
        }
        return "service success";
    }

    @GetMapping("/exception")
    public String testException() {
        if (true) {
            throw new RuntimeException("其他異常");
        }
        return "exception success";
    }

}

5.啟動(dòng)程序并訪問(wèn)請(qǐng)求進(jìn)行測(cè)試

測(cè)試空指針異常

測(cè)試自定義服務(wù)異常

其他異常

6.404異常特殊處理

默認(rèn)情況下，@ExceptionHandler注解無(wú)法捕捉到 404 異常，比如請(qǐng)求一個(gè)無(wú)效的地址，返回信息如下：

如果想要捕捉到這種異常，可以在application.properties文件中添加如下配置來(lái)實(shí)現(xiàn)。

# 如果沒(méi)有找到請(qǐng)求地址，拋異常
spring.mvc.throw-exception-if-no-handler-found=true
# 關(guān)閉默認(rèn)的靜態(tài)資源路徑映射
spring.web.resources.add-mappings=false

啟動(dòng)服務(wù)，再次發(fā)起地址請(qǐng)求，結(jié)果如下:

7.自定義異常頁(yè)面的實(shí)現(xiàn)

某些場(chǎng)景下，當(dāng)發(fā)生異常時(shí)希望跳轉(zhuǎn)到自定義的異常頁(yè)面，如何實(shí)現(xiàn)呢？

首先，這里基于thymeleaf模板引擎來(lái)開(kāi)發(fā)頁(yè)面，在templates目錄下創(chuàng)建一個(gè)異常頁(yè)面error.html。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>錯(cuò)誤</title>
</head>
<body>
出錯(cuò)啦，請(qǐng)與管理員聯(lián)系<br>
錯(cuò)誤詳情:<span th:text="${message}"></span>
</body>
</html>

我們重新修改一下全局異常處理類，讓異常返回結(jié)果到頁(yè)面中。

package com.example.dataproject.exception;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

/**
 * @author qx
 * @date 2024/8/8
 * @des 全局異常處理類
 */
@ControllerAdvice
@Slf4j
public class GlobalException {


    @ExceptionHandler(value = {Exception.class})
    public ModelAndView exceptionHandler(HttpServletRequest request, Exception e) {
        log.info("未知異常,請(qǐng)求地址:{},錯(cuò)誤信息:{}", request.getRequestURI(), e.getMessage());
      /*  Map<String, Object> map = new HashMap<>();
        map.put("code", 999);
        map.put("message", e.getMessage());
        return map;*/
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("error");
        modelAndView.addObject("message", e.getMessage());
        return modelAndView;
    }

    @ExceptionHandler(value = {ServiceException.class})
    @ResponseBody
    public Map<String, Object> serviceExceptionHandler(HttpServletRequest request, ServiceException e) {
        log.info("自定義異常,請(qǐng)求地址:{},錯(cuò)誤信息:{}", request.getRequestURI(), e.getMessage());
        Map<String, Object> map = new HashMap<>();
        map.put("code", e.getCode());
        map.put("message", e.getMessage());
        return map;
    }

    @ExceptionHandler(value = {NullPointerException.class})
    @ResponseBody
    public Map<String, Object> nullPointExceptionHandler(HttpServletRequest request, NullPointerException e) {
        log.info("空指針異常,請(qǐng)求地址:{},錯(cuò)誤信息:{}", request.getRequestURI(), e.getMessage());
        Map<String, Object> map = new HashMap<>();
        map.put("code", 500);
        map.put("message", e.getMessage());
        return map;
    }

}

我們重新請(qǐng)求剛才不存在的訪問(wèn)時(shí)，這個(gè)時(shí)候跳轉(zhuǎn)到了頁(yè)面，并在頁(yè)面中顯示了異常的信息。

三、全局異常處理方式二

在 Spring Boot 中，除了通過(guò)@ControllerAdvice和@ExceptionHandler注解實(shí)現(xiàn)全局異常處理外，還有一種通過(guò)實(shí)現(xiàn)HandlerExceptionResolver接口來(lái)完成全局異常的處理。

具體實(shí)現(xiàn)示例如下：

package com.example.dataproject.exception;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.json.MappingJackson2JsonView;

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

/**
 * @author qx
 * @date 2024/8/8
 * @des 全局異常處理
 */
@Component
@Slf4j
public class GlobalExceptionResolver implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception e) {
        log.error("接口請(qǐng)求出現(xiàn)異常，請(qǐng)求地址：{}，錯(cuò)誤信息：{}", request.getRequestURI(), e.getMessage());
        if (e instanceof NullPointerException) {
            // 設(shè)置響應(yīng)類型為json格式
            ModelAndView mv = new ModelAndView(new MappingJackson2JsonView());
            mv.addObject("code", 500);
            mv.addObject("msg", e.getMessage());
            return mv;
        } else {
            // 設(shè)置響應(yīng)類型為錯(cuò)誤頁(yè)面
            ModelAndView mv = new ModelAndView();
            mv.addObject("message", e.getMessage());
            mv.setViewName("error");
            return mv;
        }
    }
}

如果是空指針異常的話會(huì)返回json數(shù)據(jù)格式，如果是其他異常會(huì)在頁(yè)面上顯示異常的信息。

其他異常

空指針異常

雖然這種方式能夠處理全局異常，但是 Spring 官方不推薦使用它；同時(shí)實(shí)測(cè)過(guò)程中發(fā)現(xiàn)它無(wú)法攔截 404 錯(cuò)誤，當(dāng)請(qǐng)求錯(cuò)誤地址時(shí)，會(huì)優(yōu)先被DefaultHandlerExceptionResolver默認(rèn)異常處理類攔截，自定義的異常處理類無(wú)法捕捉。

到此這篇關(guān)于SpringBoot優(yōu)雅捕捉異常的兩種方法小結(jié)的文章就介紹到這了,更多相關(guān)SpringBoot 捕捉異常內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: