Java全局异常处理

1 Java异常分类

Java把异常当做对象来处理。Throwable是所有错误或异常的超类。Throwable类有两个直接子类：Error类和Exception类。

1. Error是指java运行时系统的内部错误和资源耗尽错误，是程序无法处理的异常，应用程序不会抛出该类对象。

2. Exception是程序本身可以处理的异常，应尽可能去处理这些异常。Exception分两类，一个是运行时异常RuntimeException，一个是检查异常CheckedException。

3. CheckedException一般是外部错误，这种异常都发生在编译阶段，Java编译器会强制程序去捕获此类异常。

4. RuntimeException是那些可能在Java 虚拟机正常运行期间抛出的异常的超类。这种错误是由程序员引起的错误，可以修正代码解决。

2 用@ControllerAdvice+@ExceptionHandler实现全局异常处理

通常在Controller层需要去捕获service层的异常，防止返回一些不友好的错误信息到客户端，但如果Controller层每个方法都用模块化的try-catch代码去捕获异常，会很难看也难维护。

异常处理最好是解耦的，并且都放在一个地方集中管理。Spring能够较好的处理这种问题，核心如下，这里主要关注前两个：

@ExceptionHandler：统一处理某一类异常，从而能够减少代码重复率和复杂度

@ControllerAdvice：异常集中处理，更好的使业务逻辑与异常处理剥离开

@ResponseStatus：可以将某种异常映射为HTTP状态码

单使用@ExceptionHandler，只能在当前Controller中处理异常，与@ControllerAdvice组合使用，则可以实现全局异常处理，不用每个controller都配置。

2.1 全局异常处理类

下面通过一个实际项目代码来看一下@ControllerAdvice+@ExceptionHandler的使用。

@ControllerAdvice定义全局异常处理类GlobalExceptionHandler

@ExceptionHandler声明异常处理方法，使用value指定异常类，value = Exception.class表示处理Controller层抛出的Exception及其子类的异常，这样Controller层代码就不需要进行异常处理了。

GlobalExceptionHandler类中对多个异常进行了处理，这些异常分两类，一类是自定义异常，如AuthenticationException、BadRequestException，一类是非自定义异常，如HttpRequestMethodNotSupportedException、TypeMismatchException等。

2.2 自定义异常

一般项目中都会有一些业务相关（非JVM抛出）的异常，可以使用自定义异常继承相关的异常来抛出有用的异常信息，其类名要能体现具体的异常信息，这样根据异常名就可以知道哪里有异常，根据异常提示信息进行程序修改。比如空指针异常NullPointException，可以抛出message为“xxx为空”定位异常位置，而不用输出堆栈信息。

自定义异常通常是定义一个继承自Exception类的子类，一般会直接继承自Exception类，而不会继承某个运行时的异常类。

下面是项目代码中自定义异常的使用。

定义自定义异常类AuthenticationException，继承Exception类：

在Service层抛出AuthenticationException：

2.3 数据校验异常处理

代码中可以使用@RequestBody+@Valid进行数据绑定和数据校验。

@Valid注解是什么

@Valid

用于验证注解是否符合要求，直接加在变量user之前，在变量中添加验证信息的要求，当不符合要求时就会在方法中返回message 的错误提示信息。

@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping
    public User create (@Valid @RequestBody User user) {
        System.out.println(user.getId());
        System.out.println(user.getUsername());
        System.out.println(user.getPassword());
        user.setId("1");
        return user;
    }
}    

然后在 User 类中添加验证信息的要求：

public class User {
    private String id;  
 
    @NotBlank(message = "密码不能为空")
    private String password;
}

@NotBlank 注解所指的 password 字段，表示验证密码不能为空，如果为空的话，上面 Controller 中的 create 方法会将message 中的"密码不能为空"返回。

当然也可以添加其他验证信息的要求：

限制	说明
@Null	限制只能为null
@NotNull	限制必须不为null
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个将来的日期
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Past	限制必须是一个过去的日期
@Pattern(value)	限制必须符合指定的正则表达式
@Size(max,min)	限制字符长度必须在min到max之间
@Past	验证注解的元素值（日期类型）比当前时间早
@NotEmpty	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email	验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

除此之外还可以自定义验证信息的要求，例如下面的 @MyConstraint：

public class User {
 
    private String id;
 
    @MyConstraint(message = "这是一个测试")
    private String username;
 
}

注解的具体内容：

@Constraint(validatedBy = {MyConstraintValidator.class})
@Target({ELementtype.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyConstraint {
    String message();
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {}; 
}

下面是校验器：

public class MyConstraintValidator implements ConstraintValidator<MyConstraint, Object> {
    @Autowired
    private UserService userService;
    
    @Override
    public void initialie(@MyConstraint constarintAnnotation) {
        System.out.println("my validator init");
    }
    
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        userService.getUserByUsername("seina");
        System.out.println("valid");
        return false;
    }
}

下面是项目代码中对Post请求表单的处理，通过@RequestBody将请求body中的json与表单对象（CreateOrderRequestVO）绑定，使用@Valid进行表单验证。如果不使用@Valid，CreateOrderRequestVO中的@NotNull等注解不生效。

在表单对象CreateOrderRequestVO类的相应字段上添加用于充当校验条件的注解（@NotNull、@NotBlank、@Min等）。

数据校验失败时，Spring MVC 框架会抛出 MethodArgumentNotValidException 异常， 在 GlobalExceptionHandler 中加上对 MethodArgumentNotValidException 异常的声明和处理，就可以全局处理数据校验的异常了。

附全局异常处理类

package api.util;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
 
import api.framework.dto.Result;
import api.framework.exception.ServiceException;
 
/**
 * 全局异常处理器,处理新增的异常，对于有特殊逻辑的返回直接定义个新方法，参考ServiceException
 */
@ControllerAdvice
@Component
@ResponseBody
public class GlobalExceptionHandler {
    
    private final static Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    
    @ExceptionHandler(ServiceException.class)
    public Result<String> handlerServiceException(ServiceException e){
        return new Result<String>("error", e.getMessage(), "", "", e.getCode());
    }
    
 
    @ExceptionHandler(Exception.class)
    public Result<String> handlerException(Exception e){
        LOGGER.error("Oops", e);
        return new Result<String>("error", "网络异常", "", "", "500");
    }
}

package api.framework.exception;
 
/**
 * <p>
 * 业务异常，这里约定每个业务场景的错误都是有一个错误码的。
 * </p>
 * <p>
 * 这个错误码需要展示给前端。前端需要根据这个码值做一些特殊的判断。如余额不足，
 * 错误码 001，那么前端根据这个码值引导用户去充值页面。
 * <p>
 */
public class ServiceException extends RuntimeException{
 
    private static final long serialVersionUID = 228211L;
    
    private String code;
    
    /**
     * 构造一个业务异常类
     * 
     * @param code 错误码,注意约定的业务错误码都是大于600的
     * @param message 错误信息
     */
    public ServiceException(String code, String message){
        super(message);
        this.code = code;
    }
 
    /**
     * 返回错误码
     * @return 错误码
     */
    public String getCode() {
        return code;
    }
}