SpringMvc中拦截器的原理搭建以及实现的具体步骤

于 2021-03-21 14:48:39 发布
阅读量541 收藏 1
点赞数 1
文章标签： mvc spring java 过滤器 interceptor
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/dadadaliang/article/details/115045652
版权

关于SpringMvc中的拦截器：
首先我们说说拦截器与过滤器的区别：
过滤器
以我们web.xml中的乱码过滤器为例

<filter>
        <filter-name>encoding</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>encoding</filter-name>
        <url-pattern>/(*)</url-pattern>
    </filter-mapping>

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

拦截器
①拦截器是SpringMvc框架自己的，只有使用了SpringMvc的框架工程才能使用，也就是拦截器是在SpringMvc中配置的，不是在web.xml中配置的，拦截器用的是aop的思想。
②拦截器只会拦截访问的控制器方法，如果访问的是静态资源如（html/css/image/js）是不会进行拦截的。

如何一步一步搭建具体的工程。（这里我们用一个web验证用户是否登录为例）
实现思路：
1、有一个登陆页面，需要写一个controller访问页面。

2、登陆页面有一提交表单的动作。需要在controller中处理。判断用户名密码是否正确。如果正确，向session中写入用户信息。返回登陆成功。

3、拦截用户请求，判断用户是否登陆。如果用户已经登陆。放行， 如果用户未登陆，跳转到登陆页面

在搭建之前我们需建立一个基础的框架（三个核心配置（web.xml,SpringMvc的配置文件SpringMvc-servlet.xml,控制器controller））来进行测试。
①新建一个Maven,添加web支持
②配置web.xml和SpringMvc-servlet.xml文件
web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <servlet>
        <servlet-name>SpringMvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:SpringMvc-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>SpringMvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!--配置SpringMvc的乱码过滤器-->
    <filter>
        <filter-name>encoding</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>encoding</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

SpringMvc-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd
        ">
    <context:component-scan base-package="com.xkl.Controller"/>
    <!--静态资源过滤，每一个开发web的操作都会静态资源过滤-->
    <mvc:default-servlet-handler/>

    <!--json的乱码问题配置-->
    <mvc:annotation-driven>
        <mvc:message-converters register-defaults="true">
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <constructor-arg value="UTF-8"/>
            </bean>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="objectMapper">
                    <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                        <property name="failOnEmptyBeans" value="false"/>
                    </bean>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
    
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

    <!--测试拦截器配置-->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--包括这个请求下的所有的请求-->
            <mvc:mapping path="/**"/><!--过滤哪个请求-->
            <bean class="com.xkl.Config.MyInterceptor"/><!--从哪个类来过滤-->
        </mvc:interceptor>
    </mvc:interceptors>

    <!--登录拦截器配置-->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--包括这个请求下的所有的请求-->
            <mvc:mapping path="/user/**"/><!--user下面的所有请求会经过这个拦截器，其他请求不经过。共包含index.jsp和login.jsp的三个-->
            <bean class="com.xkl.Config.LoginInterceptor"/><!--从哪个类来过滤-->
        </mvc:interceptor>
    </mvc:interceptors>
</beans>

准备工作做完了,该步入正题了
1、在WEB-INF下编写一个登陆页面。注意：在web-inf下的所有页面或者资源，只能通过controller或者servlet进行访问。
login.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<%--在web-inf下的所有页面或者资源，只能通过controller或者servlet进行访问--%>
    <h1>登录页面</h1>
    <hr>

    <form action="${pageContext.request.contextPath}/user/logsubmit">
        用户名：<input type="text" name="username"><br>
        密码：<input type="text" name="pwd"><br>
        <input type="submit" value="提交">
    </form>


</body>
</html>

注意到我们这里发起了一个logsubmit登录提交请求：在这里插入图片描述
2、所以我们需要在控制器里面处理这个请求：
LoginController
（这是总的代码段，分段在后面图片展示）

package com.xkl.Controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpSession;

@Controller
@RequestMapping("/user")
public class LoginController {
    //跳转到登录页面
    @RequestMapping("/jumplogin")
    public String jumpLogin()throws Exception{
        return "login";
    }

