原理
@ControllerAdvice 是一个 Spring 框架的注解,用于定义一个控制器增强类(controller advice class),它提供了一种方式来为所有控制器提供通用功能。这个注解通常用于全局处理异常、日志记录、权限验证等通用操作。
用途
以下是 @ControllerAdvice 注解的一些主要用途:
1.全局异常处理:你可以使用 @ExceptionHandler 注解来定义异常处理方法,这些方法将应用于所有控制器。
2.日志记录:你可以在 @ControllerAdvice 类中添加日志记录代码,用于记录所有请求的详细信息,如请求参数、返回值等。
3.权限验证:你可以添加权限验证逻辑,确保只有具有相应权限的用户才能访问特定的控制器或方法。
4.请求和响应处理:你可以在 @ControllerAdvice 类中修改请求数据或响应数据,例如,添加默认值、格式化数据等。
5.跨域处理:你可以在 @ControllerAdvice 类中配置跨域资源共享(CORS)的相关设置。
6.性能监控:你可以添加代码来监控所有请求的性能,如计算请求处理时间等。
示例代码
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ModelAttribute;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@ControllerAdvice
public class GlobalControllerAdvice {
private static final Logger logger = LoggerFactory.getLogger(GlobalControllerAdvice.class);
// 全局异常处理
@ExceptionHandler(Exception.class)
public String handleException(HttpServletRequest request, HttpServletResponse response, Exception ex) {
logger.error("Exception occurred in request to " + request.getRequestURI(), ex);
// 返回错误页面或者其他处理逻辑
return "error";
}
// 全局请求日志记录
@ModelAttribute
public void logRequest(HttpServletRequest request) {
logger.info("Request: " + request.getMethod() + " " + request.getRequestURI());
}
// 记录请求处理时间
@ModelAttribute
public void logPerformance(HttpServletRequest request, HttpServletResponse response) {
long startTime = System.currentTimeMillis();
request.setAttribute("startTime", startTime);
response.addHeader("Request-Received-Time", String.valueOf(startTime));
}
// 计算请求处理时间并记录
@ModelAttribute
public void logPerformance(HttpServletRequest request, HttpServletResponse response) {
long startTime = (Long) request.getAttribute("startTime");
long endTime = System.currentTimeMillis();
long elapsedTime = endTime - startTime;
logger.info("Request processed in " + elapsedTime + " milliseconds");
}
}
总结
总之,@ControllerAdvice 是一个有用的工具,用于为所有控制器提供通用功能。通过在一个地方集中处理这些功能,你可以简化代码,并确保所有控制器都遵循相同的规则和逻辑。