SpringBoot中的@ControllerAdvice使用方法詳細解析

更新時間：2024年01月09日 10:52:56 作者：愛學(xué)習(xí)的小白菜！

這篇文章主要介紹了SpringBoot中的@ControllerAdvice使用方法詳細解析, 加了@ControllerAdvice的類為那些聲明了@ExceptionHandler、@InitBinder或@ModelAttribute注解修飾的方法的類而提供的專業(yè)化的@Component,以供多個 Controller類所共享,需要的朋友可以參考下

一.@ControllerAdvice是什么

? 首先，@ControllerAdvice本質(zhì)上是一個@Component，因此也會被當(dāng)成組件掃描。

在這里插入圖片描述

? 加了@ControllerAdvice的類為那些聲明了@ExceptionHandler、@InitBinder 或 @ModelAttribute注解修飾的方法的類而提供的專業(yè)化的@Component , 以供多個 Controller類所共享。說白了，就是aop思想的一種實現(xiàn)，你告訴我需要攔截規(guī)則，我?guī)湍惆阉麄償r下來，具體你想做更細致的攔截篩選和攔截之后的處理，你自己通過@ExceptionHandler、@InitBinder 或 @ModelAttribute這三個注解以及被其注解的方法來自定義。

@ExceptionHandler注解標(biāo)注的方法：用于捕獲Controller中拋出的不同類型的異常，從而達到異常全局處理的目的.
@InitBinder注解標(biāo)注的方法：用于請求中注冊自定義參數(shù)的解析，從而達到自定義請求參數(shù)格式的目的.
@ModelAttribute注解標(biāo)注的方法：表示此方法會在執(zhí)行目標(biāo)Controller方法之前執(zhí)行.

二.如何使用

ControllerAdvice 提供了多種指定Advice規(guī)則的定義方式，默認什么都不寫，則是Advice所有Controller，當(dāng)然你也可以通過下列的方式指定規(guī)則：

１.指定包

//匹配com.xzh.cn包及其子包下的所有Controller
@ControllerAdvice(basePackages="com.xzh.cn")
//數(shù)組形式指定
@ControllerAdvice(basePackages={"com.xzh.cn", "com.xzh.cn.controller"}),

2.指定注解

//匹配所有被這個注解修飾的 Controller，也可以匹配自定義的注解
@ControllerAdvice（annotations={RestController.class})

3.@ModelAttribute (預(yù)設(shè)全局數(shù)據(jù))

使用@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);
}

取出數(shù)據(jù)：

 //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();
}

4.@ExceptionHandler (處理全局異常 )

//處理BindException異常信息
@ExceptionHandler(BindException.class)
@ResponseBody
public Result exceptionHandler(BindException e, BindingResult result) {
   //邏輯處理
   return new Result();
}
//通用異常處理器,所有Exception異常都由這里處理
@ExceptionHandler(Exception.class)
@ResponseBody
public Result exceptionHandler(Exception e) {
    return new Result();
}

5. @InitBinder (請求參數(shù)預(yù)處理)

使用默認的屬性編輯器：

@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攻擊
 */
//@InitBinder
protected void initBinder2(WebDataBinder binder) {
    //自定義屬性編輯器 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 User implements Serializable {
    @ApiModelProperty("age")
    private Integer age;
    @ApiModelProperty("name")
    private String name;
}

@Component
public class UserValidator implements Validator {
	/**
	* @description:  滿足條件才往下走
	* @params:
	* @return:
	*/
    @Override
    public boolean supports(Class<?> clazz) {
        // 只支持ParamVO類型對象的校驗
        return User.class.equals(clazz);
    }
    /**
    * @description:  自定義校驗規(guī)則
    * @params:
    * @return:
    */
    @Override
    public void validate(Object target, Errors errors) {
        User user = (User) target;
        String userName = user.getName();
        if (StringUtils.isEmpty(userName) || userName.length() < 8) {
            errors.rejectValue("name", "valid.userNameLen", new Object[]{"minLength", 8}, "用戶名不能少于8位");
        }
    }
}

@Autowired
private UserValidator userValidator;
@InitBinder
public void initBinder(WebDataBinder dataBinder) {
    dataBinder.addValidators(userValidator);
}

到此這篇關(guān)于SpringBoot中的@ControllerAdvice使用方法詳細解析的文章就介紹到這了,更多相關(guān)@ControllerAdvice使用方法內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: