Spring中@ControllerAdvice注解的用法解析

更新時間：2023年10月12日 11:38:43 作者：探索er

這篇文章主要介紹了Spring中@ControllerAdvice注解的用法解析,顧名思義,@ControllerAdvice就是@Controller 的增強版,@ControllerAdvice主要用來處理全局數(shù)據(jù),一般搭配@ExceptionHandler、@ModelAttribute以及@InitBinder使用,需要的朋友可以參考下

@ControllerAdvice 用法

顧名思義，@ControllerAdvice就是@Controller 的增強版。

@ControllerAdvice主要用來處理全局數(shù)據(jù)，一般搭配@ExceptionHandler、@ModelAttribute以及@InitBinder使用。

全局異常處理

@ControllerAdvice最常見的使用場景就是全局異常處理。

比如文件上傳大小限制的配置，如果用戶上傳的文件超過了限制大小，就會拋出異常,此時可以通過@ControllerAdvice結(jié)合@ExceptionHandler定義全局異常捕獲機制，代碼如下:

@ControllerAdvice
public class CustomExceptionHandler {
    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public void uploadException(MaxUploadSizeExceededException e, HttpServletResponse resp) throws IOException {
        resp.setContentType("text/html;charset=utf-8");
        System.out.println(1111);
        PrintWriter out = resp.getWriter();
        out.write("上傳文件大小超出限制!");
        out.flush();
        out.close();
    }
}

只需在系統(tǒng)中定義CustomExceptionHandler類，然后添加@ControllerAdvice注解即可。當系統(tǒng)啟動時，該類就會被掃描到Spring容器中，然后定義uploadException方法，在該方法上添加了@ExceptionHandler注解，其中定義的MaxUploadSizeExceededException.class 表明該方法用來處理MaxUploadSizeExceededException類型的異常。如果想讓該方法處理所有類型的異常，只需將MaxUploadSizeExceededException改為 Exception即可。方法的參數(shù)可以有異常實例、HttpServletResponse以及HttpServletRequest、Model 等，返回值可以是一段JSON、一個ModelAndView、一個邏輯視圖名等。此時，上傳一個超大文件會有錯誤提示給用戶。

在這里插入圖片描述

如果返回參數(shù)是一個ModelAndView，假設使用的頁面模板為Thymeleaf(注意添加Thymeleaf相關(guān)依賴）,此時異常處理方法定義如下:

@ControllerAdvice
public class CustomExceptionHandler {
    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public ModelAndView uploadException(MaxUploadSizeExceededException e) throws IOException {
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg", "上傳文件大小超出限制! ");
        mv.setViewName("error");
        return mv;
    }
}

然后在resources/templates目錄下創(chuàng)建error.html文件，內(nèi)容如下:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title></head>
<body>
<div th:text="${msg}"></div>
</body>
</html>

此時上傳出錯效果一致。

添加全局數(shù)據(jù)

@ControllerAdvice是一個全局數(shù)據(jù)處理組件，因此也可以在@ControllerAdvice中配置全局數(shù)據(jù)，使用@ModelAttribute注解進行配置，代碼如下:

@ControllerAdvice
public class GlobalConfig {
    @ModelAttribute(value = "info")
    public Map<String, String> userInfo() {
        HashMap<String, String> map = new HashMap<>();
        map.put("username", "羅貫中");
        map.put("gender", "男");
        return map;
    }
}

代碼解釋:

在全局配置中添加userInfo方法，返回一個map。該方法有一個注解@ModelAttribute，其中的value屬性表示這條返回數(shù)據(jù)的key，而方法的返回值是返回數(shù)據(jù)的value。
此時在任意請求的Controller 中，通過方法參數(shù)中的Model都可以獲取info 的數(shù)據(jù)。

Controller 例代碼如下：

public class MyController {
    @GetMapping("/hello")
    @ResponseBody
    public void hello(Model model) {
        Map<String, Object> map = model.asMap();
        Set<String> keySet = map.keySet();
        Iterator<String> iterator = keySet.iterator();
        while (iterator.hasNext()) {
            String key = iterator.next();
            Object value = map.get(key);
            System.out.println(key + ">>>>>" + value);
        }
    }
}

在請求方法中，將Model 中的數(shù)據(jù)打印出來，如圖所示。

在這里插入圖片描述

請求參數(shù)預處理

@ControllerAdvice結(jié)合@InitBinder還能實現(xiàn)請求參數(shù)預處理，即將表單中的數(shù)據(jù)綁定到實體類上時進行一些額外處理。

例如有兩個實體類 Book和 Author，代碼如下:

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@ToString
public class Book {
    private String name;
    private String author;
    @JsonIgnore//一般標記在屬性或者方法上，返回的json數(shù)據(jù)即不包含該屬性
    private Float price;
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date publicationDate;
}
@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class Author {
    private String name;
    private int age;
}

在 Controller 上需要接收兩個實體類的數(shù)據(jù)，Controller 中的方法定義如下:

@ControllerAdvice
public class GlobalConfig1 {
    @InitBinder("b")
    public void init(WebDataBinder binder) {
        binder.setFieldDefaultPrefix("b.");
    }
    @InitBinder("a")
    public void init2(WebDataBinder binder) {
        binder.setFieldDefaultPrefix("a.");
    }
}

代碼解釋:

在 GlobalConfig類中創(chuàng)建兩個方法，第一個@InitBinder(“b”)表示該方法是處理@ModelAttribute(“b”)對應的參數(shù)的，第二個@InitBinder(“a”)表示該方法是處理@ModelAttribute(“a”)對應的參數(shù)的。
在每個方法中給相應的 Field設置一個前綴，然后在瀏覽器中請求http:/ocalhost:8080/book?b.name=三國演義&b.author=羅貫中&a.name=曹雪芹&a.age=48，即可成功地區(qū)分出name屬性。
在WebDataBinder對象中，還可以設置允許的字段、禁止的字段、必填字段以及驗證器等。

ld設置一個前綴，然后在瀏覽器中請求/ocalhost:8080/book?b.name=三國演義&b.author=羅貫中&a.name=曹雪芹&a.age=48，即可成功地區(qū)分出name屬性。

在WebDataBinder對象中，還可以設置允許的字段、禁止的字段、必填字段以及驗證器等。

在這里插入圖片描述