注解@ControllerAdvice的使用
通过@ControllerAdvice全局处理异常
- 新建一个类，加上@ControllerAdvice或@RestControllerAdvice注解，表示这个类为全局处理类。
- 类中方法加上@ExceptionHandler注解并指定你想处理的异常类型，该方法就能够对该异常进行全局处理。
@RestControllerAdvice
public class ExceptionControllerAdvice {
@ExceptionHandler(MethodArgumentNotValidException.class)
public String MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
// 从异常对象中拿到ObjectError对象
ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
// 然后提取错误提示信息进行返回
return objectError.getDefaultMessage();
}
}
通过@ControllerAdvice全局处理响应数据
- 创建一个类加上注解使其成为全局处理类
- 继承ResponseBodyAdvice接口重写其中的方法
@RestControllerAdvice(basePackages = {"com.rudecrab.demo.controller"}) // 注意哦，这里要加上需要扫描的包
public class ResponseControllerAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> aClass) {
// 如果接口返回的类型本身就是ResultVO那就没有必要进行额外的操作，返回false
return !returnType.getGenericParameterType().equals(ResultVO.class);
}
@Override
public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest request, ServerHttpResponse response) {
// String类型不能直接包装，所以要进行些特别的处理
if (returnType.getGenericParameterType().equals(String.class)) {
ObjectMapper objectMapper = new ObjectMapper();
try {
// 将数据包装在ResultVO里后，再转换为json字符串响应给前端
return objectMapper.writeValueAsString(new ResultVO<>(data));
} catch (JsonProcessingException e) {
throw new APIException("返回String类型错误");
}
}
// 将原本的数据包装在ResultVO里
return new ResultVO<>(data);
}
}
通过切面打印全局日志
@Aspect
@Component
@Slf4j
public class LogControllerAspect {
@Pointcut("execution(public * com.*.*.controller..*.*(..))")
private void logController() {
}
@Around("logController()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
long start = System.currentTimeMillis();
log.info("[{}.{}] request: {}", proceedingJoinPoint.getSignature().getDeclaringType().getSimpleName(),
proceedingJoinPoint.getSignature().getName(),
KlJson.toJSONString(proceedingJoinPoint.getArgs()));
Object result = proceedingJoinPoint.proceed();
log.info("[{}.{}] response: {}, cost: {}ms", proceedingJoinPoint.getSignature().getDeclaringType().getSimpleName(),
proceedingJoinPoint.getSignature().getName(),
KlJson.toJSONString(result), System.currentTimeMillis() - start);
return result;
}
}