Spring boot 2.x 注册拦截器HandlerInterceptor 与 自定义资源映射虚拟路径
发布日期:2021-06-23 19:02:35 浏览次数:9 分类:技术文章

本文共 5438 字,大约阅读时间需要 18 分钟。

目录


本文环境: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(首页).

一:定义拦截器

import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;/** * 登录拦截器 * * @author wangmaoxiong * @version 1.0 * @date 2020/4/30 17:18 */public class LoginHandlerInterceptor implements HandlerInterceptor {    @Override    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {    }    @Override    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {    }    /**     * 请求进入时拦截,返回 true 时,表示继续往下走;返回 false 表示停止后续的执行,即请求不会到达控制层.     *     * @param request     * @param response     * @param handler     * @return     * @throws Exception     */    @Override    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {        System.out.println("拦截请求:" + request.getRequestURL());        //getSession():返回与此请求关联的当前会话,或者如果该请求没有会话,则创建一个会话。        Object isLogin = request.getSession().getAttribute("isLogin");        //不为 null,则说明一次会话内,已经请求过 /user/index,否则就让它先去请求 /user/index        if (isLogin == null) {            //重定向到 /user/index            response.sendRedirect("/user/index");            return false;        }        return true;    }

二:注册拦截器

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

import com.wmx.thymeleafapp.interceptor.LoginHandlerInterceptor;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.InterceptorRegistry;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;/** * @author wangmaoxiong * @version 1.0 * @date 2020/4/30 17:25 * 实现 WebMvcConfigurer 接口,然后重启需要的方法,比如注册拦截器,则重写 addInterceptors(InterceptorRegistry registry) */@Configurationpublic class MvcConfigurer implements WebMvcConfigurer {    /**     * 注册拦截器     * .addPathPatterns("/**"):表示拦截整个应用中的所有请求     * .excludePathPatterns(String... patterns):表示排除这些规则的请求,不对它们进行拦截     * 

* spring Boot 2 以后,静态资源也会被拦截. * classpath:/META‐INF/resources/","classpath:/resources/","classpath:/static/","classpath:/public/"下的资源也会被拦截 * 通常静态资源可以不需要进行拦截,可以对它们直接进行放行 * @param registry */ @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LoginHandlerInterceptor()) .addPathPatterns("/**") .excludePathPatterns("/user/index") .excludePathPatterns("/webjars/**", "/css/**/*.css", "/js/**/*.js", "/fonts/**", "/images/**"); }}

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

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

import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.GetMapping;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpSession;/** * @author wangmaoxiong * @version 1.0 * @date 2020/4/29 16:31 */@Controllerpublic class UserController {    /**     * 跳转到首页.     * @return     */    @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";    }}

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

自定义资源映射虚拟路径

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 时就会放行,不会再影响资源访问。

/**     * 自定义资源映射     * addResourceHandler(String... pathPatterns) : 添加静态资源映射路径,这些资源都不会被拦截.     * addResourceLocations(String... resourceLocations):添加静态资源路径     * pathPatterns:虚拟路径/映射路径,即用户从前端请求的路径,如 http://ip:port/context-path/uploadFiles/1.mp4     * resourceLocations:实际路径(结尾的斜杆不能省略)。可以是类路径,也可以是磁盘的实际路径,如 D:/wmx/mp4     * classpath 表示类路径、file 表示磁盘路径     * pathPatterns(虚拟路径)会自动映射到 resourceLocations(实际资源位置)     *     * @param registry     */    @Override    public void addResourceHandlers(ResourceHandlerRegistry registry) {        registry.addResourceHandler("/data/**").addResourceLocations("classpath:/data/");        registry.addResourceHandler("/disk/**").addResourceLocations("file:///C:/wmx/desktop/");    }

总结一下:

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

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

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

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

 

转载地址:https://wangmaoxiong.blog.csdn.net/article/details/81267769 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:Swift基础-0006 【swift函数调用】
下一篇:Swift基础-0005

发表评论

最新留言

很好
[***.229.124.182]2024年04月07日 00时28分15秒

关于作者

    喝酒易醉,品茶养心,人生如梦,品茶悟道,何以解忧?唯有杜康!
-- 愿君每日到此一游!

推荐文章

Java Web基础入门第三十五讲 JSP技术——JSTL标签库之核心标签 2019-04-27
Java Web基础入门第三十六讲 JSP技术——EL表达式 2019-04-27
Java Web基础入门第三十七讲 JSP技术——EL函数库 2019-04-27
Java Web基础入门第三十八讲 国际化(i18n) 2019-04-27
Java Web基础入门第三十九讲 利用易宝第三方支付实现简单在线支付 2019-04-27
Java Web基础入门第四十讲 使用HttpUrlConnection模拟浏览器 2019-04-27
Java Web基础入门第四十一讲 SQL简单入门 2019-04-27
Java Web基础入门第四十二讲 MySQL常见数据类型详解 2019-04-27
Java Web基础入门第四十四讲 数据库表的设计 2019-04-27
Java Web基础入门第四十五讲 JDBC学习入门 2019-04-27
Java Web基础入门第四十六讲 使用JDBC对数据库进行CRUD 2019-04-27
Java Web基础入门第四十七讲 对基于Servlet+JSP+JavaBean开发模式的用户登录注册的升级 2019-04-27
Java Web基础入门第四十八讲 JDBC实现客户关系管理系统模块 2019-04-27
Java Web基础入门第四十九讲 客户关系管理系统之分页查询 2019-04-27
Java Web基础入门第五十讲 学生信息查询之分页练习 2019-04-27
Java Web基础入门第五十一讲 使用JDBC处理MySQL大数据 2019-04-27
Java Web基础入门第五十二讲 使用JDBC进行批处理 2019-04-27
Java Web基础入门第五十三讲 获得MySQL数据库自动生成的主键 2019-04-27
Java Web基础入门第五十四讲 使用JDBC调用存储过程 2019-04-27
Java Web基础入门第七十讲 Filter(过滤器)——初识过滤器 2021-06-30