溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

巧用SpringBoot輕松搞定全局異常

發(fā)布時(shí)間：2020-06-20 08:49:15 來(lái)源：網(wǎng)絡(luò) 閱讀：3139 作者：Java_老男孩 欄目：編程語(yǔ)言

SpringBoot?是為了簡(jiǎn)化?Spring?應(yīng)用的創(chuàng)建、運(yùn)行、調(diào)試、部署等一系列問(wèn)題而誕生的產(chǎn)物，自動(dòng)裝配的特性讓我們可以更好的關(guān)注業(yè)務(wù)本身而不是外部的XML配置，我們只需遵循規(guī)范，引入相關(guān)的依賴就可以輕易的搭建出一個(gè) WEB 工程

實(shí)際項(xiàng)目開發(fā)中，程序往往會(huì)發(fā)生各式各樣的異常情況，特別是身為服務(wù)端開發(fā)人員的我們，總是不停的編寫接口提供給前端調(diào)用，分工協(xié)作的情況下，避免不了異常的發(fā)生，如果直接將錯(cuò)誤的信息直接暴露給用戶，這樣的體驗(yàn)可想而知，且對(duì)***而言，詳細(xì)異常信息往往會(huì)提供非常大的幫助…

初窺異常

一個(gè)簡(jiǎn)單的異常請(qǐng)求的接口

@GetMapping("/test1")
public String test1() {
    // TODO 這里只是模擬異常，假設(shè)業(yè)務(wù)處理的時(shí)候出現(xiàn)錯(cuò)誤了，或者空指針了等等...
    int i = 10 / 0;
    return "test1";
}

打開瀏覽器訪問(wèn)它的時(shí)候發(fā)現(xiàn)

巧用SpringBoot輕松搞定全局異常 瀏覽器中的異常信息

又或者是用?postman?等模擬工具
巧用SpringBoot輕松搞定全局異常
如果這接口是給第三方調(diào)用或者是自己公司的系統(tǒng)，看到這種錯(cuò)誤估計(jì)得暴走吧….

笨方法（極其不建議）

采用try-catch的方式，手動(dòng)捕獲異常信息，然后返回對(duì)應(yīng)的結(jié)果集，相信很多人都看到過(guò)類似的代碼（如：封裝成Result對(duì)象）；該方法雖然間接性的解決錯(cuò)誤暴露的問(wèn)題，同樣的弊端也很明顯，增加了大量的代碼量，當(dāng)異常過(guò)多的情況下對(duì)應(yīng)的catch層愈發(fā)的多了起來(lái)，很難管理這些業(yè)務(wù)異常和錯(cuò)誤碼之間的匹配，所以最好的方法就是通過(guò)簡(jiǎn)單配置全局掌控….

@GetMapping("/test2")
public Map<String, String> test2() {
    Map<String, String> result = new HashMap<>(16);
    // TODO 直接捕獲所有代碼塊，然后在 cache
    try {
        int i = 10 / 0;
        result.put("code", "200");
        result.put("data", "具體返回的結(jié)果集");
    } catch (Exception e) {
        result.put("code", "500");
        result.put("message", "請(qǐng)求錯(cuò)誤");
    }
    return result;
}

具體代碼

通過(guò)上面的閱讀大家也大致能了解到為啥需要對(duì)異常進(jìn)行全局捕獲了，接下來(lái)就看看?Spring Boot?提供的解決方案

導(dǎo)入依賴

在?pom.xml?中添加上?spring-boot-starter-web?的依賴即可

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

自定義異常

在應(yīng)用開發(fā)過(guò)程中，除系統(tǒng)自身的異常外，不同業(yè)務(wù)場(chǎng)景中用到的異常也不一樣，為了與標(biāo)題?輕松搞定全局異常?更加的貼切，定義個(gè)自己的異常，看看如何捕獲…

package com.battcn.exception;

/**
 * 自定義異常
 *
 * @author Levin
 * @since 2018/6/1 0001
 */
public class CustomException extends RuntimeException {

    private static final long serialVersionUID = 4564124491192825748L;

    private int code;

    public CustomException() {
        super();
    }

    public CustomException(int code, String message) {
        super(message);
        this.setCode(code);
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }
}

異常信息模板

定義返回的異常信息的格式，這樣異常信息風(fēng)格更為統(tǒng)一

package com.battcn.exception;

/**
 * @author Levin
 * @since 2018/6/1 0001
 */
public class ErrorResponseEntity {

    private int code;
    private String message;
    // 省略 get set 
}

控制層

仔細(xì)一看是不是和平時(shí)正常寫的代碼沒(méi)啥區(qū)別，不要急，接著看….

package com.battcn.controller;

import com.battcn.exception.CustomException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

/**
 * 全局異常演示
 *
 * @author Levin
 * @since 2018/5/31 0031
 */
@RestController
public class ExceptionController {

    @GetMapping("/test3")
    public String test3(Integer num) {
        // TODO 演示需要，實(shí)際上參數(shù)是否為空通過(guò) @RequestParam(required = true)  就可以控制
        if (num == null) {
            throw new CustomException(400, "num不能為空");
        }
        int i = 10 / num;
        return "result:" + i;
    }
}

