当前位置: 首页 > news >正文

SpringBoot 统⼀功能处理以及DispatcherServlet

拦截器

定义

拦截器是Spring框架提供的核⼼功能之⼀, 主要⽤来拦截⽤⼾的请求, 在指定⽅法前后, 根据业务需要执 ⾏预先设定的代码.

实现拦截器

1. 定义拦截器

创建类,实现HandlerInterceptor接口,重写preHandle和postHandle两个方法,在方法中实现拦截器逻辑

其中,preHandle方法,是在controller类之前进行,用于检查;postHandle是controller实现完成后(或者拦截成功后)逆序进行,用于收尾。

实现流程:

假设拦截器有三个功能

情况一

放行:调用preHandle方法,实现功能1,2,3,如果放行,则调用controller方法,完成后调用postHandle方法,实现功能3,2,1

情况二

拦截:调用preHandle方法,实现功能1,2,3,在第3个功能处拦截,随后跳过controller方法,调用postHandle方法,只实现功能2,1。因为3并没有在preHandle实现。

package com.spring.bookmanage.interceptor; import com.spring.bookmanage.constant.Constants; import com.spring.bookmanage.entity.Result; import com.spring.bookmanage.entity.UserInfo; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import jakarta.servlet.http.HttpSession; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Component; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; @Slf4j @Component public class LoginInterceptor implements HandlerInterceptor{ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { log.info("目标代码执行前"); HttpSession session = request.getSession(false); if(!checkStatus(session)){ response.setStatus(401); return false; } //true放行,false拦截 return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { log.info("目标方法执行后"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { log.info("完成后"); } public boolean checkStatus(HttpSession session) { if(session==null||(session.getAttribute(Constants.SESSION_USER_INFO)==null)){ //用户未登录 return false; } UserInfo userInfo=(UserInfo)session.getAttribute(Constants.SESSION_USER_INFO); if ((userInfo==null)||(userInfo.getId()<=0)){ //用户未登录 return false; } return true; } }

2. 注册拦截器

创建类,实现WebMvcConfigurer接口,实例化LoginInterceptor类,并重写addInterceptors⽅法,方法中定义拦截路径"/book/**"

package com.spring.bookmanage.config; import com.spring.bookmanage.interceptor.LoginInterceptor; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; import org.springframework.stereotype.Component; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Autowired private LoginInterceptor loginInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(loginInterceptor).addPathPatterns("/book/**"); } }

通过打印日志,可以看到拦截器生效(红框标出):

拦截路径

@Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(loginInterceptor) .addPathPatterns("/**") .excludePathPatterns("/user/login");//设置拦截器拦截的请求路径 (/** 表⽰拦截所有请求) }

统一数据返回格式

该功能将统一格式返回前端

实现

创建类,实现ResponseBodyAdvice接口,重写supports和beforeBodyWrite方法。

supports方法: 判断是否要执行beforeBodyWrite方法. true为执行, false不执行. 通过该方法可以选择哪些类或哪些方法的response要进行处理, 其他的不进行处理.

beforeBodyWrite方法: 对response方法进行具体操作处理

