SpringBoot 拦截器 统一结果返回 统一异常处理
在Spring Boot中,你可以使用拦截器(Interceptor)来实现统一结果返回和异常处理。以下是一个简单的示例:
- 创建一个拦截器类,实现
HandlerInterceptor
接口:
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class ResultInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
// 在请求处理之前进行调用(Controller方法调用之前)
return true; // 如果返回false,则停止流程,api不会被调用
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
// 请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之后)
if (modelAndView != null) {
// 这里可以对modelAndView进行操作,统一返回格式
}
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
// 在整个请求结束之后调用,也就是在DispatcherServlet渲染了视图执行
// 这里可以进行资源清理
if (ex != null) {
// 异常处理,统一异常返回格式
}
}
}
- 注册拦截器。在Spring Boot配置类中添加拦截器:
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new ResultInterceptor())
.addPathPatterns("/**"); // 拦截所有请求路径
}
}
- 在
postHandle
方法中对modelAndView
进行操作,实现统一结果返回。在afterCompletion
方法中处理异常,实现统一异常处理。
这样,你就可以在所有的API响应前统一结果返回,并且对异常进行了处理,返回给前端一个友好的错误信息。
评论已关闭