    //跳转到成功页面
    @RequestMapping("/jumpsuccess")
    public String jumpSuccess()throws Exception{
        return "success";
    }

    //登录提交
    @RequestMapping("/logsubmit")
    public String login(HttpSession session,String username,String pwd)throws Exception{
        //向session记录用户身份信息
        System.out.println("接收前端==="+username);
        session.setAttribute("user",username);
        if(username != null & username != "" & pwd != null & pwd != ""){
            return "success";
        }
        else {
            return "login";
        }


    }

    //注销登录
    @RequestMapping("/logout")
    public String logout(HttpSession session)throws Exception{
        //将登录时，存在了session的用户名销毁，这样信息不存在了，就相当于退出登录了。
        session.invalidate();
        return "login";
    }
}

在这里插入图片描述
判断前端是否有输入数据，如果前端有输入数据，就把数据存储到session里面。只要用户名和密码有一个输入不完整的就重新跳转到登录页面login.jsp。用户名和密码都输入就可以跳转到成功页面success.jsp。
3、下面把成功页面也完善下：
success.jsp

<%--
  Created by IntelliJ IDEA.
  User: xxxxxxkl
  Date: 2021/3/19
  Time: 15:26
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <H1>首页</H1>
    ${username}

    <p>
        <a href="${pageContext.request.contextPath}/user/logout">注销</a>
    </p>
</body>
</html>

4、注意到我们的登录成功页面有个注销请求，这时我们就得去控制器里面处理这个注销请求。
在这里插入图片描述
具体可理解为当我们点击注销的时候，将请求发送给控制器，控制器进行处理，处理的结果是删除session里的用户信息，这样就会跳转回登录页面了。

5、接下来就是在index.jsp页面进行测试跳转了。

<%--
  Created by IntelliJ IDEA.
  User: xxxxxxkl
  Date: 2021/3/19
  Time: 11:17
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>欢迎页面</title>
  </head>
  <body>
 <h1>首页</h1>
  <hr>
  <%--登录--%>
  <a href="${pageContext.request.contextPath}/user/jumplogin">登录</a>
  <a href="${pageContext.request.contextPath}/user/jumpsuccess">成功页面</a>
  </body>
</html>

这里我们可以理解为当我们点击登录的时候发起一个jumplogin的请求，点击成功页面的时候发起一个jumpsuccess请求。这两个请求皆在控制器里面进行处理。
在这里插入图片描述
进展到这里的时候一个基本的登录功能已经完成了，但是有一个缺点就是当我们直接从index页面直接点击跳转到成功页面，也可以跳转。而不需要登录，这显然不符合我们的设计。
那么这时候就需要一个拦截器了：实现只有登录了才能进入成功页面。
6、LoginInterceptor拦截器配置：

package com.xkl.Config;

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

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;

public class LoginInterceptor implements HandlerInterceptor {
   public boolean preHandle(HttpServletRequest request, HttpServletResponse response,Object handler)throws ServletException, IOException {
       /*如果是登录页面则放行*/
       System.out.println("uri:"+request.getRequestURI());
       if(request.getRequestURI().contains("logsubmit")){
           return true;
       }
       HttpSession session = request.getSession();


       /*如果用户已登录也放行*/
       if(session.getAttribute("user") != null)
       {
           return true;
       }

       /*用户没有登录的话就跳转到登录页面*/
       request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
       return false;
   }
    //拦截日志,请求方法后
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView mv){

    }

    //这个是清理作用：在所有方法执行后清理
    @Override
    public void afterCompletion(HttpServletRequest request,HttpServletResponse response,Object handler,Exception ex){

    }
}

7、配置文件写完后就需要在SpringMvc-servlet.xml（总的代码上面有）中进行配置了：

<!--登录拦截器配置-->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--包括这个请求下的所有的请求-->
            <mvc:mapping path="/user/**"/><!--user下面的所有请求会经过这个拦截器，其他请求不经过。共包含index.jsp和login.jsp的三个-->
            <bean class="com.xkl.Config.LoginInterceptor"/><!--从哪个类来过滤-->
        </mvc:interceptor>
    </mvc:interceptors>

这样就实现了如果没有登录就不能进入到成功页面了。

dadadaliang
关注
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值