Spring中的@ControllerAdvice三種用法詳解
@ControllerAdvice三種用法
首先,@ControllerAdvice本質(zhì)上是一個(gè)@Component,因此也會(huì)被當(dāng)成組建掃描。
加了@ControllerAdvice的類為那些聲明了(@ExceptionHandler、@InitBinder 或 @ModelAttribute注解修飾的)方法的類而提供的 專業(yè)化的@Component , 以供多個(gè) Controller類所共享。 說白了,就是aop思想的一種實(shí)現(xiàn),你告訴我需要攔截規(guī)則,我?guī)湍惆阉麄償r下來,具體你想做更細(xì)致的攔截篩選和攔截之后的處理, 你自己通過@ExceptionHandler、@InitBinder 或 @ModelAttribute這三個(gè)注解以及被其注解的方法來自定義。
- @ExceptionHandler注解標(biāo)注的方法:用于捕獲Controller中拋出的不同類型的異常,從而達(dá)到異常全局處理的目的;
- @InitBinder注解標(biāo)注的方法:用于請(qǐng)求中注冊(cè)自定義參數(shù)的解析,從而達(dá)到自定義請(qǐng)求參數(shù)格式的目的;
- @ModelAttribute注解標(biāo)注的方法:表示此方法會(huì)在執(zhí)行目標(biāo)Controller方法之前執(zhí)行
這三個(gè)注解都可以在普通的Controller類上使用,ControllerAdvice只是作用范圍可以自定義(默認(rèn)全部)
1.作用范圍
? ControllerAdvice 提供了多種指定Advice規(guī)則的定義方式,默認(rèn)什么都不寫,則是Advice所有Controller,當(dāng)然你也可以通過下列的方式指定規(guī)則 比如:
- 指定包
//匹配org.my.pkg包及其子包下的所有Controller
@ControllerAdvice(basePackages="org.my.pkg")
//當(dāng)然也可以用數(shù)組的形式指定,如:
@ControllerAdvice(basePackages={"org.my.pkg", "org.my.other.pkg"}),- 指定注解
也可以通過指定注解來匹配,比如我自定了一個(gè) @CustomAnnotation 注解,我想匹配所有被這個(gè)注解修飾的 Controller, 可以這么寫:
@ControllerAdvice(annotations={CustomAnnotation.class})
2.預(yù)設(shè)全局?jǐn)?shù)據(jù) @ModelAttribute
? 使用@ModelAttribute可以在controller請(qǐng)求前存入數(shù)據(jù)
// 1.無返回值方法,放入Model,自定義 key ,value
@ModelAttribute()
public void presetParam(Model model) {
model.addAttribute("globalAttr", "我是全局參數(shù)");
}
// 2.不有指定name,返回值方法,返回值是map,int等,key就是map,int等,,value是返回值
@ModelAttribute()
public Map<String, String> presetParam2() {
Map<String, String> map1 = new HashMap<String, String>();
map1.put("key1", "value1");
return map1;
}
// 3.指定name,返回值方法,key就是name,value是返回值
@ModelAttribute(name = "map2")
public Map<String, String> presetParam3() {
Map<String, String> map = new HashMap<String, String>();
map.put("key2", "value2");
return map;
}
// 4.可以接受請(qǐng)求參數(shù)
@ModelAttribute()
public void presetParam4(@RequestParam("name") String name,Model model) {
model.addAttribute("name", name);
}- 使用
//1.使用Model取出
@GetMapping("model")
public String methodOne(Model model) {
Map<String, Object> modelMap = model.asMap();
System.out.println(modelMap.get("name").toString()); // 傳入name的值
return modelMap.get("globalAttr").toString();
}
//2.使用ModelMap取出
@GetMapping("modelMap")
public String methodThree(ModelMap modelMap) {
return modelMap.get("map").toString();
}
//3.@ModelAttribute()指定key,直接取出
@GetMapping("modelAttribute")
public String methodTwo(@ModelAttribute("map2") Map map2) {
return map2.toString();
}3.處理全局異常 @ExceptionHandler
// @Validated參數(shù)校驗(yàn) ,解析BindingResult的錯(cuò)誤信息并返回
@ExceptionHandler(BindException.class)
@ResponseBody
public JsonResult exceptionHandler(BindException e, BindingResult result) {
List<FieldError> fieldErrors = result.getFieldErrors();
String collect = fieldErrors.stream().map(f -> f.getField()+":"+f.getDefaultMessage()).collect(Collectors.joining(","));
return new JsonResult(JsonResult.Validated_ERROR, collect);
}
//這里就是通用的異常處理器了,所有預(yù)料之外的Exception異常都由這里處理
@ExceptionHandler(Exception.class)
@ResponseBody
public JsonResult exceptionHandler(Exception e) {
return new JsonResult(JsonResult.SYSTEM_ERROR, e.getMessage());
}4.請(qǐng)求參數(shù)預(yù)處理 @InitBinder
使用默認(rèn)的屬性編輯器
@InitBinder
public void initBinder(WebDataBinder dataBinder){
/*
* 創(chuàng)建一個(gè)字符串微調(diào)編輯器
* 參數(shù){boolean emptyAsNull}: 是否把空字符串("")視為 null
*/
StringTrimmerEditor trimmerEditor = new StringTrimmerEditor(true);
/*
* 注冊(cè)自定義編輯器
* 接受兩個(gè)參數(shù){Class<?> requiredType, PropertyEditor propertyEditor}
* requiredType:所需處理的類型
* propertyEditor:屬性編輯器,StringTrimmerEditor就是 propertyEditor的一個(gè)子類
*/
dataBinder.registerCustomEditor(String.class, trimmerEditor);
//日期格式的字符串轉(zhuǎn)換成Date對(duì)象
dataBinder.registerCustomEditor(Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"), false));
dataBinder.addValidators(paramVOValidator);
}
自定義屬性編輯器
/**
* @description: 防止xss注入
* @params: String類型轉(zhuǎn)換,將所有傳遞進(jìn)來的String進(jìn)行HTML編碼,防止XSS攻擊
* @return:
*/
//@InitBinder
protected void initBinder2(WebDataBinder binder) {
System.out.println("22222222222222");
//自定義屬性編輯器 PropertyEditorSupport
binder.registerCustomEditor(String.class, new PropertyEditorSupport() {
@Override
public void setAsText(String text) {
setValue(text == null ? null : StringEscapeUtils.escapeHtml4(text.trim()));
}
@Override
public String getAsText() {
Object value = getValue();
return value != null ? value.toString() : "";
}
});
}自定義參數(shù)校驗(yàn) @Validated!!!
@Data
public class ParamVO implements Serializable {
@ApiModelProperty("age")
private Integer age;
@ApiModelProperty("name")
private String name;
}
@Component
public class ParamVOValidator implements Validator {
/**
* @description: 滿足條件才往下走
* @params:
* @return:
*/
@Override
public boolean supports(Class<?> clazz) {
// 只支持ParamVO類型對(duì)象的校驗(yàn)
return ParamVO.class.equals(clazz);
}
/**
* @description: 自定義校驗(yàn)規(guī)則
* @params:
* @return:
*/
@Override
public void validate(Object target, Errors errors) {
ParamVO paramVO = (ParamVO) target;
String userName = paramVO.getName();
if (StringUtils.isEmpty(userName) || userName.length() < 8) {
errors.rejectValue("name", "valid.userNameLen", new Object[]{"minLength", 8}, "用戶名不能少于8位");
}
}
}
@Autowired
private ParamVOValidator paramVOValidator;
@InitBinder
public void initBinder(WebDataBinder dataBinder) {
dataBinder.addValidators(paramVOValidator);
}
注意!!!這三個(gè)注解都可以在普通的Controller類上使用,ControllerAdvice只是作用范圍可以自定義(默認(rèn)全部)
到此這篇關(guān)于Spring中的@ControllerAdvice三種用法詳解的文章就介紹到這了,更多相關(guān)@ControllerAdvice三種用法內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
基于Spring Security實(shí)現(xiàn)RBAC權(quán)限控制的完整步驟
文章主要講述了基于角色的訪問控制(RBAC)的基本概念、SpringSecurity的核心功能,以及實(shí)現(xiàn)RBAC的詳細(xì)步驟,包括定義用戶模型和角色、密碼加密、JWT工具類、讓SpringSecurity認(rèn)識(shí)用戶的用戶模型、JWT認(rèn)證過濾器以及安全配置規(guī)則等,需要的朋友可以參考下2026-04-04
Mybatis入門教程(四)之mybatis動(dòng)態(tài)sql
這篇文章主要介紹了Mybatis入門教程(四)之mybatis動(dòng)態(tài)sql的相關(guān)資料,涉及到動(dòng)態(tài)sql及動(dòng)態(tài)sql的作用知識(shí),本文介紹的非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-09-09
SpringBoot項(xiàng)目的多文件兼多線程上傳下載
本文主要介紹了SpringBoot項(xiàng)目的多文件兼多線程上傳下載,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
java實(shí)現(xiàn)監(jiān)控rtsp流轉(zhuǎn)flv方法實(shí)例(前端播放,前后端代碼都有)
這篇文章主要給大家介紹了關(guān)于java實(shí)現(xiàn)監(jiān)控rtsp流轉(zhuǎn)flv的相關(guān)資料,文中介紹的是前端播放,前后端代碼都有,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-06-06
關(guān)于java.lang.NumberFormatException: null的問題及解決
這篇文章主要介紹了關(guān)于java.lang.NumberFormatException: null的問題及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-09-09
IDEA之web項(xiàng)目導(dǎo)入jar包方式
這篇文章主要介紹了IDEA之web項(xiàng)目導(dǎo)入jar包方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-05-05
idea移除子模塊實(shí)現(xiàn)Moudle后重新導(dǎo)入
文章介紹了如何在項(xiàng)目中重新添加一個(gè)移除的模塊,提供了兩種方法:通過Project Structure導(dǎo)入模塊或手動(dòng)創(chuàng)建package并進(jìn)行修改2026-02-02

