SpringBoot增強(qiáng)Controller方法@ControllerAdvice注解的使用詳解
更新時(shí)間：2023年10月12日 10:31:19 作者：fengyehongWorld
這篇文章主要介紹了SpringBoot增強(qiáng)Controller方法@ControllerAdvice注解的使用詳解,@ControllerAdvice,是Spring3.2提供的新注解,它是一個(gè)Controller增強(qiáng)器,可對controller進(jìn)行增強(qiáng)處理,需要的朋友可以參考下
一. @ControllerAdvice注解作用
@ControllerAdvice ，是Spring3.2提供的新注解，它是一個(gè)Controller增強(qiáng)器，可對controller進(jìn)行增強(qiáng)處理。
- 配合@ExceptionHandler注解，進(jìn)行全局異常處理。
- 配合@InitBinder注解，用來設(shè)置WebDataBinder，用于自動(dòng)綁定前臺請求參數(shù)到Model中，全局?jǐn)?shù)據(jù)預(yù)處理，多用于表單提交數(shù)據(jù)或者url傳參。
- 配合@ModelAttribute注解，讓Controller類中所有的方法都可以獲取到通過@ModelAttribute注解設(shè)置的值，進(jìn)行全局?jǐn)?shù)據(jù)綁定。
注意： @ControllerAdvice 注解將作用在所有Controller層的方法上。
二. @ControllerAdvice注解 + assignableTypes屬性
作用：增強(qiáng)指定 .class 的類，非指定的Controller類不會被增強(qiáng)
2.1 @ControllerAdvice增強(qiáng)類
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ModelAttribute;
import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
// 指定增強(qiáng)S001LoginController和S002LogoutController
@ControllerAdvice(assignableTypes = {S001LoginController.class, S002LogoutController.class})
public class S_Controller {
@Autowired
private HttpServletRequest request;
// 方式1: @ModelAttribute注解的使用
@ModelAttribute
public void initData1(Model model) {
request.setAttribute("num1", 66);
model.addAttribute("userMail", List.of("123@mail.com", "456@mail.com"));
}
// 方式2: @ModelAttribute注解的使用
@ModelAttribute(name = "userInfo")
public Map<String, String> initData2() {
request.setAttribute("num2", 99);
return new HashMap<>(){
{
put("name", "賈飛天");
put("age", "18");
}
};
}
// 捕獲S001LoginController或S002LogoutController類中的Exception異常
@ExceptionHandler(Exception.class)
public void exceptionHandle(Exception ex) {
System.out.println(ex.getMessage());
}
}2.2 Controller層
目錄結(jié)構(gòu)如下
- s_controller包
- S001LoginController.java
- S002LogoutController.java
- S003Controller.java
說明
- @ControllerAdvice增強(qiáng)類中，指定對S001LoginController.java和S002LogoutController.java進(jìn)行了增強(qiáng)，因此這兩個(gè)類中可以獲取到增強(qiáng)類中放入的數(shù)據(jù)，并且這兩個(gè)類中拋出的Exception異常也會被增強(qiáng)類所捕獲。
- 由于S003Controller.java并沒有被增強(qiáng)，因此該類無法獲取增強(qiáng)類中放入的數(shù)據(jù)，并且拋出的異常也無法被增強(qiáng)類捕獲。
S001LoginController.java
有2種方式可以獲取出@ControllerAdvice增強(qiáng)類中放入Model中的數(shù)據(jù)
- model.asMap()
- @ModelAttribute("key名稱") 類型 變量名
還可以通過request.getAttribute("key名稱")來獲取放入request的attribute中的數(shù)據(jù)。
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import java.util.List;
import java.util.Map;
@Controller
@RequestMapping("/ss001")
public class S001LoginController {
@Autowired
private HttpServletRequest request;
@GetMapping("/init")
public ModelAndView init(Model model) {
// ?方式1: 獲取出@ControllerAdvice增強(qiáng)類中提前放入Model中的數(shù)據(jù)
Map<String, Object> mapInfo = model.asMap();
Object userMailObj = mapInfo.get("userMail");
List<String> userMailList = (List<String>)userMailObj;
System.out.println(userMailList); // [123@mail.com, 456@mail.com]
Map<String, String> userInfoMap = (Map<String, String>) mapInfo.get("userInfo");
System.out.println(userInfoMap); // {name=賈飛天, age=18}
// ?獲取出@ControllerAdvice增強(qiáng)類中提前放入request的attribute中的數(shù)據(jù)
Integer num1 = (Integer) request.getAttribute("num1");
System.out.println(num1); // 66
Integer num2 = (Integer) request.getAttribute("num2");
System.out.println(num2); // 99
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("s001");
return modelAndView;
}
@GetMapping("/showInfo")
@ResponseBody
public void showInfo(
// ?方式2: 獲取出@ControllerAdvice增強(qiáng)類中提前放入Model中的數(shù)據(jù)
@ModelAttribute("userMail") List<String> userMail
, @ModelAttribute("userInfo") Map<String, String> userInfo
) {
System.out.println(userMail); // [123@mail.com, 456@mail.com]
System.out.println(userInfo); // {name=賈飛天, age=18}
}
}S002LogoutController.java
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import java.util.Map;
@Controller
@RequestMapping("/ss002")
public class S002LogoutController {
@GetMapping("/init")
public ModelAndView init(Model model) {
// 獲取出@ControllerAdvice增強(qiáng)類中提前放入Model中的數(shù)據(jù)
Map<String, Object> mapInfo = model.asMap();
System.out.println(mapInfo);
// 代碼出現(xiàn)異常
int num = 1 / 0;
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("s002");
return modelAndView;
}
}S003Controller.java
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
@Controller
@RequestMapping("/ss003")
public class S003Controller {
@GetMapping("/init")
public ModelAndView init() {
int num = 1 / 0;
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("s003");
return modelAndView;
}
}2.3 效果
獲取數(shù)據(jù)
異常
三. @ControllerAdvice注解 + basePackages屬性
增強(qiáng)指定包下面所有的Controller
3.1 @ControllerAdvice增強(qiáng)類
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice(basePackages = {"com.example.jmw.t_controller"})
public class T_Controller {
@ExceptionHandler(Exception.class)
public void exceptionHandle(Exception ex) {
System.out.println(ex.getMessage());
}
}四. @ControllerAdvice注解 + annotations屬性
增強(qiáng)標(biāo)記了 指定注解 的所有的Controller
4.1 自定義注解
import java.lang.annotation.*;
@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ControllerMarkAnnotation {
}4.2 @ControllerAdvice增強(qiáng)類
mport org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice(annotations = ControllerMarkAnnotation.class)
public class X_Controller {
@ExceptionHandler(Exception.class)
public void exceptionHandle(Exception ex) {
System.out.println(ex.getMessage());
}
}到此這篇關(guān)于SpringBoot增強(qiáng)Controller方法@ControllerAdvice注解的使用詳解的文章就介紹到這了,更多相關(guān)SpringBoot的@ControllerAdvice注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java中綴表達(dá)式轉(zhuǎn)后綴表達(dá)式流程詳解
中綴表達(dá)式是一個(gè)通用的算術(shù)或邏輯公式表示方法。，中綴表達(dá)式不容易被計(jì)算機(jī)解析，但仍被許多程序語言使用，因?yàn)樗先藗兊钠毡橛梅?。本文介紹了實(shí)現(xiàn)中綴表達(dá)式的方法，需要的可以參考一下2022-09-09
這篇文章主要介紹了基于zipoutputStream的簡單使用方式,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-12-12
這篇文章主要介紹了測量Java對象所占內(nèi)存大小方式,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
2023-09-09 
這篇文章主要介紹了詳解Java的Spring框架中bean的注入集合,Spring是Java的SSH三大web開發(fā)框架之一,需要的朋友可以參考下
2015-12-12 
java IO實(shí)現(xiàn)電腦搜索、刪除功能的實(shí)例
下面小編就為大家?guī)硪黄猨ava IO實(shí)現(xiàn)電腦搜索、刪除功能的實(shí)例。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧
2016-12-12 
Java中RabbitMQ隊(duì)列實(shí)現(xiàn)RPC詳解
這篇文章主要介紹了Java中RabbitMQ隊(duì)列實(shí)現(xiàn)RPC詳解,在本教程中,我們將使用RabbitMQ構(gòu)建一個(gè)RPC系統(tǒng)：一個(gè)客戶端和一個(gè)RPC服務(wù)器,我們將創(chuàng)建一個(gè)返回斐波那契數(shù)字的模擬RPC服務(wù),,需要的朋友可以參考下
2023-08-08 
詳解關(guān)于Windows10 Java環(huán)境變量配置問題的解決辦法
這篇文章主要介紹了關(guān)于Windows10 Java環(huán)境變量配置問題的解決辦法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
2019-03-03 
java微信開發(fā)API第二步 獲取和回復(fù)消息
這篇文章主要為大家詳細(xì)介紹了java微信開發(fā)API第二步，獲取消息和回復(fù)消息，感興趣的小伙伴們可以參考一下
2016-06-06 
在本篇文章里小編給大家?guī)砹岁P(guān)于Java遞歸求和1+2+3+...+n實(shí)例內(nèi)容，需要的朋友們可以學(xué)習(xí)參考下。
2020-01-01