Springboot 统一异常处理 Assert @ControllerAdvice

前言

上一篇SpringBoot 参数检验Assert使用了解了SpringBoot 参数检验Assert的使用，我们是不是可以自定义Assert，来实现自定义异常呢？

用 Assert(断言) 替换 throw exception

Assert.notNull(user, “用户不存在.”); 代替
throw new IllegalArgumentException(“用户不存在.”);

IResponseEnum

/**
 * @author liu
 * @date 2022年05月25日 11:16
 */
public interface IResponseEnum {

    int getCode();
    String getMessage();
}

异常最重要的两个信息code和message，为了表示不同的业务异常信息，采用枚举的方式

BaseException IResponseEnum作为BaseException属性

package com.andon.springbootdistributedlock.exception;

import com.andon.springbootdistributedlock.annotation.IResponseEnum;
import lombok.Data;

/**
 * @author liu
 * @date 2022年05月25日 11:14
 */
@Data
public class BaseException extends RuntimeException{
    protected IResponseEnum responseEnum;
    protected Object[] args;

    public BaseException(IResponseEnum responseEnum){
        super(responseEnum.getMessage());
        this.responseEnum=responseEnum;
    }

    public BaseException(int code,String msg){
        super(msg);
        this.responseEnum=new IResponseEnum() {
            @Override
            public int getCode() {
                return code;
            }

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

    public BaseException(IResponseEnum responseEnum,Object[] args,String message){
        super(message);
        this.responseEnum=responseEnum;
        this.args=args;
    }

    public BaseException(IResponseEnum responseEnum,Object[] args,String message,Throwable cause){
        super(message,cause);
        this.responseEnum=responseEnum;
        this.args=args;
    }

}

全局异常引入IResponseEnum作为自己的属性，保证抛出的异常信息全部为服务自己定义。

自定义Assert

package com.andon.springbootdistributedlock.exception;

/**
 * @author liu
 * @date 2022年05月25日 11:12
 */
public interface Assert {
    /**
     * 创建异常
     * @param args
     * @return
     */
    BaseException newException(Object... args);

    /**
     * 创建异常
     * @param t
     * @param args
     * @return
     */
    BaseException newException(Throwable t, Object... args);

    /**
     * 
断言对象obj非空。如果对象obj为空，则抛出异常
     *
     * @param obj 待判断对象
     */
    default void assertNotNull(Object obj) {
        if (obj == null) {
            throw newException(obj);
        }
    }

    /**
     * 
断言对象obj非空。如果对象obj为空，则抛出异常
     * 
异常信息message支持传递参数方式，避免在判断之前进行字符串拼接操作
     *
     * @param obj 待判断对象
     * @param args message占位符对应的参数列表
     */
    default void assertNotNull(Object obj, Object... args) {
        if (obj == null) {
            throw newException(args);
        }
    }
}

定义BusinessExceptionAssert同时实现Assert判断逻辑和枚举类区分不同业务异常逻辑

package com.andon.springbootdistributedlock.exception;

import com.andon.springbootdistributedlock.annotation.IResponseEnum;

import java.text.MessageFormat;

/**
 * @author liu
 * @date 2022年05月25日 11:20
 */
public interface BusinessExceptionAssert extends IResponseEnum, Assert {

    @Override
    default BaseException newException(Object... args) {
        String msg = MessageFormat.format(this.getMessage(), args);

        return new BusinessException(this, args, msg);
    }

    @Override
    default BaseException newException(Throwable t, Object... args) {
        String msg = MessageFormat.format(this.getMessage(), args);

        return new BusinessException(this, args, msg, t);
    }

}

BusinessException

package com.andon.springbootdistributedlock.exception;

/**
 * @author liu
 * @date 2022年05月25日 11:19
 */

import com.andon.springbootdistributedlock.annotation.IResponseEnum;

import java.text.MessageFormat;

/**
 * 
业务异常
 * 
业务处理时，出现异常，可以抛出该异常
 */
public class BusinessException extends  BaseException {

    private static final long serialVersionUID = 1L;

    public BusinessException(IResponseEnum responseEnum, Object[] args, String message) {
        super(responseEnum, args, message);
    }

    public BusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
        super(responseEnum, args, message, cause);
    }
}

全局异常处理器

package com.andon.springbootdistributedlock.config;

import com.andon.springbootdistributedlock.domain.ResponseStandard;
import com.andon.springbootdistributedlock.exception.*;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.ConversionNotSupportedException;
import org.springframework.beans.TypeMismatchException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.HttpMediaTypeNotAcceptableException;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingPathVariableException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.ServletRequestBindingException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.async.AsyncRequestTimeoutException;
import org.springframework.web.multipart.support.MissingServletRequestPartException;
import org.springframework.web.servlet.NoHandlerFoundException;

import javax.servlet.http.HttpServletRequest;

/**
 * 2021/11/10
 * 

 * 全局异常处理器
 */
@Slf4j
@RestControllerAdvice //对Controller增强,并返回json格式字符串
public class GlobalExceptionHandler {


    /**
     * 生产环境
     */
    private final static String ENV_PROD = "prod";


    /**
     * 当前环境
     */
    @Value("${spring.profiles.active}")
    private String profile;





    /**
     * 捕获分布式锁异常,并自定义返回数据
     */
    @ExceptionHandler(DistributedLockException.class)
    public ResponseStandard