1. 程式人生 > 其它 >spring-mvc攔截器

spring-mvc攔截器

技術標籤:javaspringmvcsession過濾器

攔截器概述

攔截器是springMVC中特有的,與過濾器不同的是,過濾器是servlet中的一部分,任何框架都可以使用。攔截器只能夠對controller中的請求進行攔截,攔截器也是aop思想的一種體現。如果我們想要定義一個攔截器,就必須要實現HandlerInterceptor介面,重寫preHandle方法。

下面通過案例來解釋

案例解釋:首頁有登入和進入主頁兩個功能,如果沒有登入不能夠直接進入到主頁中,需要登入之後才能夠進入。如果登入之後,再次點選首頁無序登入,可直接進入。

springmvc的配置檔案

<?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:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation
="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd"
>
<!-- 自動掃描包--> <context:component-scan base-package="com.duhaoyu.controller"/> <!-- 靜態資源過濾--> <mvc:default-servlet-handler/> <mvc:annotation-driven/> <!-- 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" id="internalResourceViewResolver"> <property name="prefix" value="/WEB-INF/jsp/"/> <property name="suffix" value=".jsp"/> </bean> <!--配置攔截器--> <mvc:interceptors> <mvc:interceptor> <!-- 表示攔截user請求下的所有請求--> <mvc:mapping path="/user/**"/> <bean class="com.duhaoyu.config.LoginInterceptor"/> </mvc:interceptor> </mvc:interceptors> </beans>

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:applicationContext.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>

    <filter>
        <filter-name>encodingFilter</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>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

index.jsp頁面程式碼

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <body>
  <a href="${pageContext.request.contextPath}/user/main">首頁</a>
  <a href="${pageContext.request.contextPath}/user/goLogin">登入頁</a>
  </body>
</html>

controller層程式碼

package com.duhaoyu.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpSession;

/**
 * @author duhaoyu
 * @date 2020/12/1 12:55
 */
@Controller
@RequestMapping("/user")
public class TestController {
    @GetMapping("/t1")
    public String test() {
        System.out.println("TestController的test執行了");
        return "OK";
    }

    @RequestMapping("/login")
    public String login(HttpSession session, String username, String password, Model model) {
        session.setAttribute("username", username);
        model.addAttribute("username", username);
        model.addAttribute("password", password);
        return "main";
    }

    @RequestMapping("/main")
    public String main() {
        return "main";
    }

    @RequestMapping("/goLogin")
    public String geLogin() {
        return "login";
    }

    @RequestMapping("/loginOut")
    public String loginOut(HttpSession session) {
        session.removeAttribute("username");
        return "login";
    }
}

login.jsp頁面程式碼

<%--
  Created by IntelliJ IDEA.
  User: Administrator
  Date: 2020/12/2
  Time: 17:31
  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>
<form action="${pageContext.request.contextPath}/user/login" method="post">
    <input name="username" type="text"  /><br>
    <input type="password" name="password" /><br>
    <input type="submit" value="登入">
</form>
</body>
</html>

main.jsp頁面程式碼

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
${username}<br>
${password}
<h1>首頁</h1>
<a href="${pageContext.request.contextPath}/user/loginOut">登出</a>
</body>
</html>

攔截器LoginInterceptor

如果我們想要使用攔截器必須要實現HandlerInterceptor,重寫preHandle方法,在applicationContext.xml中配置攔截器,見上。如果有請求被applicationContext.xml中的攔截器識別到,就會進入到該方法中,該方法返回true則代表可以通過,如果返回false表示禁止通過,會卡死在該攔截器處。

package com.duhaoyu.config;

import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author duhaoyu
 * @date 2020/12/2 17:29
 */
public class LoginInterceptor implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (request.getSession().getAttribute("username") != null) {
            return true;
    }
        if(request.getRequestURI().contains("login"))
            return true;
        if(request.getRequestURI().contains("goLogin"))
            return true;
        response.sendRedirect("goLogin");
        return false;
    }
}

結果展示

index.jsp頁面
首頁
如果沒有登入,點選首頁會進入到登入頁面

沒有登入,點選首頁會進入該頁面
登入成功後會跳轉到首頁,這裡的使用者名稱和密碼是虛擬的可以隨意輸入。
登入成功
如果我們登入了,下次再進入index.jsp點選首頁的時候就不用登入可以直接進入該頁面,因為session中儲存了我們登入的資訊。在LoginInterceptor中有判斷了session識別身份的程式碼,可以通過,攔截器。

登出功能即在session中移除該使用者的使用者名稱,那麼使用者的登入資訊就不會儲存在session中,進入攔截器的時候就不會通過,跳轉到登入頁面。

點選登出會進入登入頁面
在這裡插入圖片描述
再次進入的時候需重新登入

附:maven的pom.xml配置

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.8.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
        </dependency>
    </dependencies>
    <!--    如果配置檔案沒有被載入增加以下配置-->
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>