/*
|
* Copyright (c) 2018-2028, Chill Zhuang All rights reserved.
|
*
|
* Redistribution and use in source and binary forms, with or without
|
* modification, are permitted provided that the following conditions are met:
|
*
|
* Redistributions of source code must retain the above copyright notice,
|
* this list of conditions and the following disclaimer.
|
* Redistributions in binary form must reproduce the above copyright
|
* notice, this list of conditions and the following disclaimer in the
|
* documentation and/or other materials provided with the distribution.
|
* Neither the name of the dreamlu.net developer nor the names of its
|
* contributors may be used to endorse or promote products derived from
|
* this software without specific prior written permission.
|
* Author: Chill 庄骞 (smallchill@163.com)
|
*/
|
package org.springblade.core.log.error;
|
|
import lombok.extern.slf4j.Slf4j;
|
import org.hibernate.validator.internal.engine.path.PathImpl;
|
import org.springblade.core.tool.api.R;
|
import org.springblade.core.tool.api.ResultCode;
|
import org.springblade.core.tool.utils.StringUtil;
|
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
|
import org.springframework.core.Ordered;
|
import org.springframework.core.annotation.Order;
|
import org.springframework.http.HttpStatus;
|
import org.springframework.http.converter.HttpMessageNotReadableException;
|
import org.springframework.validation.BindException;
|
import org.springframework.validation.BindingResult;
|
import org.springframework.validation.FieldError;
|
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.MissingServletRequestParameterException;
|
import org.springframework.web.bind.annotation.ExceptionHandler;
|
import org.springframework.web.bind.annotation.ResponseStatus;
|
import org.springframework.web.bind.annotation.RestControllerAdvice;
|
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
|
import org.springframework.web.servlet.DispatcherServlet;
|
import org.springframework.web.servlet.NoHandlerFoundException;
|
|
import javax.servlet.Servlet;
|
import javax.validation.ConstraintViolation;
|
import javax.validation.ConstraintViolationException;
|
import java.util.Set;
|
|
/**
|
* 全局异常处理，处理可预见的异常，Order 排序优先级高
|
*
|
* @author Chill
|
*/
|
@Slf4j
|
@Order(Ordered.HIGHEST_PRECEDENCE)
|
@AutoConfiguration
|
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
|
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class })
|
@RestControllerAdvice
|
public class RestExceptionTranslator {
|
|
@ExceptionHandler(MissingServletRequestParameterException.class)
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
public R handleError(MissingServletRequestParameterException e) {
|
log.warn("缺少请求参数", e.getMessage());
|
String message = String.format("缺少必要的请求参数: %s", e.getParameterName());
|
return R.fail(ResultCode.PARAM_MISS, message);
|
}
|
|
@ExceptionHandler(MethodArgumentTypeMismatchException.class)
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
public R handleError(MethodArgumentTypeMismatchException e) {
|
log.warn("请求参数格式错误", e.getMessage());
|
String message = String.format("请求参数格式错误: %s", e.getName());
|
return R.fail(ResultCode.PARAM_TYPE_ERROR, message);
|
}
|
|
@ExceptionHandler(MethodArgumentNotValidException.class)
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
public R handleError(MethodArgumentNotValidException e) {
|
log.warn("参数验证失败", e.getMessage());
|
return handleError(e.getBindingResult());
|
}
|
|
@ExceptionHandler(BindException.class)
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
public R handleError(BindException e) {
|
log.warn("参数绑定失败", e.getMessage());
|
return handleError(e.getBindingResult());
|
}
|
|
private R handleError(BindingResult result) {
|
FieldError error = result.getFieldError();
|
String message = String.format("%s:%s", error.getField(), error.getDefaultMessage());
|
return R.fail(ResultCode.PARAM_BIND_ERROR, message);
|
}
|
|
@ExceptionHandler(ConstraintViolationException.class)
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
public R handleError(ConstraintViolationException e) {
|
log.warn("参数验证失败", e.getMessage());
|
Set<ConstraintViolation<?>> violations = e.getConstraintViolations();
|
ConstraintViolation<?> violation = violations.iterator().next();
|
String path = ((PathImpl) violation.getPropertyPath()).getLeafNode().getName();
|
String message = String.format("%s:%s", path, violation.getMessage());
|
return R.fail(ResultCode.PARAM_VALID_ERROR, message);
|
}
|
|
@ExceptionHandler(NoHandlerFoundException.class)
|
@ResponseStatus(HttpStatus.NOT_FOUND)
|
public R handleError(NoHandlerFoundException e) {
|
log.error("404没找到请求:{}", e.getMessage());
|
return R.fail(ResultCode.NOT_FOUND, e.getMessage());
|
}
|
|
@ExceptionHandler(HttpMessageNotReadableException.class)
|
@ResponseStatus(HttpStatus.BAD_REQUEST)
|
public R handleError(HttpMessageNotReadableException e) {
|
log.error("消息不能读取:{}", e.getMessage());
|
return R.fail(ResultCode.MSG_NOT_READABLE, e.getMessage());
|
}
|
|
@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
|
@ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
|
public R handleError(HttpRequestMethodNotSupportedException e) {
|
log.error("不支持当前请求方法:{}", e.getMessage());
|
return R.fail(ResultCode.METHOD_NOT_SUPPORTED, e.getMessage());
|
}
|
|
@ExceptionHandler(HttpMediaTypeNotSupportedException.class)
|
@ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
|
public R handleError(HttpMediaTypeNotSupportedException e) {
|
log.error("不支持当前媒体类型:{}", e.getMessage());
|
return R.fail(ResultCode.MEDIA_TYPE_NOT_SUPPORTED, e.getMessage());
|
}
|
|
@ExceptionHandler(HttpMediaTypeNotAcceptableException.class)
|
@ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
|
public R handleError(HttpMediaTypeNotAcceptableException e) {
|
String message = e.getMessage() + " " + StringUtil.join(e.getSupportedMediaTypes());
|
log.error("不接受的媒体类型:{}", message);
|
return R.fail(ResultCode.MEDIA_TYPE_NOT_SUPPORTED, message);
|
}
|
|
}
|
