拦截器 HandlerInterceptor

自定义资源映射虚拟路径

WebMvcConfigurer 配置

本文环境：Java jdk 1.8 + Spring Boot 2.1.3 + Thymeleaf 模板引擎。

拦截器 HandlerInterceptor

1、对于管理系统，通常都需要进行身份认证、权限控制等操作，比如不能让用户直接就进到了后台主页，必须先经过登陆页进行登陆。

2、Spring MVC 的 org.springframework.web.servlet.HandlerInterceptor 拦截器，可以对任何的后台请求进行拦截，Spring Boot 2.x 版本中默认还会对所有静态资源一并拦截。

3、本文进行简单的演示：用户对系统发起中的所有请求，比如先经过 user/index ，否则都会重定向到 user/index（首页）.

4、HandlerInterceptor 拦截器接口一共有3个方法：

preHandle

拦截处理程序的执行：在 HandlerMapping 确定适当的处理程序对象之后，且在 HandlerAdapter 调用处理程序之前调用。

postHandle

拦截处理程序的执行：在 HandlerAdapter 实际调用处理程序之后，且在 DispatcherServlet 呈现视图之前调用。

afterCompletion

请求处理完成后(即呈现视图后)回调，将在处理程序执行的任何结果上调用，从而允许适当的资源清理。

注意：仅当此拦截器的 preHandle 方法已成功完成并返回 true 时才会调用！
与 postHandle 方法一样，该方法将按相反顺序在链中的每个拦截器上调用，因此第一个拦截器将是最后一个被调用的拦截器。

一：定义拦截器

public class LoginHandlerInterceptor implements HandlerInterceptor {@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {}/*** 请求进入时拦截，返回 true 时，表示继续往下走；返回 false 表示停止后续的执行，即请求不会到达控制层.** @param request* @param response* @param handler* @return* @throws Exception*/@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {//getSession()：返回与此请求关联的当前会话，或者如果该请求没有会话，则创建一个会话。Object isLogin = request.getSession().getAttribute("isLogin");//不为 null，则说明一次会话内，已经请求过 /user/index，否则就让它先去请求 /user/indexif (isLogin == null) {//重定向到 /user/indexresponse.sendRedirect("/user/index");System.out.println("拦截请求：" + request.getRequestURL() + " 拦截");return false;}System.out.println("拦截请求：" + request.getRequestURL() + " 放行");return true;}

src/main/java/com/wmx/yuanyuan/interceptor/LoginHandlerInterceptor.java · 汪少棠/yuanyuan - Gitee.com

二：注册拦截器

1、实现 WebMvcConfigurer 接口进行 mvc 配置。

/*** 自定义 mvc 配置* 实现 WebMvcConfigurer 接口，然后重写需要的方法，比如注册拦截器，则重写 addInterceptors(InterceptorRegistry registry)* 通过全局文件配置 sys.config.handler-interceptor-is-open 属性来控制此配置类是否生效.*/
@Configuration
public class MvcConfigurer implements WebMvcConfigurer {/*** 注册拦截器* .addPathPatterns("/**")：表示拦截整个应用中的所有请求* .excludePathPatterns(String... patterns)：表示排除这些规则的请求，不对它们进行拦截* <p>* 1、spring Boot 2 以后，静态资源也会被拦截，包括'自定义资源映射'* * classpath:/META‐INF/resources/","classpath:/resources/","classpath:/static/","classpath:/public/"下的资源也会被拦截* * 通常静态资源可以不需要进行拦截，可以对它们直接进行放行。* 2、swagger 作为前端人员展示的文档，也可以不用拦截，/swagger/xx, /csrf** @param registry*/@Overridepublic void addInterceptors(InterceptorRegistry registry) {// 添加拦截器InterceptorRegistration registration = registry.addInterceptor(new LoginHandlerInterceptor());// 设置拦截的路径 /** 表示所有registration.addPathPatterns("/**");// 设置不拦截的路径，将静态资源文件全部放行registration.excludePathPatterns("/user/index", "/error").excludePathPatterns("/webjars/**", "/css/**", "/js/**", "/fonts/**", "/images/**").excludePathPatterns("/scss/**", "/vendor/**", "/favicon.ico").excludePathPatterns("/swagger*/**", "/csrf").excludePathPatterns("/data/**", "/disk/**");// 通配符规则：https://www.cnblogs.com/crazyghostvon/p/AntPathMatcher.html}
}

src/main/java/com/wmx/yuanyuan/config/MvcConfigurer.java · 汪少棠/yuanyuan - Gitee.com

使用 spring boot 2.x 时，静态资源默认也会被拦截，如果对于比较敏感的资源，则可以让它像后台接口一样，可以让它被正常拦截。而普通的静态资源，如 css、js、image 等，可以不需要进行拦截，否则登录页的样式会显示不出来。

三：定义登陆成功时的 HttpSession 属性

