SpringMVC——拦截器的使用

SpringMVC——拦截器

1、什么是拦截器

  • 在开发一个网站时可能有这样的需求:某些页面只希望几个特定的用户浏览。对于这样的访问权限控制,应该如何实现呢?拦截器就可以实现上述需求。在 Struts 2 框架中,拦截器是其重要的组成部分,Spring MVC框架也提供了拦截器功能。

  • SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能,比如权限验证、记录请求信息的日志、判断用户是否登录等功能。

过滤器

  • servlet规范中的一部分,任何java web工程都可以使用
  • 在url-pattern中配置了/*之后,可以对所有要访问的资源进行拦截

拦截器

  • 拦截器是SpringMVC框架自己的,只有使用了SpringMVC框架的工程才能使用
  • 拦截器只会拦截访问的**控制器**方法, 如果访问的是jsp/html/css/image/js是不会进行拦截的

**过滤器与拦截器的区别:**拦截器是AOP思想的具体应用。

2、拦截器的定义

在 Spring MVC 框架中定义一个拦截器需要对拦截器进行定义和配置,定义一个拦截器可以通过两种方式:

  • 一种是通过实现 HandlerInterceptor 接口或继承 HandlerInterceptor 接口的实现类来定义;

  • 另一种是通过实现 WebRequestInterceptor 接口或继承 WebRequestInterceptor 接口的实现类来定义。

下面通过实现 HandlerInterceptor 接口或继承 HandlerInterceptor 接口的实现类来定义:

package interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class TestInterceptor implements HandlerInterceptor {
    
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle方法在控制器的处理请求方法调用之后,解析视图之前执行");
        return true;
    }
    
    public void postHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle方法在控制器的处理请求方法调用之后,解析视图之前执行");
    }
    
    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("afterCompletion方法在控制器的处理请求方法执行完成后执行,即视图渲染结束之后执行");

    }
}

在上述拦截器的定义中实现了 HandlerInterceptor 接口,并实现了接口中的 3 个方法。有关这 3 个方法的描述如下。

  • preHandle 方法:该方法在控制器的处理请求方法前执行,其返回值表示是否中断后续操作,返回 true 表示继续向下执行,返回 false 表示中断后续操作。
  • postHandle 方法:该方法在控制器的处理请求方法调用之后、解析视图之前执行,可以通过此方法对请求域中的模型和视图做进一步的修改。
  • afterCompletion 方法:该方法在控制器的处理请求方法执行完成后执行,即视图渲染结束后执行,可以通过此方法实现一些资源清理、记录日志信息等工作。

让自定义的拦截器生效需要在 Spring MVC 的配置文件中进行配置:

<!--配置拦截器-->
<mvc:interceptors>
    <bean class="com.cheng.interceptor.MyInterceptor"/>
    <mvc:interceptor>
        <!-- 配置不需要拦截作用的路径
        <mvc:exclude-mapping path=""/>
        -->
        <!--配置拦截器作用的路径, /**拦截所有的请求-->
        <mvc:mapping path="/**"/>
        <bean class="com.cheng.interceptor.MyInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

简单的测试一下:

   @RequestMapping("/t1")
    public String test1(){
        System.out.println("test1方法执行了");
        return "ok";
    }

在这里插入图片描述

3、拦截器的执行流程

单个拦截器的执行流程:

  • 由上面例子可知,在配置文件中如果只定义了一个拦截器,程序将首先执行拦截器类中的 preHandle 方法,如果该方法返回 true,程序将继续执行控制器中处理请求的方法,否则中断执行。如果 preHandle 方法返回 true,并且控制器中处理请求的方法执行后、返回视图前将执行 postHandle 方法,返回视图后才执行 afterCompletion 方法。

多个拦截器的执行流程:

  • 在 Web 应用中通常需要有多个拦截器同时工作,这时它们的 preHandle 方法将按照配置文件中拦截器的配置顺序执行,而它们的 postHandle 方法和 afterCompletion 方法则按照配置顺序的反序执行。

4、拦截器实现登录判断验证

需求:只有成功登录的用户才能访问系统的主页面 main.jsp,如果没有成功登录而直接访问主页面,则拦截器将请求拦截,并转发到登录页面 login.jsp。当成功登录的用户在系统主页面中单击“退出”链接时回到登录页面。

1.实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String username;
    private String pwd;
}

2.controller

package com.cheng.controller;

import com.cheng.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpSession;
@Controller
@RequestMapping("/user")
public class LoginController {

    //登录功能
    @RequestMapping("/login")
    public String login(User user, Model model, HttpSession session){
        System.out.println(user.getUsername());
        if ("wanli".equals(user.getUsername())&&"123456".equals(user.getPwd())){

            //登录成功,将登录信息保存到session中
            session.setAttribute("user",user);
            //并且重定向到登录页面
            return "main";
        }else {
            model.addAttribute("msg","用户名或密码错误,请重新登录! ");
            return "login";
        }
    }
    //登录页面
    @RequestMapping("/toLogin")
    public String toLogin(){
        return "login";
    }
    //主页面
    @RequestMapping("/toMain")
    public String main(){
        return "main";
    }
    //实现退出登录功能
    @RequestMapping("/logout")
    public String logout(HttpSession session){
        //清除session,返回登录页面,重新登录
        session.invalidate();
        return "login";
    }
}

3.编写拦截器

package com.cheng.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

public class LoginInterceptor implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //获取请求的url
        String url = request.getRequestURI();
        //login.jsp或登录请求放行
        if (request.getRequestURI().contains("login")) {
            return true;
        }
        if (request.getRequestURI().contains("toLogin")) {
            return true;
        }

        //获取session
        HttpSession session = request.getSession();
        Object user = session.getAttribute("user");
        if(user!=null)//如果session不为空,继续放行
            return true;

            request.setAttribute("msg","还没登录,请先登录!");
            request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
            return false;

    }
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    }
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    }
}

4.首页index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <body>
  <h1>
    <a href="${pageContext.request.contextPath}/user/toLogin">点击登录</a>
  </h1>
  <h1>
    <a href="${pageContext.request.contextPath}/user/toMain">用户页面</a>
  </h1>
  </body>
</html>

5.登录页面login.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>登录页面</title>
</head>
<body>
${msg}
<form action="${pageContext.request.contextPath}/user/login" method="post">
    用户名:<input type="text" name="username"/>
    密码:<input type="password" name="pwd"/>
    <input type="submit" value="登录">

</form>
</body>
</html>

6.用户主页面main.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
当前用户${user.username}<br/>
<h1 style="color: crimson">欢迎来到用户页面</h1>

<a href="${pageContext.request.contextPath}/user/logout">点击退出</a>
</body>
</html>

7启动Tomcat测试:

  1. 首页点击用户页面,因为未登录,所以拦截器把请求拦截并转发到登录页面

    在这里插入图片描述

在这里插入图片描述

  1. 首页点击登录,跳转到登陆页面,输入用户名和密码,成功进入到用户页面

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

  1. 在用户主页点击退出,则跳转到登录页面,需要重新登录

8.测试完成!

### SpringMVC 拦截器与 SpringBoot 拦截器的实现方式与配置方法 #### 实现方式对比 在 **Spring MVC** 中,通常通过 XML 配置文件来设置拦截器。开发者可以在 `spring-mvc.xml` 文件中定义 `<mvc:interceptors>` 节点并指定要使用拦截器类[^1]。 而在 **Spring Boot** 应用程序里,则更倾向于采用基于 Java 的配置方式。这不仅简化了项目的结构,还提高了代码的可读性和维护性。具体来说,在 Spring Boot 中创建自定义拦截器时,会编写一个实现了 `HandlerInterceptor` 或者继承 `WebMvcConfigurerAdapter`(对于较新版本推荐直接实现 `WebMvcConfigurer`)接口的组件,并在此基础上完成相应的逻辑编码[^2]。 #### 配置方法差异 为了使自定义拦截器能够被识别和调用,在传统的 **Spring MVC** 架构下,除了上述提到的 XML 方式外,还可以利用 `@Component` 注解配合 `@Order` 来控制执行顺序;而到了 **Spring Boot**, 则强调使用带有 `@Configuration` 注解的配置类来进行统一管理[^3]。这意味着所有的 Bean 定义以及额外的功能扩展都可以集中在一个地方处理,从而增强了模块间的耦合度控制能力。 下面是一个简单的例子展示如何在两种框架内分别添加全局级别的路径匹配规则: ##### Spring MVC (XML) ```xml <mvc:interceptors> <!-- 可选地应用到特定URL模式 --> <bean class="com.example.MyCustomInterceptor"/> </mvc:interceptors> ``` ##### Spring Boot (Java Config) ```java @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new MyCustomInterceptor()) .addPathPatterns("/api/**"); // 对应于/api开头的所有请求路径 } } ``` 值得注意的是,尽管两者之间存在这些不同之处,但在实际开发过程中二者的核心概念保持一致——即都是围绕着 HTTP 请求生命周期中的预处理、后处理阶段展开工作的。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

万里顾—程

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值