Spring中的@ControllerAdvice三種用法詳解
@ControllerAdvice三種用法
首先,@ControllerAdvice本質(zhì)上是一個@Component,因此也會被當成組建掃描。
加了@ControllerAdvice的類為那些聲明了(@ExceptionHandler、@InitBinder 或 @ModelAttribute注解修飾的)方法的類而提供的 專業(yè)化的@Component , 以供多個 Controller類所共享。 說白了,就是aop思想的一種實現(xiàn),你告訴我需要攔截規(guī)則,我?guī)湍惆阉麄償r下來,具體你想做更細致的攔截篩選和攔截之后的處理, 你自己通過@ExceptionHandler、@InitBinder 或 @ModelAttribute這三個注解以及被其注解的方法來自定義。
- @ExceptionHandler注解標注的方法:用于捕獲Controller中拋出的不同類型的異常,從而達到異常全局處理的目的;
- @InitBinder注解標注的方法:用于請求中注冊自定義參數(shù)的解析,從而達到自定義請求參數(shù)格式的目的;
- @ModelAttribute注解標注的方法:表示此方法會在執(zhí)行目標Controller方法之前執(zhí)行
這三個注解都可以在普通的Controller類上使用,ControllerAdvice只是作用范圍可以自定義(默認全部)
1.作用范圍
? ControllerAdvice 提供了多種指定Advice規(guī)則的定義方式,默認什么都不寫,則是Advice所有Controller,當然你也可以通過下列的方式指定規(guī)則 比如:
- 指定包
//匹配org.my.pkg包及其子包下的所有Controller @ControllerAdvice(basePackages="org.my.pkg") //當然也可以用數(shù)組的形式指定,如: @ControllerAdvice(basePackages={"org.my.pkg", "org.my.other.pkg"}),
- 指定注解
也可以通過指定注解來匹配,比如我自定了一個 @CustomAnnotation 注解,我想匹配所有被這個注解修飾的 Controller, 可以這么寫:
@ControllerAdvice(annotations={CustomAnnotation.class})
2.預設全局數(shù)據(jù) @ModelAttribute
? 使用@ModelAttribute可以在controller請求前存入數(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.可以接受請求參數(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ù)校驗 ,解析BindingResult的錯誤信息并返回 @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); } //這里就是通用的異常處理器了,所有預料之外的Exception異常都由這里處理 @ExceptionHandler(Exception.class) @ResponseBody public JsonResult exceptionHandler(Exception e) { return new JsonResult(JsonResult.SYSTEM_ERROR, e.getMessage()); }
4.請求參數(shù)預處理 @InitBinder
使用默認的屬性編輯器
@InitBinder public void initBinder(WebDataBinder dataBinder){ /* * 創(chuàng)建一個字符串微調(diào)編輯器 * 參數(shù){boolean emptyAsNull}: 是否把空字符串("")視為 null */ StringTrimmerEditor trimmerEditor = new StringTrimmerEditor(true); /* * 注冊自定義編輯器 * 接受兩個參數(shù){Class<?> requiredType, PropertyEditor propertyEditor} * requiredType:所需處理的類型 * propertyEditor:屬性編輯器,StringTrimmerEditor就是 propertyEditor的一個子類 */ dataBinder.registerCustomEditor(String.class, trimmerEditor); //日期格式的字符串轉(zhuǎn)換成Date對象 dataBinder.registerCustomEditor(Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"), false)); dataBinder.addValidators(paramVOValidator); }
自定義屬性編輯器
/** * @description: 防止xss注入 * @params: String類型轉(zhuǎn)換,將所有傳遞進來的String進行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ù)校驗 @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類型對象的校驗 return ParamVO.class.equals(clazz); } /** * @description: 自定義校驗規(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); }
注意!!!這三個注解都可以在普通的Controller類上使用,ControllerAdvice只是作用范圍可以自定義(默認全部)
到此這篇關(guān)于Spring中的@ControllerAdvice三種用法詳解的文章就介紹到這了,更多相關(guān)@ControllerAdvice三種用法內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
tio-boot?jfinal-plugins框架整合redis示例詳解
這篇文章主要為大家介紹了tio-boot?jfinal-plugins框架整合redis示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-12-12java狀態(tài)機方案解決訂單狀態(tài)扭轉(zhuǎn)示例詳解
這篇文章主要為大家介紹了java狀態(tài)機方案解決訂單狀態(tài)扭轉(zhuǎn)示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-03-03spring boot 本地圖片不能加載(圖片路徑)的問題及解決方法
這篇文章主要介紹了spring boot 本地圖片不能加載(圖片路徑)的問題,解決的辦法其實很簡單,只要寫一個配置文件,也就是圖片位置的轉(zhuǎn)化器,原理是虛擬一個在服務器上的文件夾,與本地圖片的位置進行匹配。需要的朋友可以參考下2018-04-04深度解析Java中的國際化底層類ResourceBundle
做項目應該都會實現(xiàn)國際化,那么大家知道Java底層是如何實現(xiàn)國際化的嗎?這篇文章就來和大家深度解析一下Java中的國際化底層類ResourceBundle,希望對大家有所幫助2023-03-03SpringCloud將Nacos作為配置中心實現(xiàn)流程詳解
這篇文章主要介紹了Springcloud中的Nacos Config服務配置,本文以用戶微服務為例,進行統(tǒng)一的配置,結(jié)合實例代碼給大家介紹的非常詳細,需要的朋友可以參考下2022-10-10SpringBoot動態(tài)生成接口實現(xiàn)流程示例講解
最近遇到一個需求,需要在程序運行過程中,可以動態(tài)新增接口,自定義接口參數(shù)名稱,基本類型,以及請求方法,請求頭等等。通過幾天的研究,找到了我需要的解決方案2023-01-01