    //跳转到首页.@GetMapping("user/index")public String toIndex(HttpServletRequest request) {//getSession()：返回与此请求关联的当前会话，或者如果该请求没有会话，则创建一个会话。HttpSession httpSession = request.getSession();httpSession.setAttribute("isLogin", true);//设置会话超时时间(秒)。表示用户此时间内没有访问本系统时，则会话失效。默认为 30 分钟//只要用户访问本应用下的任意资源都是可以的，都能维持会话. 当用户关闭浏览器后会话也会结束。下一次会是一次新的会话.httpSession.setMaxInactiveInterval(60 * 60);//返回到 thymeleaf 模板目录下的 index.html 页面return "index";}

src/main/java/com/wmx/yuanyuan/controller/UserController.java · 汪少棠/yuanyuan - Gitee.com

四：因为没做登陆页面，所以只是简单的设置一个属性，效果就是访问网站中的任意页面请求时，都会先经过首页 index.html.

src/main/resources/templates/index.html · 汪少棠/yuanyuan - Gitee.com

自定义资源映射虚拟路径

1、Spring Boot 约定的这 4 个静态资源目录为：

1）classpath:/META‐INF/resources/",
2）"classpath:/resources/"
3）"classpath:/static/"
4）"classpath:/public/

2、假如有资源不是位于约定的4个静态目录下，而是位于类路径下的其它资源目录下:

1）如果没有设置拦截器，则仍然可以直接访问
2）如果设置了拦截器，则自定义资源会被拦截，即使拦截器内部返回 true ，也不会被放行，一直会报 404 错误.

3、解决方式仍然是实现 WebMvcConfigurer 接口，重写 addResourceHandlers 方法，然后使用 ResourceHandlerRegistry 来注册资源，这样被拦截之后，当拦截器内部返回 true 时就会放行，不会再影响资源访问。

4、下面演示访问类路径下的自定义资源目录以及访问服务器磁盘目录。

