io.github.taills.common.exception.ExceptionHandlerAdvice Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-boot-common Show documentation

Taills's Spring Boot Project Common

There is a newer version: 1.3.0

package io.github.taills.common.exception;

import io.github.taills.common.response.ApiResult;
import io.github.taills.common.response.ApiResultStatus;
import lombok.extern.slf4j.Slf4j;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @ClassName ExceptionHandlerAdvice
 * @Description
 * @Author nil
 * @Date 2021/10/19 2:51 下午
 **/
@ControllerAdvice
@ResponseBody
@Slf4j
public class ExceptionHandlerAdvice {
    /**
     * 处理未捕获的Exception
     *
     * @param e 异常
     * @return 统一响应体
     */
    @ExceptionHandler(Exception.class)
    public ApiResult handleException(Exception e) {
        if (e instanceof HttpRequestMethodNotSupportedException) {
            return ApiResult.failure(ApiResultStatus.METHOD_NOT_ALLOWED);
        }
        if (e instanceof MissingServletRequestParameterException){
            return ApiResult.failure(ApiResultStatus.BAD_REQUEST);
        }
        log.error("handleException {}", e.getLocalizedMessage());
        return ApiResult.failure(ApiResultStatus.INTERNAL_SERVER_ERROR, e.getClass().getName());
    }

    /**
     * 处理未捕获的RuntimeException
     *
     * @param e 运行时异常
     * @return 统一响应体
     */
    @ExceptionHandler(RuntimeException.class)
    public ApiResult handleRuntimeException(RuntimeException e) {
        if (e instanceof AccessDeniedException) {
            return ApiResult.failure(ApiResultStatus.FORBIDDEN);
        }
        if (e instanceof BaseException){
            return ((BaseException) e).getApiResult();
        }
        log.error("RuntimeException {}", e.getLocalizedMessage());
        return ApiResult.failure(ApiResultStatus.INTERNAL_SERVER_ERROR);
    }

    /**
     * 处理业务异常BaseException
     *
     * @param e 业务异常
     * @return 统一响应体
     */
    @ExceptionHandler(BaseException.class)
    public ApiResult handleBaseException(BaseException e) {
        log.error("BaseException {}", e.getApiResult());
        return e.getApiResult();
    }
}