拦截器的介绍及使用

2年前 (2022) 程序员胖胖胖虎阿
365 0 0

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档

文章目录

  • 拦截器代码实现
  • 一、拦截器是什么?
  • 二、设置拦截器
    • 【第一步】定义拦截器
    • 【第二步】配置加载拦截器
    • 三、新建页面

拦截器代码实现

必须保证页面中有访问controller的操作,否则拦截不了

一、拦截器是什么?

拦截器是属于springmvc体系的,只能拦截controller的请求

  • 拦截器(Interceptor)是一种动态拦截方法调用的机制,在SpringMVC中动态拦截控制器方法的执行

  • 作用:

    1. 在指定的方法调用前后执行预先设定的代码
    2. 阻止原始方法的执行
    3. 总结:增强
  • 核心原理:AOP思想
    拦截器的介绍及使用

二、设置拦截器

【第一步】定义拦截器

postHandle 前置处理
参数

  1. request:请求对象
  2. response:响应对象
  3. handler:被调用的处理器对象,本质上是一个方法对象,对反射技术中的Method对象进行了再包装
    返回值为false,被拦截的处理器将不执行。

afterCompletion 后置处理
参数
.modelAndView:如果处理器执行完成具有返回结果,可以读取到对应数据与页面信息,并进行跳
注意:如果处理器方法出现异常了,该方法不会执行

举例:登录功能, 静态资源 backend fornt

@Component //注意当前类必须受Spring容器控制
//定义拦截器类,实现HandlerInterceptor接口
public class MyInterceptor implements HandlerInterceptor {
     @Override
    // 原始方法调用前执行的内容
    // 返回值类型可以拦截控制的执行,true放行,false终止
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle..." + contentType);
        //获取session中的数据
        Object employee = request.getSession().getAttribute("employee");

        //若为空,不放行,且写回页面指定数据
        if (employee == null) {
            R r = R.error("NOTLOGIN");
            response.getWriter().print(JSON.toJSON(r));
            return false;
        }
        return true;
    }

    @Override
    // 原始方法调用后执行的内容
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }

    @Override
    // 原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

【第二步】配置加载拦截器

方式1:可以继承WebMvcConfigurationSupport,但是默认静态资源路径不好使,必须重新映射

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        // 配置拦截器
        registry.addInterceptor(myInterceptor)
            .addPathPatterns("/**") // 需要拦截的路径(/** 拦截所有路径)
            .excludePathPatterns("/employee/login","/backend/**","/front/**");//放行静态资源和登陆资源;
          
    }
}

方式2:可以实现WebMvcConfigurer接口,默认静态资源路径好使.还可以重新映射
代码如下(示例):

@Configuration
// 实现WebMvcConfigurer接口可以简化开发,但具有一定的侵入性
public class MvcConfig implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    // 拦截器 添加拦截器并设定拦截的访问路径, 路径可以通过可变参数设置多个
	/**
 	  * addInterceptor:需要一个实现HandlerInterceptor接口的拦截器实例
 	  * addPathPatterns:用于设置拦截器的过滤路径规则;addPathPatterns("/**")对所有请求都拦截
 	  * excludePathPatterns:用于设置不需要拦截的过滤规则
 	  * 拦截器主要用途:进行用户登录状态的拦截,日志的拦截等。
 	*/
    pulbic void addInterceptors(InterceptorRegistry registry) {
    	// 配置拦截器
        registry.addInterceptor(myInterceptor)
                .addPathPatterns("/**")// 需要拦截的路径(/** 拦截所有路径)
            	.excludePathPatterns("/employee/login","/backend/**","/front/**");//放行静态资源和登陆资源; 
          
    }
}

三、新建页面

方式1:

我们可以查看WebProperties类的源码,看到静态资源可以存在于以下类路径下的几个路径中任意一个

  • /META-INF/resources/
  • /resources/
  • /static/
  • /public/

推荐:/static/


方式2:

我们也可以将路径放在类路径下,通过mvc的配置类放行静态资源

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    // 拦截器 添加拦截器并设定拦截的访问路径, 路径可以通过可变参数设置多个
	/**
 	  * addInterceptor:需要一个实现HandlerInterceptor接口的拦截器实例
 	  * addPathPatterns:用于设置拦截器的过滤路径规则;addPathPatterns("/**")对所有请求都拦截
 	  * excludePathPatterns:用于设置不需要拦截的过滤规则
 	  * 拦截器主要用途:进行用户登录状态的拦截,日志的拦截等。
 	*/
    pulbic void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/employee/login","/backend/**","/front/**");//放行静态资源和登陆资源; 
    }
    
    @Override
    // 设置静态资源访问过滤,当前类需要设置为配置类,并被扫描加载
 	/**
 	  * addResoureHandler:指的是对外暴露的访问路径
 	  * addResourceLocations:指的是内部文件放置的目录
 	 */
    pulbic void addResourceHandlers(ResourceHandlerRegistry registry) {
    	// 当访问/XXX/????时候,从/xxx目录下查找内容
    	
        // 1、注册backend静态资源处理方式 **匹配多级路径
        registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
        // 2、注册front静态资源处理方式
        registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
    }

}

版权声明:程序员胖胖胖虎阿 发表于 2022年10月7日 下午2:32。
转载请注明:拦截器的介绍及使用 | 胖虎的工具箱-编程导航

相关文章

暂无评论

暂无评论...