作者:鱼仔
博客首页: codeease.top (opens new window)
公众号:Java鱼仔

（一）概述

异常处理是一个系统最重要的环节，当一个项目变得很大的时候，异常处理和日志系统能让你快速定位到问题。对于用户或者接口调用者而言，优雅的异常处理可以让调用者快速知道问题所在。本文将介绍如何优雅地处理异常。

（二）使用通用的返回体

我们希望所有的错误都以Json的方式返回给客户，因此拿出上次写的通用返回体，新建一个类CommonResult记录返回体。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CommonResult {
    private int code;
    private String message;
    private Object data;
}

新建一个枚举类ResponseCode集成code和message。

public enum ResponseCode {

    // 系统模块
    SUCCESS(0, "操作成功"),
    ERROR(1, "操作失败"),
    SERVER_ERROR(500, "服务器异常"),

    // 通用模块 1xxxx
    ILLEGAL_ARGUMENT(10000, "参数不合法"),
    REPETITIVE_OPERATION(10001, "请勿重复操作"),
    ACCESS_LIMIT(10002, "请求太频繁, 请稍后再试"),
    MAIL_SEND_SUCCESS(10003, "邮件发送成功"),

    // 用户模块 2xxxx
    NEED_LOGIN(20001, "登录失效"),
    USERNAME_OR_PASSWORD_EMPTY(20002, "用户名或密码不能为空"),
    USERNAME_OR_PASSWORD_WRONG(20003, "用户名或密码错误"),
    USER_NOT_EXISTS(20004, "用户不存在"),
    WRONG_PASSWORD(20005, "密码错误"),
    ;

    ResponseCode(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    private Integer code;
    private String msg;
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

（三）自定义运行时异常

自定义一个运行时异常类，构造方法传入异常参数即可。

public class MyException extends RuntimeException{
    private String msg;

    public MyException(String msg) {
        super(msg);
    }
}

（四）编写一个统一的异常处理类

异常处理类是整个异常处理核心，SpringBoot中提供了ControllerAdvice注解来拦截异常，使用RestControllerAdvice注解保证了返回Json格式。

如果拦截到的异常属于MyException，则按Json格式返回错误结果。

@RestControllerAdvice
public class ExceptionController {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(value = Exception.class)
    public CommonResult exceptionHandler(Exception e){
        //如果抛出的异常属于自定义异常，就以JSON格式返回
        if (e instanceof MyException){
            return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"自定义的错误为："+e.getMessage());
        }
        //如果都不是就打印出异常的信息
        return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"错误的信息为："+e.getMessage());
    }
}

（五）测试

为了看初效果，这里手动抛出一个异常来测试，新建IndexController，手动抛出异常

@RestController
public class IndexController {

    @RequestMapping(value = "/index",method = RequestMethod.GET)
    public String index(){
        throw new MyException("测试");
    }
}

查看调用结果：

（六）对实体类的校验

有这样一个场景，登陆注册时用户名和密码有长度限制，手机号有格式限制，如果不满足要求就无法注册。这个功能前端可以限制，但是对于后端接口而言，也需要进行限制，万一前端没有限制住呢。

导入两个校验依赖包：

<!--校验-->
<!-- https://mvnrepository.com/artifact/javax.validation/validation-api -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.hibernate/hibernate-validator -->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.0.Final</version>
</dependency>

编写实体类，在每个属性上加上校验包的验证参数。

@Data
public class Register {

    @Length(max = 20,min = 4,message = "用户名长度需要在4到20个字符之间")
    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^1[3|4|5|8][0-9]\\d{8}$",message = "电话号码格式不正确")
    private String phone;

    @Length(max = 20,min = 4,message = "密码长度需要在4到20个字符之间")
    @NotBlank(message = "密码不能为空")
    private String password;
}

我们在需要使用的方法中增加@Valid注解进行校验，比如这个post请求中我要校验。

@PostMapping("/register")
public CommonResult register(@Valid @RequestBody Register register){
    //一连串注册的业务
    userService.registerUser(register);
    return new CommonResult(ResponseCode.SUCCESS.getCode(),ResponseCode.SUCCESS.getMsg(),"");
}

@Valid在校验失败的情况下会报出参数不合法的异常，还是在统一的异常处理类中捕获异常，如果是MethodArgumentNotValidException，就取出对应的message数据。

@RestControllerAdvice
public class ExceptionController {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(value = Exception.class)
    public CommonResult exceptionHandler(Exception e){
        //如果属于参数校验异常，就抛出校验的错误
        if (e instanceof MethodArgumentNotValidException){
            MethodArgumentNotValidException methodArgumentNotValidException= (MethodArgumentNotValidException) e;
            return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),
                    "校验错误："+methodArgumentNotValidException.getBindingResult().getFieldError().getDefaultMessage());
        }//如果是自定义的异常，就给出具体的异常原因
        else if (e instanceof MyException){
            return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"自定义的错误为："+e.getMessage());
        }
        //如果都不是就打印出异常的信息
        return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"错误的信息为："+e.getMessage());
    }
}

（七）测试校验

接下来就可以测试校验的功能了，通过postman访问

如果输入参数不满足之前的设置，就会给出具体的错误信息。而不是抛出让人无法接收的报错：

（八）总结

许多人写代码时最不考虑的就是异常处理，简单地实现需求就好了，所以才会导致许多不可预估的bug出现。好了，本期文章就到这里了，我们下期再见。