快捷導(dǎo)航

在Spring?MVC中使用@ControllerAdvice創(chuàng)建全局異常處理器的方法

更新時間：2023年08月07日 10:34:01 作者：加辣椒了嗎?

在Spring?MVC中,可以使用@ControllerAdvice或@RestControllerAdvice注解來定義全局異常處理器類,并使用?@ExceptionHandler注解來定義處理特定異常的方法,本文就給大家介紹了Spring?MVC?@ControllerAdvice創(chuàng)建處理器的方法,需要的朋友可以參考下

前言

全局異常處理器是一種機(jī)制，用于處理應(yīng)用程序中發(fā)生的異常，無論這些異常在哪個部分發(fā)生。它可以攔截和處理整個應(yīng)用程序范圍內(nèi)的異常，從而實現(xiàn)統(tǒng)一的異常處理邏輯。

在一個應(yīng)用程序中，可能會有多個控制器處理不同的請求。當(dāng)這些控制器中拋出異常時，可以使用全局異常處理器來捕獲和處理這些異常，而不是在每個控制器中單獨(dú)處理。

全局異常處理器通常在應(yīng)用程序的頂層進(jìn)行定義，以確保能夠攔截所有的異常。它可以捕獲和處理各種類型的異常，包括應(yīng)用程序自定義的異常、系統(tǒng)異常和未處理的異常。

使用全局異常處理器的好處包括：

統(tǒng)一異常處理：全局異常處理器可以集中處理所有控制器中出現(xiàn)的異常，避免重復(fù)的異常處理代碼，提高代碼的可維護(hù)性和復(fù)用性。

自定義異常響應(yīng)：通過全局異常處理器，可以定義統(tǒng)一的異常響應(yīng)格式和錯誤碼，使異常的處理更加符合應(yīng)用的需求。

防止泄露敏感信息：全局異常處理器可以捕獲并處理未處理的異常，確保不會向客戶端返回敏感信息，同時返回適當(dāng)?shù)漠惓Ｐ畔ⅰ?/p>

在Spring MVC中，可以使用@ControllerAdvice或@RestControllerAdvice注解來定義全局異常處理器類，并使用 @ExceptionHandler注解來定義處理特定異常的方法。這些方法可以在全局異常處理器類中進(jìn)行集中管理，提供統(tǒng)一的異常處理邏輯。

希望這樣的回答給你帶來了一些樂趣和激勵！如果你有其他問題，我會很樂意回答。

一、認(rèn)識注解：@RestControllerAdvice和@ExceptionHandler

當(dāng)涉及到全局異常處理時，兩個重要的注解被廣泛使用：@RestControllerAdvice和@ExceptionHandler。

下面是對這兩個注解的解釋：

@RestControllerAdvice：

（這里插一句：如果你的應(yīng)用程序使用傳統(tǒng)的Web應(yīng)用程序架構(gòu)（使用視圖解析器渲染視圖），則可以使用@ControllerAdvice。而如果你的應(yīng)用程序是RESTful風(fēng)格的應(yīng)用程序，需要直接返回JSON或其他格式的響應(yīng)體，那么可以使用@RestControllerAdvice。）

@RestControllerAdvice是一個用于定義全局異常處理器的注解。通過將此注解應(yīng)用于一個類上，該類可以成為一個全局異常處理器。在這個處理器中，你可以定義通用的異常處理邏輯，用于捕獲和處理應(yīng)用程序中的各種異常情況。

@RestControllerAdvice注解的主要作用是：

提供全局異常處理邏輯，捕獲應(yīng)用程序中未被處理的異常。

允許在多個控制器類中共享相同的異常處理邏輯。

可以組合使用其他注解，如@ExceptionHandler、@InitBinder和@ModelAttribute。

@ExceptionHandler：

