Spring3.2新注解@ControllerAdvice

忘是亡心i 2022-09-25 08:27 161阅读 0赞

@ControllerAdvice，是spring3.2提供的新注解，从名字上可以看出大体意思是控制器增强。  
注解@ControllerAdvice的代码：

@Target(ElementType.TYPE)  
    @Retention(RetentionPolicy.RUNTIME)  //规定注解时长
    @Documented  
    @Component  
    public @interface ControllerAdvice {   
    
    }

该注解使用了@Component注解，这样的话当我们使用`<context:component-scan>`扫描时也能扫描到。

其javadoc定义：

/** * Indicates the annotated class assists a "Controller". * * <p>Serves as a specialization of { @link Component @Component}, allowing for * implementation classes to be autodetected through classpath scanning. * * <p>It is typically used to define { @link ExceptionHandler @ExceptionHandler}, * { @link InitBinder @InitBinder}, and { @link ModelAttribute @ModelAttribute} * methods that apply to all { @link RequestMapping @RequestMapping} methods. * * @author Rossen Stoyanchev * @since 3.2 */

即把**@ControllerAdvice注解内部**使用@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法应用到所有的 @RequestMapping注解的方法。非常简单，**不过只有当使用@ExceptionHandler最有用**，另外两个用处不大。  
如下面代码中的processUnauthenticatedException方法就会应用到有@RequestMapping注解的方法。

代码：

@ControllerAdvice  
    public class ControllerAdviceTest {   
    
        @ModelAttribute  
        public User newUser() {  
            System.out.println("============应用到所有@RequestMapping注解方法，在其执行之前把返回值放入Model");  
            return new User();  
        }  
    
        @InitBinder  
        public void initBinder(WebDataBinder binder) {  
            System.out.println("============应用到所有@RequestMapping注解方法，在其执行之前初始化数据绑定器");  
        }  
    
        @ExceptionHandler(UnauthenticatedException.class)  
        @ResponseStatus(HttpStatus.UNAUTHORIZED)  
        public String processUnauthenticatedException(NativeWebRequest request, UnauthenticatedException e) {  
            System.out.println("===========应用到所有@RequestMapping注解的方法，在其抛出UnauthenticatedException异常时执行");  
            return "viewName"; //返回一个逻辑视图名 
        }  
    }

如果你的spring-mvc配置文件使用如下方式扫描bean  
Java代码 收藏代码

需要把@ControllerAdvice包含进来，否则不起作用：  
Java代码 收藏代码

<context:component-scan base-package="com.sishuok.es" use-default-filters="false">  
           <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>  
           <context:include-filter type="annotation" expression="org.springframework.web.bind.annotation.ControllerAdvice"/>  
    </context:component-scan>

1、@ModelAttribute注解的方法作用跟springMVC中的作用是一样的，只不过此处是对所有的@RequestMapping注解的方法都起作用。当需要设置全局数据时比较有用。

2、@InitBinder注解的方法作用同1类似。当需要全局注册时比较有用。

3、@ExceptionHandler，异常处理器，此注解的作用是当出现其定义的异常时进行处理的方法，其可以使用springmvc提供的数据绑定，比如注入HttpServletRequest等，还可以接受一个当前抛出的Throwable对象。

该注解非常简单，大多数时候其实只@ExceptionHandler比较有用，其他两个用到的场景非常少，这样可以把异常处理器应用到所有控制器，而不是@Controller注解的单个控制器。

来源：[http://jinnianshilongnian.iteye.com/blog/1866350][http_jinnianshilongnian.iteye.com_blog_1866350]

我在实际项目中遇到的：

@ControllerAdvice  //增强注解
    @ResponseBody 
    public class ExceptionAdvice { 
         /** * 400 - Bad Request */  
        @ResponseStatus(HttpStatus.BAD_REQUEST)  
        @ExceptionHandler(HttpMessageNotReadableException.class)  
        public BaseResult handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {  
    // logger.error("参数解析失败", e); 
            return new BaseResult().failure("could_not_read_json");  
        }  
    
        /** * 405 - Method Not Allowed */  
        @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)  
        @ExceptionHandler(HttpRequestMethodNotSupportedException.class)  
        public BaseResult handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {  
    // logger.error("不支持当前请求方法", e); 
            return new BaseResult().failure("request_method_not_supported");  
        }  
    
        /** * 415 - Unsupported Media Type */  
        @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)  
        @ExceptionHandler(HttpMediaTypeNotSupportedException.class)  
        public BaseResult handleHttpMediaTypeNotSupportedException(Exception e) {  
    // logger.error("不支持当前媒体类型", e); 
            return new BaseResult().failure("content_type_not_supported");  
        }  
    
        /** * 500 - Internal Server Error */  
        @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)  
        @ExceptionHandler(Exception.class)  
        public BaseResult handleException(Exception e) {  
    // logger.error("服务运行异常", e); 
            return new BaseResult().failure(e.getLocalizedMessage());  
        }  
    }

上面使用了@ControllerAdvice注解的类里的方法，会在控制器代码里出现相应错误时调用，然后返回一个结果到前端。

[http_jinnianshilongnian.iteye.com_blog_1866350]: http://jinnianshilongnian.iteye.com/blog/1866350