普通web请求可以通过 javax.validation.constraints package下的注解进行参数校验,那么校验后返回的校验失败的结果怎么友好型提醒呢?通过下面异常拦截处理:
package com.oyo.supplier.web;
import com.alibaba.fastjson.JSON;
import com.google.common.collect.Lists;
import com.oyo.common.enums.ResponseCode;
import com.oyo.common.exception.ServiceException;
import com.oyo.common.response.BaseResponse;
import com.oyo.supplier.common.enums.CommonEnum;
import com.oyo.supplier.web.response.ArgumentInvalidResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
import java.sql.SQLException;
import java.util.List;
/**
* @author kermit.liu on 2019/2/22
*/
@ControllerAdvice
@ResponseBody
@Slf4j
public class DefaultControllerAdvice {
/**
* 添加全局异常处理流程,根据需要设置需要处理的异常
*
* @param request request
* @param exception exception
* @return BaseResponse
*/
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public BaseResponse methodArgumentNotValidHandler(HttpServletRequest request, MethodArgumentNotValidException exception) {
log.warn(request.getRequestURI() + " exception, params = " + JSON.toJSONString(request.getParameterMap()), exception);
// 按需重新封装需要返回的错误信息
List<ArgumentInvalidResponse> invalidArguments = Lists.newArrayList();
// 解析原错误信息,封装后返回,此处返回非法的字段名称,原始值,错误信息
StringBuilder msg = new StringBuilder();
msg.append(ResponseCode.ILLEGAL_ARGUMENT.getMsg()).append(": ");
for (FieldError error : exception.getBindingResult().getFieldErrors()) {
ArgumentInvalidResponse argumentInvalidResponse = ArgumentInvalidResponse.builder()
.field(error.getField())
.defaultMessage(error.getDefaultMessage())
.rejectedValue(error.getRejectedValue())
.build();
invalidArguments.add(argumentInvalidResponse);
msg = msg.append(error.getDefaultMessage()).append(";");
}
BaseResponse<Object> fail = BaseResponse.fail(ResponseCode.ILLEGAL_ARGUMENT.getCode(), msg.toString());
fail.setData(JSON.toJSONString(invalidArguments));
return fail;
}
@ExceptionHandler(value = SQLException.class)
public BaseResponse methodSQLHandler(HttpServletRequest request, SQLException exception) {
log.warn(request.getRequestURI() + " exception, params = " + JSON.toJSONString(request.getParameterMap()), exception);
BaseResponse<Object> fail = BaseResponse.fail(CommonEnum.RESPONSE.SQL_ERROR.getCode(), CommonEnum.RESPONSE.SQL_ERROR.getDesc());
fail.setData(JSON.toJSONString(exception.getErrorCode()));
return fail;
}
@ExceptionHandler({Exception.class})
public BaseResponse handException(HttpServletRequest request, Exception e) {
if (e instanceof ServiceException) {
log.warn(request.getRequestURI() + " exception, params = " + JSON.toJSONString(request.getParameterMap()), e);
return BaseResponse.fail(((ServiceException) e).getCode(), ((ServiceException) e).getMsg());
} else {
log.error(request.getRequestURI() + " exception, params = " + JSON.toJSONString(request.getParameterMap()), e);
BaseResponse<Object> fail = BaseResponse.fail(CommonEnum.RESPONSE.SERVER_ERROR.getCode(), CommonEnum.RESPONSE.SERVER_ERROR.getDesc());
fail.setData(e.getMessage());
return fail;
}
}
}