尧图网站设计 尧图网站设计YAOTU DESIGN
ARTICLE DETAIL

资讯详情

深耕网站设计与一线实操的经验洞察。

Spring Boot实战:拦截器

Spring Boot实战:拦截器 一.拦截器快速入门---------### 1.1了解拦截器什么是拦截器概念拦截器是Spring框架提供的核功能之, 主要来拦截的请求, 在指定法前后, 根据业务需要执预先设定的代码。也就是说, 允许开发员提前预定义些逻辑, 在的请求响应前后执. 也可以在请求前阻其执.在拦截器当中开发员可以在应程序中做些通性的操作, 如通过拦截器来拦截前端发来的请求, 判断Session中是否有登录的信息. 如果有就可以放, 如果没有就进拦截.想象一下你去一个需要门禁的办公楼拦截器就像是那个门禁系统。当你请求想要进入办公楼访问某个资源时门禁系统拦截器会先检查你是否符合条件比如是否持有有效的门禁卡或是否已经通过身份验证。如果符合条件门禁系统会放行让你进入办公楼如果不符合条件门禁系统会阻止你进入并可能要求你进行其他操作比如登记或联系相关人员。 在SpringBoot中拦截器就是这样一种机制它可以在请求到达控制器之前或之后“拦截”请求并根据预定义的规则对请求进行处理。拦截器在SpringBoot中主要有以下几个作用1.身份验证和权限控制 * 就像门禁系统检查门禁卡一样拦截器可以检查用户的身份验证状态和权限。例如当用户尝试访问一个需要登录才能查看的页面时拦截器会检查用户是否已经登录。如果用户未登录拦截器可以重定向用户到登录页面或返回错误信息。2.日志记录 * 拦截器可以在请求到达控制器之前或之后记录日志信息。这对于监控和调试应用程序非常有用因为它可以帮助你了解请求是如何被处理的以及处理过程中发生了哪些事情。3.请求预处理和响应后处理 * 在请求到达控制器之前拦截器可以对请求进行预处理比如修改请求参数、设置请求头等。在控制器处理完请求并生成响应后拦截器还可以对响应进行后处理比如修改响应头、添加额外的数据到响应中等。4.异常处理 * 拦截器还可以捕获并处理请求处理过程中发生的异常。例如如果控制器在处理请求时抛出了异常拦截器可以捕获这个异常并根据异常类型进行相应的处理比如返回自定义的错误页面或错误信息。1.2拦截器的基本使用拦截器的使步骤分为两步1.定义拦截器2.注册配置拦截器****1.定义拦截器实现HandlerInterceptor接并重写其所有法Slf4j Component public class LoginInterceptor implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { log.info(“LoginInterceptor ?标?法执?前执?..”); return true; } Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { log.info(“LoginInterceptor ?标?法执?后执?”); } Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { log.info(“LoginInterceptor 视图渲染完毕后执?最后执?”); } }preHandle()法标法执前执. 返回true: 继续执后续操作; 返回false: 中断后续操作.postHandle()法标法执后执afterCompletion()法视图渲染完毕后执最后执(后端开发现在乎不涉及视图, 暂不了解)2.注册配置拦截器实现WebMvcConfigurer接并重写addInterceptors法Configuration public class WebConfig implements WebMvcConfigurer { //?定义的拦截器对象 Autowired private LoginInterceptor loginInterceptor; Override public void addInterceptors(InterceptorRegistry registry) { //注册?定义拦截器对象 registry.addInterceptor(loginInterceptor) .addPathPatterns(/);//设置拦截器拦截的请求路径 /* 表?拦截所 有请求 } }3.启动服务, 试试访问任意请求, 观察后端志可以看到preHandle 法执之后就放了, 开始执标法, 标法执完成之后执postHandle和afterCompletion法.4.我们把拦截器中preHandle法的返回值改为false, 再观察运结果可以看到, 拦截器拦截了请求, 没有进响应.### 1.2拦截器详解拦截器的程序完成之后接下来我们来介绍拦截器的使细节。拦截器的使细节我们主要介绍两个部分1.拦截器的拦截路径配置2.拦截器实现原理拦截路径是指我们定义的这个拦截器, 对哪些请求效.我们在注册配置拦截器的时候, 通过addPathPatterns()法指定要拦截哪些请求. 也可以通过excludePathPatterns()指定不拦截哪些请求.上述代码中, 我们配置的是 /** , 表拦截所有的请求.如登录校验, 我们希望可以对除了登录之外所有的路径效。 import org.springframework.beans.factory.annotation.Autowired; 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 { //?定义的拦截器对象 Autowired private LoginInterceptor loginInterceptor; Override public void addInterceptors(InterceptorRegistry registry) { //注册?定义拦截器对象 registry.addInterceptor(loginInterceptor) .addPathPatterns(/“) .excludePathPatterns(”/user/login);//设置拦截器拦截的请求路径 (/表?拦截所有请求) } }在拦截器中除了可以设置 /** 拦截所有资源外还有些常拦截路径设置以上拦截规则可以拦截此项中的使 URL包括静态件(图件, JS 和 CSS 等件)### 1.3拦截器执行流程正常的调顺序:有了拦截器之后会在调 Controller 之前进相应的业务处理执的流程如下图1.添加拦截器后, 执Controller的法之前, 请求会先被拦截器拦截住. 执 preHandle() 法这个法需要返回个布尔类型的值. 如果返回true, 就表放本次操作, 继续访问controller中的法. 如果返回false则不会放(controller中的法也不会执).****2.controller当中的法执完毕后再回过来执 postHandle() 这个法以afterCompletion() 法执完毕之后最终给浏览器响应数据.### 1.4登录校验学习拦截器的基本操作之后接下来我们需要完成最后步操作通过拦截器来完成图书管理系统中的登录校验功能.**1.定义拦截器**从session中获取信息, 如果session中不存在, 则返回false,并设置http状态码为401, 否则返回true.import com.example.demo.constant.Constants; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Component; import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpSession; Slf4j Component public class LoginInterceptor implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { HttpSession session request.getSession(false); if (session ! null session.getAttribute(Constants.SESSION_USER_KEY) ! null) { return true; } response.setStatus(401); return false; } } http状态码401: Unauthorized Indicates that authentication is required and was either not provided or has failed. If the request already included authorization credentials, then the 401 status code indicates that those credentials were not accepted. 中解释: 未经过认证. 指份验证是必需的, 没有提供份验证或份验证失败. 如果请求已经包含授权凭据那么401状态码表不接受这些凭据****2.注册配置拦截器import org.springframework.beans.factory.annotation.Autowired; 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 { //?定义的拦截器对象 Autowired private LoginInterceptor loginInterceptor; Override public void addInterceptors(InterceptorRegistry registry) { //注册?定义拦截器对象 registry.addInterceptor(loginInterceptor) .addPathPatterns(“/“)//设置拦截器拦截的请求路径(/表?拦截所有请 求) .excludePathPatterns(“/user/login”)//设置拦截器排除拦截的路径 .excludePathPatterns(//*.js”) //排除前端静态资源 .excludePathPatterns(//.css) .excludePathPatterns(/**/.png”) .excludePathPatterns(“/**/*.html”); } }3.删除之前的登录校验代码RequestMapping(“/getListByPage”) public Result getListByPage(PageRequest pageRequest, HttpSession session) { log.info(“获取图书列表, pageRequest:{}”, pageRequest); // //判断??是否登录 // if (session.getAttribute(Constants.SESSION_USER_KEY)null){ // return Result.unlogin(); // } // UserInfo userInfo (UserInfo) session.getAttribute(Constants.SESSION_USER_KEY); // if (userInfonull || userInfo.getId()0 || “”.equals(userInfo.getUserName())){ // return Result.unlogin(); // } //??登录, 返回图书列表 PageResult pageResult bookService.getBookListByPage(pageRequest); log.info(“获取图书列表222, pageRequest:{}”, pageResult); return Result.success(pageResult); }**4运程序, 通过Postman进测试:**4.1查看图书列表观察返回结果: h也可以通过Fiddler抓包观察4.2登录4.3再次查看图书列表数据进了返回
返回列表