Java自定义异常及统一处理,信息返回

145 阅读2分钟

开始操作

创建enums,exception包:

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

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

结构如下:

image.png

具体代码

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;
    }
}

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类:

类中使用@Data注解,可省略set,get方法 使用方法:依赖中添加lombok依赖并下载lombok插件(file-->settings-->Plugins-->Lombok-->install)

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());
    }
}

自定义异常及异常拦截统一处理完成

测试

测试项目为之前创建文章中springboot整合mybatis实现对学生表信息增删改查项目,项目创建过程请移步[SpringBoot整合MyBatis实现增删改查(简单,详细)](SpringBoot整合MyBatis实现增删改查(简单,详细) - 掘金 (juejin.cn))

StudentController插入信息中判断学生学号是否为空,空则抛出在枚举类中自定义的自定义异常,不为空则成功

image.png 使用postman测试:

第一次测试学号为空的情况:

image.png 抛出异常成功

第二次测试学号不为空的情况

image.png 信息插入成功 测试结束