SpringMVC中的拦截器

最新推荐文章于 2024-08-08 07:35:05 发布

少营营

最新推荐文章于 2024-08-08 07:35:05 发布

阅读量118

点赞数

分类专栏： spirngMVC 文章标签： SpringMVC中的拦截器

本文链接：https://blog.csdn.net/weixin_35674711/article/details/95018802

版权

spirngMVC 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

SpringMVC中的拦截器

1. 拦截器的作用

Spring MVC 的处理器拦截器类似于Servlet开发中的过滤器Filter，用于对处理器（Controller）进行预处理和后处理。

用户可以自己定义一些拦截器来实现特定的功能（权限控制、日志处理等）。

谈到拦截器，还要向大家提一个词——拦截器链（Interceptor Chain）。拦截器链就是将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

说到这里，可能大家脑海中有了一个疑问，这不是我们之前学的过滤器吗？是的它和过滤器是有几分相似，但是也有区别，接下来我们就来说说他们的区别：

过滤器和拦截器的区别：

区别1：

过滤器是servlet规范中的一部分，任何java web工程都可以使用。

拦截器是SpringMVC框架自己的，只有使用了SpringMVC框架的工程才能用。

区别2：

过滤器在url-pattern中配置了/*之后，可以对所有要访问的资源拦截。

拦截器它是只会拦截访问的控制器方法（只会拦截Controller），如果访问的是jsp，html,css,image或者js是不会进行拦截的。

它也是AOP思想的具体应用。

我们要想自定义拦截器，要求必须实现：HandlerInterceptor接口。

2. 自定义拦截器的步骤

第一步：创建工程

第二步：导入坐标

<!-- 版本锁定 -->
<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <spring.version>5.0.2.RELEASE</spring.version>
</properties>


<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <version>2.5</version>
        <scope>provided</scope>
    </dependency>

    <dependency>
        <groupId>javax.servlet.jsp</groupId>
        <artifactId>jsp-api</artifactId>
        <version>2.0</version>
        <scope>provided</scope>
    </dependency>

    <dependency>
        <groupId>jstl</groupId>
        <artifactId>jstl</artifactId>
        <version>1.2</version>
    </dependency>
</dependencies>

第三步：web.xml

<!-- SpringMVC的核心控制器 -->
<servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!-- 配置Servlet的初始化参数，读取springmvc的配置文件，创建spring容器 -->
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <!-- 配置servlet启动时加载对象 -->
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

<!--配置解决中文乱码过滤器-->
<filter>
    <filter-name>characterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>utf-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>characterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

第四步：springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">
    <context:component-scan base-package="com.itheima.controller"/>

    <!--视图解析器-->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"></property>
        <property name="suffix" value=".jsp"></property>
    </bean>

    <mvc:annotation-driven></mvc:annotation-driven>

    <!-- 设置静态资源不过滤 -->
    <mvc:resources location="/css/" mapping="/css/**"/>  <!-- 样式 -->
    <mvc:resources location="/images/" mapping="/images/**"/>  <!-- 图片 -->
    <mvc:resources location="/js/" mapping="/js/**"/>  <!-- javascript -->

</beans>

第四步：导入UserController.java

@Controller
@RequestMapping(path = "/user")
public class UserController {

    // 自定义拦截器
    @RequestMapping(path="/testInterceptor")
    public String testInterceptor(){
        System.out.println("执行了testInterceptor方法！");
        return "success";
    }
}

第五步：导入index.jsp

<body>
<a href="user/testInterceptor">自定义拦截器</a>
</body>

导入WEB-INF/pages/success.jsp

<body>
<h1>访问成功</h1>
</body>

3. 自定义拦截器

第一步：自定义拦截器

创建包com.itheima.interceptor，创建类MyInterceptor1.java，实现HandlerInterceptor接口

public class MyInterceptor1 implements HandlerInterceptor{

    /**
     * controller方法执行前，进行拦截的方法
     * return true放行
     * return false拦截
     *   可以使用转发或者重定向直接跳转到指定的页面。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("访问Controller类之前执行...");
        return true;
    }
}

第二步：配置拦截器类

在springmvc.xml中配置拦截器类

<!--配置拦截器类-->
<mvc:interceptors>
    <mvc:interceptor>
        <!-- 哪些方法进行拦截 -->
        <mvc:mapping path="/user/*"/>
        <!--哪些方法不进行拦截-->
        <!--<mvc:exclude-mapping path="/user/save"/>-->
        <!-- 注册拦截器对象 -->
        <bean class="com.itheima.interceptor.MyInterceptor1"></bean>
    </mvc:interceptor>
</mvc:interceptors>

在success.jsp中添加：

<body>
<h1>访问成功</h1>
</body>

重新部署tomcat

测试：查看结果

HandlerInterceptor接口中的方法

1： preHandle方法是controller方法执行前拦截的方法
    可以使用request或者response跳转到指定的页面
    return true放行，执行下一个拦截器，如果没有拦截器，执行controller中的方法。
    return false不放行，不会执行controller中的方法。
2：postHandle是controller方法执行后执行的方法，在JSP视图执行前。
    可以使用request或者response跳转到指定的页面
    如果指定了跳转的页面，那么controller方法跳转的页面将不会显示。
3：afterCompletion方法是在JSP执行后执行（用的不多）
    request或者response不能再跳转页面了，否则抛出异常。

修改：MyInterceptor.java

public class MyInterceptor1 implements HandlerInterceptor{

    /**
     * controller方法执行前，进行拦截的方法（预处理）
     * return true放行
     * return false拦截
     *   可以使用转发或者重定向直接跳转到指定的页面。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor1访问Controller类之前执行...");
//        request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request,response);
        return true;
    }

    /**
     * controller方法执行后，进行拦截的方法（后处理），success.jsp执行之前
     *   可以使用转发或者重定向直接跳转到指定的页面。
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor1访问Controller类之后执行...");
//        request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request,response);
    }

    /**
     *  success.jsp执行之后，该方法执行（终处理）
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
        System.out.println("MyInterceptor1访问success.jsp之后...");
    }
}

重新启动tomcat，执行。

配置多个拦截器

第一步：再编写一个拦截器的类MyInterceptor2.java

public class MyInterceptor2 implements HandlerInterceptor{

    /**
     * controller方法执行前，进行拦截的方法（预处理）
     * return true放行
     * return false拦截
     *   可以使用转发或者重定向直接跳转到指定的页面。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor2访问Controller类之前执行...");
//        request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request,response);
        return true;
    }

    /**
     * controller方法执行后，进行拦截的方法（后处理），success.jsp执行之前
     *   可以使用转发或者重定向直接跳转到指定的页面。
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor2访问Controller类之后执行...");
//        request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request,response);
    }

    /**
     *  success.jsp执行之后，该方法执行（终处理）
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
        System.out.println("MyInterceptor2访问success.jsp之后...");
    }
}

第二步：配置2个拦截器

<!--配置拦截器类-->
<mvc:interceptors>
    <mvc:interceptor>
        <!-- 哪些方法进行拦截 -->
        <mvc:mapping path="/user/*"/>
        <!--哪些方法不进行拦截-->
        <!--<mvc:exclude-mapping path="/user/save"/>-->
        <!-- 注册拦截器对象 -->
        <bean class="com.itheima.interceptor.MyInterceptor1"></bean>
    </mvc:interceptor>
    <mvc:interceptor>
        <!-- 哪些方法进行拦截 -->
        <mvc:mapping path="/**"/>
        <!--哪些方法不进行拦截-->
        <!--<mvc:exclude-mapping path="/user/save"/>-->
        <!-- 注册拦截器对象 -->
        <bean class="com.itheima.interceptor.MyInterceptor2"></bean>
    </mvc:interceptor>
</mvc:interceptors>

启动tomcat，执行看效果：