后端开发框架搭建-返回自定义异常，异常拦截处理，数据统一校验

以SpringBoot项目为例

一.搭建基础框架

SpringBoot集成Mybatis：移步SpringBoot整合Mybatis
SpringBoot集成MybatisPlus：移步SpringBoot整合MybatisPlus

二.自定义异常，统一返回

第一种思路

创建enums，exception包：

enums包下：
创建BaseCodeEnum接口
创建Response类：为统一信息返回类
创建ResponseCode枚举类：在这里定义我们需要的异常

exception包下：
创建HandlerException类：为全局统一异常处理类
创建ServiceException类：为自定义异常类

结构如下：

BaseCodeEnum接口:

public interface BaseCodeEnum {

    int getCode();
    String getMessage();
}

ResponseCode枚举类:
在自定义异常处根据实际情况定义自己或业务需要的异常
在实际使用抛自定义异常时，调用此类中的异常即可

public enum ResponseCode implements BaseCodeEnum {
    
    //***********自定义异常开始*********************
     
    SUCCESS(200,"操作成功"),
    STUDENT_ID_IS_NULL(10000,"输入学生id为空"),
    STUDENT_ID_NOT_EXIST(10001,"学生id不存在"),
    STUDENT_ID_EXIST(10002,"学生id已存在")
    ;
    
    //***********自定义异常结束*********************

    private int code;
    private String message;

    ResponseCode(int code,String message){
        this.code=code;
        this.message=message;
    }

    @Override
    public int getCode(){
        return code;
    }

    @Override
    public String getMessage(){
        return message;
    }
}

Response类：
自定义异常中异常码，异常信息，数据信息

import java.io.Serializable;

public class Response<T> implements Serializable {

    private static final int SUCCESS_CODE = 1;
    private static final int ERROR_CODE = 0;

    private int code;
    private String message;
    private T data;

    private Response(int code,String message,T data){
        this.code=code;
        this.message=message;
        this.data=data;
    }

    private Response(int code,String message){
        this.code=code;
        this.message=message;
    }

    public static <T> Response<T> success(String msg, T data){
        return new Response<T>(SUCCESS_CODE,msg,data);
    }

    public static <T> Response<T> success(){
        return new Response<T>(SUCCESS_CODE,"success");
    }

    public static <T> Response<T> success(T data){
        return new Response<T>(SUCCESS_CODE,"success",data);
    }

    public static <T> Response<T> error(){
        return new Response<T>(ERROR_CODE,"error");
    }

    public static <T> Response<T> error(String message){
        return new Response<T>(ERROR_CODE,message);
    }

    public static <T> Response<T> error(int code, String message){
        return new Response<T>(code,message);
    }

    public static <T> Response<T> error(int code, String message, T data){
        return new Response<T>(ERROR_CODE,message,data);
    }

    public int getCode(){
        return code;
    }

    public String getMessage(){
        return message;
    }

    public T getData(){
        return data;
    }
}

自定义异常完成

第二种思路

定义状态码接口

public interface StatusCode {
    public int getCode();
    public String getMsg();
}

定义自定义异常枚举类

@Getter
public enum ResultCode implements StatusCode{
    SUCCESS(1000, "请求成功"),
    FAILED(1001, "请求失败"),
    VALIDATE_ERROR(1002, "参数校验失败");
    
    private int code;
    private String msg;

    ResultCode(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

封装类：

@Data
public class ResultVo {

    private int code;
    private String msg;
    private Object data;

    public ResultVo(int code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    public ResultVo(Object data) {
        this.code = ResultCode.SUCCESS.getCode();
        this.msg = ResultCode.SUCCESS.getMsg();
        this.data = data;
    }
    public ResultVo(StatusCode statusCode, Object data) {
        this.code = statusCode.getCode();
        this.msg = statusCode.getMsg();
        this.data = data;
    }
    public ResultVo(StatusCode statusCode) {
        this.code = statusCode.getCode();
        this.msg = statusCode.getMsg();
        this.data = null;
    }
}

三.异常拦截，统一处理

第一种思路的拦截处理

HandlerException类：
本类中添加了slf4j日志，可使输出信息更加完善
若未集成slf4j，删除log.info……部分即可
想学习为项目添加日志？移步为SpringBoot项目添加日志：slf4j

@RestControllerAdvice
@Slf4j
public class HandlerException {
    @ExceptionHandler
    public Response<String> handleServiceException(ServiceException e) {
        log.info("**************ServiceException**************");
        log.info("【业务异常】：{}",e.getMessage(),e);
        return Response.error(e.getCode(),e.getMessage());
    }

    @ExceptionHandler
    public Response<String> handleRuntimeException(RuntimeException e){
        log.info("**************RuntimeException**************");
        log.info("【运行异常】：{}",e.getMessage(),e);
        return Response.error("运行异常");
    }

    @ExceptionHandler
    public Response<String> handleException(Exception e){
        log.info("【系统异常】：{}",e.getMessage(),e);
        return Response.error("系统异常");
    }
}

ServiceException类：

import com.example.demo.enums.BaseCodeEnum;
import lombok.Data;

@Data
public class ServiceException extends RuntimeException {

    private int code;
	private String message;

    public ServiceException(String message){
        super(message);
        this.message=message;
    }

    public ServiceException(int code,String message){
        super(message);
        this.code=code;
        this.message=message;
    }

    public ServiceException(BaseCodeEnum baseCodeEnum){
        this(baseCodeEnum.getCode(),baseCodeEnum.getMessage());
    }
}

第二种思路的拦截处理

找到报错种类，对应拦截处理

@RestControllerAdvice
public class ControllerExceptionAdvice {
    @ExceptionHandler({BindException.class})
    public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
        ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
        return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
    }
}

四.数据统一校验

对于传参中对参数的判断，使用@Validated注解配合实体类设置的判断条件后，便可完成数据统一校验，无需在业务代码中使用if依次判断
在实体类中

常用的校验注解
@NotNull
被注释的元素必须不为 null
@Min(value)
被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)
被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max, min)
被注释的元素的大小必须在指定的范围内，用在集合大小或者字符串的大小
@Pattern(value)
被注释的元素必须符合指定的正则表达式
@NotEmpty
被注释的元素必须不为 null 或者不为空，可校验字符、集合、Map
@NotBlank
被注释的元素必须不为空字符串
@Range(min ，max)
数值类型的范围大小，相当于@Min+@Max两个注解

完成数据统一校验，使用postman测试一下