@ExceptionHandler是一個用于定義特定異常處理方法的注解。通過將此注解應(yīng)用于處理器類中的方法上，該方法可以被用于處理特定類型的異常。這樣，當(dāng)應(yīng)用程序拋出匹配的異常時，該方法將被自動調(diào)用以處理該異常。

@ExceptionHandler注解的主要作用是：

定義特定異常的處理邏輯，捕獲應(yīng)用程序中拋出的特定類型的異常。

提供更精細(xì)的異常處理機(jī)制，根據(jù)不同的異常類型執(zhí)行不同的處理代碼。

可以在同一個全局異常處理器類中定義多個@ExceptionHandler方法，以處理不同類型的異常。

二、使用步驟

1、封裝統(tǒng)一返回結(jié)果類

定義返回結(jié)果類：后端統(tǒng)一返回結(jié)果:

import lombok.Data;
import java.io.Serializable;
/**
 * 后端統(tǒng)一返回結(jié)果
 * @param <T>
 */
@Data
public class Result<T> implements Serializable {
    private Integer code; //編碼：1成功，0和其它數(shù)字為失敗
    private String msg; //錯誤信息
    private T data; //數(shù)據(jù)
    public static <T> Result<T> success() {
        Result<T> result = new Result<T>();
        result.code = 1;
        return result;
    }
    public static <T> Result<T> success(T object) {
        Result<T> result = new Result<T>();
        result.data = object;
        result.code = 1;
        return result;
    }
    public static <T> Result<T> error(String msg) {
        Result result = new Result();
        result.msg = msg;
        result.code = 0;
        return result;
    }
}

2、自定義異常類封裝

封裝自定義異常類，用于自定義異常拋出，根據(jù)實際情況對業(yè)務(wù)異常進(jìn)行更細(xì)致和明確的拓展先定義基礎(chǔ)異常類：

/**
 * 業(yè)務(wù)異常
 */
public class BaseException extends RuntimeException {
    public BaseException() {
    }
    public BaseException(String msg) {
        super(msg);
    }
}

再定義自定義異常類：

public class UserNotLoginException extends BaseException {
    public UserNotLoginException() {
    }
    public UserNotLoginException(String msg) {
        super(msg);
    }
}

3、定義全局異常處理類

統(tǒng)一捕獲異常：

import com.example.result.Result;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 捕獲業(yè)務(wù)異常
     */
    @ExceptionHandler
    public Result<?> exceptionHandler(BaseException ex){
        return Result.error(ex.getMessage());
    }
	/**
     * 捕獲除數(shù)為0異常
     */
    @ExceptionHandler
    public Result<?> exceptionHandler(ArithmeticException ex){
        return Result.error("分母不能為0");
    }
    /**
     * 根據(jù)異常類型和業(yè)務(wù)需求，以以下格式繼續(xù)完善代碼
     */
}

根據(jù)異常類型和業(yè)務(wù)需求，可以以以下格式繼續(xù)完善代碼：

 @ExceptionHandler
    public Result<?> exceptionHandler(異常類型 ex){
        return Result.error("異常類型信息");
    }

4、測試

import com.example.result.Result;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class webTest {
	/**
     * 測試捕獲業(yè)務(wù)異常
     */
    @GetMapping("/aa/{id}")
    public Result<?> aa(@PathVariable Long id){
        if(id<2)
            throw new UserNotLoginException("密碼錯誤");
        return Result.success("成功");
    }
    /**
     * 測試捕獲除數(shù)為0異常
     */
    @GetMapping("/bb")
    public Result<?> bb(){
        int a = 1/0;
        return Result.success("成功");
    }

在這里插入圖片描述

通過以上測試，產(chǎn)生的異常都被全局異常處理器捕獲了??！搞定?。?！

以上就是在Spring MVC中使用@ControllerAdvice創(chuàng)建全局異常處理器的方法的詳細(xì)內(nèi)容，更多關(guān)于Spring MVC @ControllerAdvice創(chuàng)建處理器的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: