零、前言

對(duì)于與數(shù)據(jù)庫(kù)相關(guān)的 Spring MVC 項(xiàng)目，我們通常會(huì)把 事務(wù) 配置在 Service層，當(dāng)數(shù)據(jù)庫(kù)操作失敗時(shí)讓 Service 層拋出運(yùn)行時(shí)異常，Spring 事物管理器就會(huì)進(jìn)行回滾。

如此一來，我們的 Controller 層就不得不進(jìn)行 try-catch Service 層的異常，否則會(huì)返回一些不友好的錯(cuò)誤信息到客戶端。但是，Controller 層每個(gè)方法體都寫一些模板化的 try-catch 的代碼，很難看也難維護(hù)，特別是還需要對(duì) Service 層的不同異常進(jìn)行不同處理的時(shí)候。例如以下 Controller 方法代碼（非常難看且冗余）：

/**
 * 手動(dòng)處理 Service 層異常和數(shù)據(jù)校驗(yàn)異常的示例
 * @param dog
 * @param errors
 * @return
 */
@PostMapping(value = "")
AppResponse add(@Validated(Add.class) @RequestBody Dog dog, Errors errors){
    AppResponse resp = new AppResponse();
    try {
        // 數(shù)據(jù)校驗(yàn)
        BSUtil.controllerValidate(errors);

        // 執(zhí)行業(yè)務(wù)
        Dog newDog = dogService.save(dog);

        // 返回?cái)?shù)據(jù)
        resp.setData(newDog);

    }catch (BusinessException e){
        LOGGER.error(e.getMessage(), e);
        resp.setFail(e.getMessage());
    }catch (Exception e){
        LOGGER.error(e.getMessage(), e);
        resp.setFail("操作失敗！");
    }
    return resp;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

本文講解使用 @ControllerAdvice + @ExceptionHandler 進(jìn)行全局的 Controller 層異常處理，只要設(shè)計(jì)得當(dāng)，就再也不用在 Controller 層進(jìn)行 try-catch 了！而且，@Validated 校驗(yàn)器注解的異常，也可以一起處理，無需手動(dòng)判斷綁定校驗(yàn)結(jié)果 BindingResult/Errors 了！

一、優(yōu)缺點(diǎn)

• 優(yōu)點(diǎn)：將 Controller 層的異常和數(shù)據(jù)校驗(yàn)的異常進(jìn)行統(tǒng)一處理，減少模板代碼，減少編碼量，提升擴(kuò)展性和可維護(hù)性。
• 缺點(diǎn)：只能處理 Controller 層未捕獲（往外拋）的異常，對(duì)于 Interceptor（攔截器）層的異常，Spring 框架層的異常，就無能為力了。

二、基本使用示例

2.1 @ControllerAdvice 注解定義全局異常處理類

@ControllerAdvice
public class GlobalExceptionHandler {
}
1
2
3

請(qǐng)確保此 GlobalExceptionHandler 類能被掃描到并裝載進(jìn) Spring 容器中。

2.2 @ExceptionHandler 注解聲明異常處理方法

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseBody
    String handleException(){
        return "Exception Deal!";
    }
}
1
2
3
4
5
6
7
8
9

方法 handleException() 就會(huì)處理所有 Controller 層拋出的 Exception 及其子類的異常，這是最基本的用法了。

被 @ExceptionHandler 注解的方法的參數(shù)列表里，還可以聲明很多種類型的參數(shù)，詳見文檔。其原型如下：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler {

    /**
     * Exceptions handled by the annotated method. If empty, will default to any
     * exceptions listed in the method argument list.
     */
    Class<? extends Throwable>[] value() default {};

}
1
2
3
4
5
6
7
8
9
10
11
12

如果 @ExceptionHandler 注解中未聲明要處理的異常類型，則默認(rèn)為參數(shù)列表中的異常類型。所以上面的寫法，還可以寫成這樣：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler()
    @ResponseBody
    String handleException(Exception e){
        return "Exception Deal! " + e.getMessage();
    }
}
1
2
3
4
5
6
7
8
9

參數(shù)對(duì)象就是 Controller 層拋出的異常對(duì)象！

三、處理 Service 層上拋的業(yè)務(wù)異常

有時(shí)我們會(huì)在復(fù)雜的帶有數(shù)據(jù)庫(kù)事務(wù)的業(yè)務(wù)中，當(dāng)出現(xiàn)不和預(yù)期的數(shù)據(jù)時(shí)，直接拋出封裝后的業(yè)務(wù)級(jí)運(yùn)行時(shí)異常，進(jìn)行數(shù)據(jù)庫(kù)事務(wù)回滾，并希望該異常信息能被返回顯示給用戶。

3.1 代碼示例

封裝的業(yè)務(wù)異常類：

public class BusinessException extends RuntimeException {

    public BusinessException(String message){
        super(message);
    }
}
1
2
3
4
5
6

Service 實(shí)現(xiàn)類：

@Service
public class DogService {