package com.spring.bookmanage.config; import com.spring.bookmanage.entity.BookInfo; import com.spring.bookmanage.entity.Result; import lombok.SneakyThrows; import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.core.MethodParameter; import org.springframework.http.MediaType; import org.springframework.http.server.ServerHttpRequest; import org.springframework.http.server.ServerHttpResponse; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice; import tools.jackson.databind.ObjectMapper; @ControllerAdvice public class ResponseAdvice implements ResponseBodyAdvice { @Autowired private ObjectMapper objectMapper; @Override public boolean supports(MethodParameter returnType, Class converterType) { //false:不处理 true:处理 return true; } @SneakyThrows @Override public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) { if(body instanceof String){ return objectMapper.writeValueAsString(Result.success(body)); } if(body instanceof Result){ return body; } return Result.success(body); } }

统⼀异常处理

统⼀异常处理使用的是 @ControllerAdvice + @ExceptionHandler 来实现的, @ControllerAdvice 表⽰控制器通知类,@ExceptionHandler 是异常处理器,两个结合表示当出现异常的时候执行某个通知,也就是执行某个方法事件

package com.spring.bookmanage.config; import com.spring.bookmanage.entity.Result; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseBody; @Slf4j @ControllerAdvice @ResponseBody public class ExceptionAdvice { @ExceptionHandler public Result handler(Exception e){ log.error("error: "+e); return Result.fail("inner error"); } }

三组件及Controller背后的调度者:DispatcherServlet

我们看看Spring是怎么实现的, 还是从 DispatcherServlet 的代码开始分析。DispatcherServlet 对象在创建时会初始化一系列的对象

源码过于复杂,笔者作为和各位读者同样甚至更加稚嫩的初学者,就不大量展示了,以下为一小部分DispatcherServlet源码:

public class DispatcherServlet extends FrameworkServlet { //... protected void initStrategies(ApplicationContext context) { initMultipartResolver(context); initLocaleResolver(context); initThemeResolver(context); initHandlerMappings(context); //url-方法映射 initHandlerAdapters(context); //适配器(可理解为统一接口格式工具) initHandlerExceptionResolvers(context); //异常处理器 initRequestToViewNameTranslator(context); initViewResolvers(context); initFlashMapManager(context); } //...

springboot启动时,由Servlet容器在80端口(默认)监听,并且DispatchServlet类启动,初始化这九大对象,其中就包括url-方法映射,这就是我们的controller,适配器,异常处理机制等。

当请求某个方法,DispatcherServlet调用拦截器,对请求进行检验,如果没有问题则放行,如果有问题则直接跳过controller调用;

当请求被拦截器放行,DispatcherServlet查找所有Controller方法,找到对应的请求路径的方法调用;

当返回某个结果DispatcherServlet查找所有结果统一格式方法,调用并封装结果返回;

当出现异常,DispatcherServlet查找所有异常处理,找到合适的异常处理方法并调用。

总结

本章节主要介绍了SpringBoot 对⼀些统⼀功能的处理⽀持.

1. 拦截器的实现主要分两部分: 定义拦截器(实现HandlerInterceptor 接口) + 配置拦截器

2. 统⼀数据返回格式通过@ControllerAdvice + ResponseBodyAdvice 来实现

3. 统⼀异常处理使⽤@ControllerAdvice + @ExceptionHandler 来实现, 并且可以分异常来处理

4. 学习了DispatcherServlet的一点点源码

http://www.cnnetsun.cn/news/167735.html

相关文章:

  • 使用自定义注解校验请求参数
  • 敢不敢用一年时间读完这12本书,模型入门必看的12本书!建议收藏!!
  • 对比:Qwen-VL与传统的CNN在图像处理应用
  • 【硬件设计】DC12V输入的防护+滤波设计
  • 快!太快了!一键生成!一键导出!微信自动统计数据报表来了!
  • 智能决策系统日志系统设计:AI架构师的调试与分析技巧
  • 力扣 11.盛最多水的容器 简单的双指针算法 题解
  • 深度学习驱动的论文降重工具有效规避查重风险,智能改写段落
  • 温度传感器PT1000与NTC10K介绍
  • 震惊!这家酶制剂供应商竟让行业炸锅
  • 数学建模与排版无忧?这10个AI论文工具精准解决复现难题
  • AI对打工人的三个影响
  • 小程序/APP接入分账系统:4大核心注意事项,避开合规与技术坑
  • 靠谱的厦门考研公司哪个好
  • 二叉搜索树的最近公共祖先:别再蛮力了,用规则思维找“血缘关系”
  • 推荐6个AI论文网站,提供降重与自然改写功能避免标红
  • 智能学术支持:6个AI论文平台解析,自动润色让内容更专业
  • 从手动测试到自动化测试的转型之路:策略、挑战与未来
  • 大数据工程师必看:批处理性能优化的10个黄金法则
  • 2026年AI全面爆发!AI原生、物理AI、多模态与世界模型的革命性变革
  • 【扣子Coze教程】文案一键仿写+飞书自动发布
  • 提示词工程精华总结:掌握ICIO框架与五大核心要素,AI应用效率翻倍,建议收藏!
  • 还在手动选品?RPA+AI生成希音爆款推荐,效率提升100倍![特殊字符]
  • 8个AI论文工具,自考学生轻松搞定毕业论文!
  • 8个降AI率工具推荐,继续教育学生必备
  • CTFer常见高频工具清单
  • 痞子衡嵌入式:16MB以上NOR Flash地址模式切换会造成软复位后i.MXRT无法正常启动
  • 爬山算法:无需微积分的机器学习之旅
  • 【Ctfer训练计划】——命令执行的解题技巧(持续更新中)
  • CTF wed安全(攻防世界)练习题