    /*** 自定义资源映射* addResourceHandler(String... pathPatterns) : 添加静态资源映射路径，这些路径也会默认会被拦截，可以在上面放行。* * pathPatterns：虚拟路径/映射路径，即用户从前端请求的路径，然后会自动映射到后面的实际路径。* addResourceLocations(String... resourceLocations)：添加静态资源路径* * resourceLocations：实际路径(结尾的斜杆不能省略)，可以是类路径，也可以是磁盘的实际路径，如 D:/wmx/mp4* * 'classpath:' ：表示类路径，结尾的斜杆不能少。* * 'file:///' ：表示磁盘路径，无论是谁，。* * pathPatterns（虚拟路径）会自动映射到 resourceLocations（实际资源位置）* <p>* http://localhost:8080/data/hi.json* http://localhost:8080/disk/富士山下 - 陈奕迅.mp3** @param registry*/@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("/data/**").addResourceLocations("classpath:/data/");registry.addResourceHandler("/disk/**").addResourceLocations("file:///F:/Music/");}

src/main/java/com/wmx/yuanyuan/config/MvcConfigurer.java · 汪少棠/yuanyuan - Gitee.com

WebMvcConfigurer 配置

1、InterceptorRegistry 用于注册拦截器，ResourceHandlerRegistry 用于注册资源。

2、ResourceHandlerRegistry 注册的资源可以是类路径下的，也可以是本地磁盘的。

3、ResourceHandlerRegistry 注册的资源也会被拦截器拦截，当拦截器内部返回 true 时，就会正常访问。

4、关于虚拟路径映射本地磁盘，可以参考《 Spring Boot 嵌入式 Tomcat 文件上传、url 映射虚拟路径》，因为 Spring Boot 应用部署时是打的 jar 包，上传的文件不可能再放到 jar 包内部，只能是在磁盘的某个位置，所以必须做虚拟路径映射。

Spring boot 拦截器(HandlerInterceptor) 与自定义资源映射虚拟路径，WebMvcConfigurer相关推荐

Spring boot拦截器登录检查
拦截器进行登录检查从登录页面跳转到成功页面之后为了防止表单重复提交配置视图映射,利用重定向到成功页面此时,在浏览器直接输入,配置的视图映射地址也可以直接映射.跳转到成功页面登录页面,也就 ...
使用spring boot拦截器实现青少年模式
思路方法一: 便用Spring Boot拦截器采累计在线时间采实现青少年模式的步骤,可以参考以卜步骤: 1.创建一个拦截器类,实现Handlerlnterceptor 接口. 2.在拦截器类中,定义一 ...
Spring Boot拦截器（WebMvcConfigurerAdapter）
直接按我的步骤走都没有问题: 1 配置自定义的拦截器: package com.configs;import org.slf4j.Logger; import org.slf4j.LoggerFact ...
【Java Web开发学习】Spring MVC 拦截器HandlerInterceptor
[Java Web开发学习]Spring MVC 拦截器HandlerInterceptor 转载:https://www.cnblogs.com/yangchongxing/p/9324119.ht ...
解决Spring Boot 拦截器注入service为空的问题
解决Spring Boot 拦截器注入service为空的问题参考文章: (1)解决Spring Boot 拦截器注入service为空的问题 (2)https://www.cnblogs.com/ ...
Spring Boot拦截器(Interceptor)详解
写了那么久的博客,始于Python爬虫,目前专于Java学习,终于有了属于自己的小窝,欢迎各位访问我的个人网站. 文章目录 Interceptor 介绍 Interceptor 作用自定义 Inte ...
spring boot拦截器过滤器
1.拦截器登录拦截自定义拦截路径 //全局配置继承WebMvcConfigurer接口 @Configuration public class MyHandler implements WebMv ...
spring boot 拦截器获取controller返回的数据_高级码农Spring Boot实战与进阶之过滤器和拦截器的使用及其区别...
众所周知的Spring Boot是很优秀的框架,它的出现简化了新Spring应用的初始搭建以及开发过程,大大减少了代码量,目前已被大多数企业认可和使用.这个专栏将对Spring Boot框架从浅入深, ...
Spring Boot 拦截器
(一)拦截器概述 1.1拦截器介绍拦截器的作用类似于Servlet 中的Filter,都可以用于对处理器进行预处理和后处理.在Spring MVC 与Spring Boot 中使用拦截器一般是实现H ...
Spring Boot 拦截器无效，不起作用
这个问题一般是解决WebMvcConfigurerAdapter过时问题造成的.导致这个问题可能有两个原因:一个是拦截器写错了,另一个是拦截器配置错了. 1.需求是这样的拦截所有的api请求,判断其 ...

Spring boot 拦截器(HandlerInterceptor) 与自定义资源映射虚拟路径，WebMvcConfigurer

拦截器 HandlerInterceptor

自定义资源映射虚拟路径

WebMvcConfigurer 配置

Spring boot 拦截器(HandlerInterceptor) 与自定义资源映射虚拟路径，WebMvcConfigurer相关推荐

最新文章

热门文章

Spring boot 拦截器(HandlerInterceptor) 与 自定义资源映射虚拟路径，WebMvcConfigurer

拦截器 HandlerInterceptor

自定义资源映射虚拟路径

WebMvcConfigurer 配置

Spring boot 拦截器(HandlerInterceptor) 与 自定义资源映射虚拟路径，WebMvcConfigurer相关推荐

最新文章

热门文章

Spring boot 拦截器(HandlerInterceptor) 与自定义资源映射虚拟路径，WebMvcConfigurer

Spring boot 拦截器(HandlerInterceptor) 与自定义资源映射虚拟路径，WebMvcConfigurer相关推荐