Spring3.2之后引入的控制器通知@ControllerAdvice

怼烎@ 2022-05-29 07:11 133阅读 0赞

举例来说， 如果要在多个控制器中处理异常，那@ExceptionHandler注解所标注的方法是很有用的。 不过， 如果多个控制器类中都会抛出某个特定的异常， 那么你可能会发现要在所有的控制器方法中重复相同的@ExceptionHandler方法。 或者， 为了避免重复， 我们会创建一个基础的控制器类（BaseController）， 所有控制器类要扩展这个类， 从而继承通用的@ExceptionHandler方法。

Spring 3.2为这类问题引入了一个新的解决方案:控制器通知。 控制器通知（controller advice） 是任意带有@ControllerAdvice注解的类， 这个类会包含一个或多个如下类型的方法：

*  @ExceptionHandler注解标注的方法；
 *  @InitBinder注解标注的方法；
 *  @ModelAttribute注解标注的方法。

在带有@ControllerAdvice注解的类中， 以上所述的这些方法会运用到整个应用程序所有控制器中带有@RequestMapping注解的方法上。@ControllerAdvice注解本身已经使用了@Component， 因此@ControllerAdvice注解所标注的类将会自动被组件扫描获取到， 就像带有@Component注解的类一样。@ControllerAdvice最为实用的一个场景就是将所有的@ExceptionHandler方法收集到一个类中， 这样所有控制器的异常就能在一个地方进行一致的处理。

package com.niugang.exception;
    import org.springframework.boot.autoconfigure.web.MultipartProperties;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.multipart.MultipartException;
    import org.springframework.web.servlet.ModelAndView;
    /**
     * @ControllerAdvice
     * 它通常用于定义{@link ExceptionHandler @ExceptionHandler}、
     * {@link InitBinder @InitBinder}和{@link ModelAttribute @ModelAttribute}
     * 
     * 方法适用于所有{@link RequestMapping @RequestMapping}方法。
     * 
     * @author niugang 文件上传异常处理类
     *
     */
    @ControllerAdvice
    /**
     * 从配置文件根据前缀读取设置 处理需要字段外还需要，set方法，否则值注入不进来
     * 
     * @author niugang
     *
     */
    @ConfigurationProperties(prefix = "spring.http.multipart")
    public class FileUploadException {
    
    private String maxFileSize;
    
          public String getMaxFileSize() {
    return maxFileSize;
    }
    
    
    public void setMaxFileSize(String maxFileSize) {
    this.maxFileSize = maxFileSize;
    }
    
    
    @ExceptionHandler(MultipartException.class)
    public ModelAndView handleError1(MultipartException e) {
    
    
    ModelAndView modelAndView = new ModelAndView("upload");
    // 如果application.properties里面没有设置，则读取系统默认的文件大小
    if (this.getMaxFileSize() == null) {
    MultipartProperties multipartProperties = new MultipartProperties();
    modelAndView.addObject("uploadResult", "最大上传为：" + multipartProperties.getMaxFileSize());
    } else {
    modelAndView.addObject("uploadResult", "最大上传为：" + this.getMaxFileSize());
    }
    
    
    return modelAndView;
    }
    }

列如文件上传异常处理

**微信公众号** ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]: /images/20220529/59afdafd57c141388da063e61e5cfe60.png