@ControllerAdvice注解和@ExceptionHandle注解的使用

墨蓝 2024-01-03 06:54 224阅读 0赞

## @ControllerAdvice注解 ##

查看源码，可以看到@ControllerAdvice注解有以下几个方法，可以用来指定作用范围。

@AliasFor("basePackages")
    String[] value() default {};
    
    @AliasFor("value")
    String[] basePackages() default {};
    
    Class<?>[] basePackageClasses() default {};
    
    Class<?>[] assignableTypes() default {};
    
    Class<? extends Annotation>[] annotations() default {};

一般常用的为annotations，使用方式如下举例，即对@RestController或者@ResponseBody修饰的类起作用。特别注意的是，指定的是类，而不是某个方法。如果不指定范围，@ControllerAdvice默认对所有的controller起作用。

@ControllerAdvice(annotations = {RestController.class, ResponseBody.class})

该注解最常用的就是进行全局异常处理，代码举例如下

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.bind.annotation.RestController;
    
    
    @ControllerAdvice(annotations = {RestController.class, ResponseBody.class})
    @ResponseBody
    public class ApiExceptionHandler {
    
        private static final Logger LOGGER = LoggerFactory.getLogger(ApiExceptionHandler.class);
    
        @ExceptionHandler(value = Exception.class)
        public Object exceptionHandler(Exception e) {
            LOGGER.error("exceptionHandler", e);
            return null;
        }
    
        @ExceptionHandler(value = RuntimeException.class)
        public Object runtimeExceptionHandler(RuntimeException e) {
            LOGGER.error("runtimeExceptionHandler...", e);
            if (false) {
                throw new NumberFormatException("ddd");
            }
            return null;
        }
    
    
        @ExceptionHandler(value = CustomException.class)
        public Object customExceptionHandler(CustomException e) {
            LOGGER.error("customExceptionHandler", e);
            return null;
        }
    }

其中，RuntimeException继承了Exception，CustomException 继承了RuntimeException。

从测试结果来看，如果是抛出的CustomException，则由customExceptionHandler进行处理，如果是其他的RuntimeException，如空指针异常，则由runtimeExceptionHandler。其他受检查的异常比如IOException将有exceptionHandler进行处理。

## @ExceptionHandle注解 ##

API文档如下[https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/ExceptionHandler.html][https_docs.spring.io_spring-framework_docs_current_javadoc-api_org_springframework_web_bind_annotation_ExceptionHandler.html]

可以用于类或者方法上，作用于方法上时，参数是灵活多变的，但是常用的第一个是拦截的异常，第二个可能就是`HttpServletRequest了`

举例：

@ExceptionHandler(value = CustomException.class)
        public Object customExceptionHandler(CustomException e, HttpServletRequest request) {
            String s = request.getRequestURL().toString();
            LOGGER.error("customExceptionHandler", e);
            return null;
        }

##  ##

[https_docs.spring.io_spring-framework_docs_current_javadoc-api_org_springframework_web_bind_annotation_ExceptionHandler.html]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/ExceptionHandler.html