@ControllerAdvice 的介绍

@ControllerAdvice 的介绍

一.@ControllerAdvice是什么

​ 首先，@ControllerAdvice本质上是一个@Component，因此也会被当成组件扫描。

​ 加了@ControllerAdvice的类为那些声明了@ExceptionHandler、@InitBinder 或 @ModelAttribute注解修饰的 方法的类而提供的专业化的@Component , 以供多个 Controller类所共享。说白了，就是aop思想的一种实现，你告诉我需要拦截规则，我帮你把他们拦下来，具体你想做更细致的拦截筛选和拦截之后的处理，你自己通过@ExceptionHandler、@InitBinder 或 @ModelAttribute这三个注解以及被其注解的方法来自定义。

• @ExceptionHandler注解标注的方法：用于捕获Controller中抛出的不同类型的异常，从而达到异常全局处理的目的.
• @InitBinder注解标注的方法：用于请求中注册自定义参数的解析，从而达到自定义请求参数格式的目的.
• @ModelAttribute注解标注的方法：表示此方法会在执行目标Controller方法之前执行.

二.如何使用

ControllerAdvice 提供了多种指定Advice规则的定义方式，默认什么都不写，则是Advice所有Controller，当然你也可以通过下列的方式指定规则：

１.指定包

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

2.指定注解

//匹配所有被这个注解修饰的 Controller，也可以匹配自定义的注解
@ControllerAdvice（annotations={RestController.class})

3.@ModelAttribute (预设全局数据)

使用@ModelAttribute可以在controller请求前存入数据

// 1.无返回值方法,放入Model,自定义 key ,value
@ModelAttribute()
public void presetParam(Model model) {
    model.addAttribute("globalAttr", "我是全局参数");
}
// 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.可以接受请求参数
@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();
}

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 (请求参数预处理)

使用默认的属性编辑器：

@InitBinder
public void initBinder(WebDataBinder dataBinder) {
    /*
     * 创建一个字符串微调编辑器
     * 参数{boolean emptyAsNull}: 是否把空字符串("")视为 null
     */
    StringTrimmerEditor trimmerEditor = new StringTrimmerEditor(true);
    /*
     * 注册自定义编辑器
     * 接受两个参数{Class<?> requiredType, PropertyEditor propertyEditor}
     * requiredType：所需处理的类型
     * propertyEditor：属性编辑器，StringTrimmerEditor就是 propertyEditor的一个子类
     */
    dataBinder.registerCustomEditor(String.class, trimmerEditor);
    //日期格式的字符串转换成Date对象
    dataBinder.registerCustomEditor(Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"), false));
    dataBinder.addValidators(paramVOValidator);
}

自定义属性编辑器：

/**
 * @description:  防止xss注入
 * @params:  String类型转换，将所有传递进来的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() : "";
        }
    });
}

自定义参数校验 @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:  自定义校验规则
    * @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);
}