異常處理（關(guān)鍵）

注解概述

  • @ControllerAdvice?捕獲?Controller?層拋出的異常，如果添加?@ResponseBody?返回信息則為JSON?格式。
  • @RestControllerAdvice?相當(dāng)于?@ControllerAdvice?與?@ResponseBody?的結(jié)合體。
  • @ExceptionHandler?統(tǒng)一處理一種類的異常，減少代碼重復(fù)率，降低復(fù)雜度。

創(chuàng)建一個(gè)?GlobalExceptionHandler?類，并添加上?@RestControllerAdvice?注解就可以定義出異常通知類了，然后在定義的方法中添加上?@ExceptionHandler?即可實(shí)現(xiàn)異常的捕捉…

package com.battcn.config;

import com.battcn.exception.CustomException;
import com.battcn.exception.ErrorResponseEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

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

/**
 * 全局異常處理
 *
 * @author Levin
 * @since 2018/6/1 0001
 */
@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    /**
     * 定義要捕獲的異常 可以多個(gè) @ExceptionHandler({})
     *
     * @param request  request
     * @param e        exception
     * @param response response
     * @return 響應(yīng)結(jié)果
     */
    @ExceptionHandler(CustomException.class)
    public ErrorResponseEntity customExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
        response.setStatus(HttpStatus.BAD_REQUEST.value());
        CustomException exception = (CustomException) e;
        return new ErrorResponseEntity(exception.getCode(), exception.getMessage());
    }

    /**
     * 捕獲  RuntimeException 異常
     * TODO  如果你覺得在一個(gè) exceptionHandler 通過(guò)  if (e instanceof xxxException) 太麻煩
     * TODO  那么你還可以自己寫多個(gè)不同的 exceptionHandler 處理不同異常
     *
     * @param request  request
     * @param e        exception
     * @param response response
     * @return 響應(yīng)結(jié)果
     */
    @ExceptionHandler(RuntimeException.class)
    public ErrorResponseEntity runtimeExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
        response.setStatus(HttpStatus.BAD_REQUEST.value());
        RuntimeException exception = (RuntimeException) e;
        return new ErrorResponseEntity(400, exception.getMessage());
    }

    /**
     * 通用的接口映射異常處理方
     */
    @Override
    protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body, HttpHeaders headers,
                                                             HttpStatus status, WebRequest request) {
        if (ex instanceof MethodArgumentNotValidException) {
            MethodArgumentNotValidException exception = (MethodArgumentNotValidException) ex;
            return new ResponseEntity<>(new ErrorResponseEntity(status.value(), exception.getBindingResult().getAllErrors().get(0).getDefaultMessage()), status);
        }
        if (ex instanceof MethodArgumentTypeMismatchException) {
            MethodArgumentTypeMismatchException exception = (MethodArgumentTypeMismatchException) ex;
            logger.error("參數(shù)轉(zhuǎn)換失敗，方法：" + exception.getParameter().getMethod().getName() + "，參數(shù)：" + exception.getName()
                    + ",信息：" + exception.getLocalizedMessage());
            return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "參數(shù)轉(zhuǎn)換失敗"), status);
        }
        return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "參數(shù)轉(zhuǎn)換失敗"), status);
    }
}

主函數(shù)

package com.battcn;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author Levin
 */
@SpringBootApplication
public class Chapter17Application {

    public static void main(String[] args) {
        SpringApplication.run(Chapter17Application.class, args);
    }

}

測(cè)試

完成準(zhǔn)備事項(xiàng)后，啟動(dòng)Chapter17Application，通過(guò)下面的測(cè)試結(jié)果可以發(fā)現(xiàn)，真的是?so easy，代碼變得整潔了，擴(kuò)展性也變好了…

訪問(wèn)?http://localhost:8080/test3

{"code":400,"message":"num不能為空"}

訪問(wèn)?http://localhost:8080/test3?num=0

{"code":400,"message":"/ by zero"}

訪問(wèn)?http://localhost:8080/test3?num=5

result:2

本文的重點(diǎn)是你有沒(méi)有收獲與成長(zhǎng)，其余的都不重要，希望讀者們能謹(jǐn)記這一點(diǎn)。同時(shí)我經(jīng)過(guò)多年的收藏目前也算收集到了一套完整的學(xué)習(xí)資料，包括但不限于：分布式架構(gòu)、高可擴(kuò)展、高性能、高并發(fā)、Jvm性能調(diào)優(yōu)、Spring，MyBatis，Nginx源碼分析，Redis，ActiveMQ、Mycat、Netty、Kafka、Mysql、Zookeeper、Tomcat、Docker、Dubbo、Nginx等多個(gè)知識(shí)點(diǎn)高級(jí)進(jìn)階干貨，希望對(duì)想成為架構(gòu)師的朋友有一定的參考和幫助

有需要的可以加一下三千人Java技術(shù)交流分享群：“708 701 457”免費(fèi)獲取

向AI問(wèn)一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱：is@yisu.com進(jìn)行舉報(bào)，并提供相關(guān)證據(jù)，一經(jīng)查實(shí)，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手