Scenes
When writing the Controller interface, in order to avoid the interface returning unfriendly results and prompts due to unknown exceptions.
If you do not perform global exception capture, you need to perform try-catch or other operations on each interface.
Global exception capture and processing can be performed on the Controller. Once an exception occurs, a general 500 response code and a general error prompt will be returned.
And record the specific file, class, method, and line number information of the exception to the log.
@ControllerAdvice is a new annotation provided by Spring 3.2, which is a Controller enhancer,
Some logic processing can be added to the method annotated by @RequestMapping in the controller. The most commonly used is exception handling.
It needs to be used with @ExceptionHandler. When an exception is thrown to the controller, the exception can be handled uniformly.
Note:
Blog:
Overbearing rogue temperament blog_CSDN Blog-C#, Architecture Road, Blogger in SpringBoot
accomplish
1. @RestControlAdvice is a combined annotation consisting of @ControllerAdvice and @ResponseBody.
@ControllerAdvice provides a variety of ways to specify the definition of Advice rules. By default, nothing is written, and it is all Advice Controllers.
Of course, you can also specify rules in the following ways.
Specify which package paths only take effect through basePackages.
It can also be matched by specifying annotations, for example, I have customized a @CustomAnnotation annotation,
I want to match all Controllers modified by this annotation, which can be written like this: @ControllerAdvice(annotations={CustomAnnotation.class})
There are no rule restrictions here, and it takes effect for all controllers.
2. Create a new global exception capture class. Note that it is in the same package path as the startup class, otherwise it will not take effect and you need to specify the package path in the startup class.
import com.badao.demo.common.AjaxResult;
import com.badao.demo.constant.Constants;
import com.badao.demo.constant.HttpStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//注意引入包的路径
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class GlobalExceptionHandler
{
private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(Exception.class)
public AjaxResult handleException(Exception e)
{
StackTraceElement stackTrace = e.getStackTrace()[0];
String methodName = stackTrace.getMethodName();
String fileName = stackTrace.getFileName();
String className = stackTrace.getClassName();
int lineNumber = stackTrace.getLineNumber();
log.error("异常发生在文件{}的类{}中的方法{}的第{}行'，异常信息:{}", fileName,className,methodName,lineNumber,e.getMessage());
return AjaxResult.error(HttpStatus.ERROR, Constants.SERVER_ERROR);
}
}Here use @ExceptionHandler(Exception.class)
Capture all Exceptions, and then uniformly return the encapsulated AjaxResult result class
import com.badao.demo.constant.HttpStatus;
import com.badao.demo.utils.StringUtils;
import java.util.HashMap;
/**
* 操作消息提醒
*
*/
public class AjaxResult extends HashMap<String, Object>
{
private static final long serialVersionUID = 1L;
/** 状态码 */
public static final String CODE_TAG = "code";
/** 返回内容 */
public static final String MSG_TAG = "msg";
/** 数据对象 */
public static final String DATA_TAG = "data";
/**
* 初始化一个新创建的 AjaxResult 对象，使其表示一个空消息。
*/
public AjaxResult()
{
}
/**
* 初始化一个新创建的 AjaxResult 对象
*
* @param code 状态码
* @param msg 返回内容
*/
public AjaxResult(int code, String msg)
{
super.put(CODE_TAG, code);
super.put(MSG_TAG, msg);
}
/**
* 初始化一个新创建的 AjaxResult 对象
*
* @param code 状态码
* @param msg 返回内容
* @param data 数据对象
*/
public AjaxResult(int code, String msg, Object data)
{
super.put(CODE_TAG, code);
super.put(MSG_TAG, msg);
if (StringUtils.isNotNull(data))
{
super.put(DATA_TAG, data);
}
}
/**
* 返回成功消息
*
* @return 成功消息
*/
public static AjaxResult success()
{
return AjaxResult.success("操作成功");
}
/**
* 返回成功数据
*
* @return 成功消息
*/
public static AjaxResult success(Object data)
{
return AjaxResult.success("操作成功", data);
}
/**
* 返回成功消息
*
* @param msg 返回内容
* @return 成功消息
*/
public static AjaxResult success(String msg)
{
return AjaxResult.success(msg, null);
}
/**
* 返回成功消息
*
* @param msg 返回内容
* @param data 数据对象
* @return 成功消息
*/
public static AjaxResult success(String msg, Object data)
{
return new AjaxResult(HttpStatus.SUCCESS, msg, data);
}
/**
* 返回错误消息
*
* @return
*/
public static AjaxResult error()
{
return AjaxResult.error("操作失败");
}
/**
* 返回错误消息
*
* @param msg 返回内容
* @return 警告消息
*/
public static AjaxResult error(String msg)
{
return AjaxResult.error(msg, null);
}
/**
* 返回错误消息
*
* @param msg 返回内容
* @param data 数据对象
* @return 警告消息
*/
public static AjaxResult error(String msg, Object data)
{
return new AjaxResult(HttpStatus.ERROR, msg, data);
}
/**
* 返回错误消息
*
* @param code 状态码
* @param msg 返回内容
* @return 警告消息
*/
public static AjaxResult error(int code, String msg)
{
return new AjaxResult(code, msg, null);
}
}Then the status code and prompt message are encapsulated constant classes
Status code constant class
public class HttpStatus
{
/**
* 操作成功
*/
public static final int SUCCESS = 200;
/**
* 对象创建成功
*/
public static final int CREATED = 201;
/**
* 请求已经被接受
*/
public static final int ACCEPTED = 202;
/**
* 操作已经执行成功，但是没有返回数据
*/
public static final int NO_CONTENT = 204;
/**
* 资源已被移除
*/
public static final int MOVED_PERM = 301;
/**
* 重定向
*/
public static final int SEE_OTHER = 303;
/**
* 资源没有被修改
*/
public static final int NOT_MODIFIED = 304;
/**
* 参数列表错误（缺少，格式不匹配）
*/
public static final int BAD_REQUEST = 400;
/**
* 未授权
*/
public static final int UNAUTHORIZED = 401;
/**
* 访问受限，授权过期
*/
public static final int FORBIDDEN = 403;
/**
* 资源，服务未找到
*/
public static final int NOT_FOUND = 404;
/**
* 不允许的http方法
*/
public static final int BAD_METHOD = 405;
/**
* 资源冲突，或者资源被锁
*/
public static final int CONFLICT = 409;
/**
* 不支持的数据，媒体类型
*/
public static final int UNSUPPORTED_TYPE = 415;
/**
* 系统内部错误
*/
public static final int ERROR = 500;
/**
* 接口未实现
*/
public static final int NOT_IMPLEMENTED = 501;
}message constant class
public class Constants {
//请求响应常量
public static final String NO_API_CODE = "请求码不能为空";
public static final String ILLEGAL_API_CODE = "请求码不存在";
public static final String SERVER_ERROR = "服务器内部错误，请联系管理员!";
public static final String CALL_TOO_OFEN = "请求太频繁";
}Then record the specific information of the exception in the log, and the source of the exception information can be interrupted to obtain and customize the content that needs to be obtained
2. Here is a wild card for the Exception type. If you need to capture the specified exception type or custom type, you can also
import com.badao.demo.common.AjaxResult;
import com.badao.demo.constant.Constants;
import com.badao.demo.constant.HttpStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//注意引入包的路径
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class GlobalExceptionHandler
{
private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(Exception.class)
public AjaxResult handleException(Exception e)
{
StackTraceElement stackTrace = e.getStackTrace()[0];
String methodName = stackTrace.getMethodName();
String fileName = stackTrace.getFileName();
String className = stackTrace.getClassName();
int lineNumber = stackTrace.getLineNumber();
log.error("异常发生在文件{}的类{}中的方法{}的第{}行'，异常信息:{}", fileName,className,methodName,lineNumber,e.getMessage());
return AjaxResult.error(HttpStatus.ERROR, Constants.SERVER_ERROR);
}
/**
* 自定义验证异常
*/
@ExceptionHandler(BindException.class)
public AjaxResult handleBindException(BindException e) {
log.error(e.getMessage(), e);
String message = e.getAllErrors().get(0).getDefaultMessage();
return AjaxResult.error(HttpStatus.BAD_REQUEST, message);
}
/**
* 自定义验证异常
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
{
log.error(e.getMessage(), e);
String message = e.getBindingResult().getFieldError().getDefaultMessage();
return AjaxResult.error(message);
}
}Pay attention to the path of the imported package here, otherwise it will not take effect.
This piece can also refer to
SpringBoot+@Validate +global exception interception implements custom rule parameter verification (verification get request parameters cannot be empty and in the specified enumeration type):
3. Test effect
Manually write a division by zero exception and remove the try-catch in the controller
The interface responds uniformly, and the specific information is recorded in the log
