spring拦截器指定路径拦截 springboot拦截器路径

转载

feiry 2024-02-20 11:13:19

文章标签 spring拦截器指定路径拦截 spring boot java 后端拦截器 文章分类 架构后端开发

文章目录

一、静态资源访问与首页定制
二、拦截器的使用
三、自定义出错页面跳转

一、静态资源访问与首页定制

在 Spring Boot 中，静态资源主要存放在以下 4 个位置：

spring拦截器指定路径拦截 springboot拦截器路径_java

src / main / java / resources / META-INF / resources
src / main / java / resources / public
src / main / java / resources / resources
src / main / java / resources / static

它们的访问优先级为：1 > 3 > 4 > 2

一般情况下，可在 public 下放一些公共的资源（如 js 等），static 下放一些图片等，resources 下放一些上传的文件等

当我们的静态资源文件名为 index.html 时，默认作为首页，所以只需通过 localhost:8080 即可访问到该页面，同时也覆盖了 Spring Boot 的默认首页

此时，通过 localhost:8080 即可显示首页内容：

spring拦截器指定路径拦截 springboot拦截器路径_后端_02

由于 META-INF / resources 下的静态资源访问优先级最高，因而最终显示的是该目录下的 index.html 的内容

二、拦截器的使用

拦截器在登录验证时经常用到，Spring Boot 中添加拦截器十分简单
首先，自定一个拦截器类实现 HandlerInterceptor接口，并重写 preHandle 方法，该方法会在请求发送至 Controller 前执行，返回 false 则拦截，拦截后请求失效；返回 true 则放行，放行后请求进入到 Controller 中
以登录验证为例，用户登录后信息存入至 Session 中，然后在拦截器的 preHandle 方法中取出 Session 中的用户信息，若为空则拦截请求，并重定向至登录页，不为空则 return true 放行

public class LoginHandlerInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object loginUser = request.getSession().getAttribute("loginUser");
        if (loginUser == null) {
            // 用户未登录，拦截  redirect重定向至登录界面 
            return false;
        } else {
            // 用户已登录，放行
            return true;
        }
    }
}

定义好拦截器之后，自然就是对 MVC 进行配置，将拦截器添加到配置中
定义一个类实现 WebMvcConfigurer 接口，重写 addInterceptors 方法，在其中添加上方定义好的拦截器

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginHandlerInterceptor()).addPathPatterns("/**").
                 excludePathPatterns("/index.html","/","/user/login","/css/**","/js/**","/img/**");
    }
}

addPathPatterns 表示添加需拦截的请求路径，excludePathPatterns 表示排除拦截的路径（一般在这里放行静态资源，如 css, js 等, /** 表示其下的所有请求）
显然，首页请求、登录验证请求以及静态资源的请求路径都是要排除在外的
最后的效果就是：如果我们没有进行登录操作，直接在浏览器地址栏中访问登录后的主页（如 / user / main ），此时便会重定向至登录页，登录后则不进行拦截