    @Transactional
    public Dog update(Dog dog){

        // some database options

        // 模擬狗狗新名字與其他狗狗的名字沖突
        BSUtil.isTrue(false, "狗狗名字已經(jīng)被使用了...");

        // update database dog info

        return dog;
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

其中輔助工具類 BSUtil

public static void isTrue(boolean expression, String error){
    if(!expression) {
        throw new BusinessException(error);
    }
}
1
2
3
4
5

那么，我們應(yīng)該在 GlobalExceptionHandler 類中聲明該業(yè)務(wù)異常類，并進(jìn)行相應(yīng)的處理，然后返回給用戶。更貼近真實(shí)項(xiàng)目的代碼，應(yīng)該長(zhǎng)這樣子：

/**
 * Created by kinginblue on 2017/4/10.
 * @ControllerAdvice + @ExceptionHandler 實(shí)現(xiàn)全局的 Controller 層的異常處理
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 處理所有不可知的異常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    AppResponse handleException(Exception e){
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail("操作失敗！");
        return response;
    }

    /**
     * 處理所有業(yè)務(wù)異常
     * @param e
     * @return
     */
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    AppResponse handleBusinessException(BusinessException e){
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail(e.getMessage());
        return response;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

Controller 層的代碼，就不需要進(jìn)行異常處理了：

@RestController
@RequestMapping(value = "/dogs", consumes = {MediaType.APPLICATION_JSON_UTF8_VALUE})
public class DogController {

    @Autowired
    private DogService dogService;

    @PatchMapping(value = "")
    Dog update(@Validated(Update.class) @RequestBody Dog dog){
        return dogService.update(dog);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

3.2 代碼說明

Logger 進(jìn)行所有的異常日志記錄。

@ExceptionHandler(BusinessException.class) 聲明了對(duì) BusinessException 業(yè)務(wù)異常的處理，并獲取該業(yè)務(wù)異常中的錯(cuò)誤提示，構(gòu)造后返回給客戶端。

@ExceptionHandler(Exception.class) 聲明了對(duì) Exception 異常的處理，起到兜底作用，不管 Controller 層執(zhí)行的代碼出現(xiàn)了什么未能考慮到的異常，都返回統(tǒng)一的錯(cuò)誤提示給客戶端。

備注：以上 GlobalExceptionHandler 只是返回 Json 給客戶端，更大的發(fā)揮空間需要按需求情況來做。

四、處理 Controller 數(shù)據(jù)綁定、數(shù)據(jù)校驗(yàn)的異常

在 Dog 類中的字段上的注解數(shù)據(jù)校驗(yàn)規(guī)則：

@Data
public class Dog {

    @NotNull(message = "{Dog.id.non}", groups = {Update.class})
    @Min(value = 1, message = "{Dog.age.lt1}", groups = {Update.class})
    private Long id;

    @NotBlank(message = "{Dog.name.non}", groups = {Add.class, Update.class})
    private String name;

    @Min(value = 1, message = "{Dog.age.lt1}", groups = {Add.class, Update.class})
    private Integer age;
}
1
2
3
4
5
6
7
8
9
10
11
12
13

說明：@NotNull、@Min、@NotBlank 這些注解的使用方法，不在本文范圍內(nèi)。如果不熟悉，請(qǐng)查找資料學(xué)習(xí)即可。

其他說明：
@Data 注解是 **Lombok** 項(xiàng)目的注解，可以使我們不用再在代碼里手動(dòng)加 getter & setter。
在 Eclipse 和 IntelliJ IDEA 中使用時(shí)，還需要安裝相關(guān)插件，這個(gè)步驟自行Google/Baidu 吧！
1
2
3
4
5
6

Lombok 使用方法見：Java奇淫巧技之Lombok

SpringMVC 中對(duì)于 RESTFUL 的 Json 接口來說，數(shù)據(jù)綁定和校驗(yàn)，是這樣的：

/**
 * 使用 GlobalExceptionHandler 全局處理 Controller 層異常的示例
 * @param dog
 * @return
 */
@PatchMapping(value = "")
AppResponse update(@Validated(Update.class) @RequestBody Dog dog){
    AppResponse resp = new AppResponse();

    // 執(zhí)行業(yè)務(wù)
    Dog newDog = dogService.update(dog);

    // 返回?cái)?shù)據(jù)
    resp.setData(newDog);

    return resp;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

使用 @Validated + @RequestBody 注解實(shí)現(xiàn)。

當(dāng)使用了 @Validated + @RequestBody 注解但是沒有在綁定的數(shù)據(jù)對(duì)象后面跟上 Errors 類型的參數(shù)聲明的話，Spring MVC 框架會(huì)拋出 MethodArgumentNotValidException 異常。

所以，在 GlobalExceptionHandler 中加上對(duì) MethodArgumentNotValidException 異常的聲明和處理，就可以全局處理數(shù)據(jù)校驗(yàn)的異常了！加完后的代碼如下：

/**
 * Created by kinginblue on 2017/4/10.
 * @ControllerAdvice + @ExceptionHandler 實(shí)現(xiàn)全局的 Controller 層的異常處理
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 處理所有不可知的異常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    AppResponse handleException(Exception e){
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail("操作失??！");
        return response;
    }

    /**
     * 處理所有業(yè)務(wù)異常
     * @param e
     * @return
     */
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    AppResponse handleBusinessException(BusinessException e){
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail(e.getMessage());
        return response;
    }

    /**
     * 處理所有接口數(shù)據(jù)驗(yàn)證異常
     * @param e
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    AppResponse handleMethodArgumentNotValidException(MethodArgumentNotValidException e){
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail(e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
        return response;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

注意到了嗎，所有的 Controller 層的異常的日志記錄，都是在這個(gè) GlobalExceptionHandler 中進(jìn)行記錄。也就是說，Controller 層也不需要在手動(dòng)記錄錯(cuò)誤日志了。

五、總結(jié)

本文主要講 @ControllerAdvice + @ExceptionHandler 組合進(jìn)行的 Controller 層上拋的異常全局統(tǒng)一處理。

其實(shí)，被 @ExceptionHandler 注解的方法還可以聲明很多參數(shù)，詳見文檔。

@ControllerAdvice 也還可以結(jié)合 @InitBinder、@ModelAttribute 等注解一起使用，應(yīng)用在所有被 @RequestMapping 注解的方法上，詳見搜索引擎。

六、附錄

本文示例代碼已放到 Github。