Spring?AOP實現(xiàn)用戶登錄統(tǒng)一驗證功能

更新時間：2023年01月14日 10:24:35 作者：Moon?Bay

這篇文章主要為大家詳細介紹了Spring?AOP如何實現(xiàn)用戶登錄統(tǒng)一驗證功能，文中的示例代碼講解詳細，對我們學習具有一定的借鑒價值，需要的可以參考一下

一. 用戶登陸統(tǒng)一驗證功能

1.1 用戶登錄驗證的幾種方法

第一版的用戶登陸驗證: 在每個方法里獲取 session 和 session 中的用戶信息,如果用戶存在,那么就認為登陸成功了,否則就失敗了

第二版的用戶登陸驗證: 提供統(tǒng)一的方法,在每個需要驗證用戶登陸的方法調(diào)用統(tǒng)一驗證用戶登陸的方法來進行判斷

第二版的用戶登陸驗證: 使用Spring AOP 來使用統(tǒng)一的用戶登陸檢驗

遇到的問題:

● 沒有辦法獲取到HttpSession 和 Request 對象

● 實際攔截規(guī)則很復雜,使用簡單的 aspect j 表達式無法滿足攔截的需求

第二版的用戶登陸驗證: Spring 攔截器來實現(xiàn)用戶的統(tǒng)一登陸驗證功能

● 實現(xiàn)自定義攔截器添加@Component注解,實現(xiàn) Spring為我們提供的 HandlerInterceptor 接口中的重寫preHandler 方法

(一個項目中可以配置多個攔截器).

● 將自定義攔截器加入到框架的配置中去, 并且設置攔截規(guī)則如下:

(1) 給要將攔截器加入到的當前類中叫@Configuration注解

(2) 實現(xiàn) WebMvcConfigurer接口

(3) 重寫 addInterceptors方法來實現(xiàn)需要攔截的頁面,和不需要攔截的頁面(白名單)

這里我們看到之前的代碼里過于耦合,并且繁瑣,接下來我們來學習Spring’為我們提供的框架

@RestController
@RequestMapping("/user")
public class UserController {
	/**
	 * 某?法 1
	 */
	@RequestMapping("/m1")
	public Object method(HttpServletRequest request) {
		// 有 session 就獲取，沒有不會創(chuàng)建
		HttpSession session = request.getSession(false);
		if (session != null && session.getAttribute("userinfo") != null) {
			// 說明已經(jīng)登錄，業(yè)務處理
			return true;
		} else {
			// 未登錄
			return false;
		}
	}

	/**
	 * 某?法 2
	 */
	@RequestMapping("/m2")
	public Object method2(HttpServletRequest request) {
		// 有 session 就獲取，沒有不會創(chuàng)建
		HttpSession session = request.getSession(false);
		if (session != null && session.getAttribute("userinfo") != null) {
			// 說明已經(jīng)登錄，業(yè)務處理
			return true;
		} else {
			// 未登錄
			return false;
		}
	}
	// 其他?法...
}

1.2 創(chuàng)建前端頁面

登陸頁面:

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
<h1>登錄頁面</h1>
</body>
</html>

歡迎頁面:

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
<h1> index 頁面</h1>
</body>
</html>

1.3 創(chuàng)建登陸方法和歡迎進入方法

package com.example.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

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

@RequestMapping("/user")
@RestController

public class UserController {

   // 登陸頁面
    @RequestMapping("/login")
    public boolean login(HttpServletRequest request,String username, String password){
        boolean result = false;
        // 判斷是否在登陸頁面輸入賬號 和 密碼
        if (StringUtils.hasLength(username) && StringUtils.hasLength(password)){
            // 驗證輸入的賬號 和 密碼 是否正確
            if (username.equals("admin") && password.equals("admin")){
                // 判斷輸入的賬號和密碼正確后 建立一個 session對象進行存儲
                HttpSession session = request.getSession();
                session.setAttribute("userinfo","userinfo");
                return  true;
            }
        }
        return  result;
    }

    // 歡迎頁面
    @RequestMapping("/index")
    public String index() {
          return "Hello,Index";
    }

1.4 自定義一個攔截器

對于以上問題 Spring 中提供了具體的實現(xiàn)攔截器：HandlerInterceptor，攔截器的實現(xiàn)分為以下兩個步驟：

創(chuàng)建?定義攔截器，實現(xiàn) HandlerInterceptor 接?的 preHandle（執(zhí)?具體?法之前的預處理）?法

將?定義攔截器加?實現(xiàn)接口 WebMvcConfigurer 類的,重寫 addInterceptors ?法中

具體實現(xiàn)如下:

創(chuàng)建?定義攔截器:

package com.example.demo.config;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

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

/**
 *  自定義登陸用戶登陸攔截器
 */
@Component
public class LoginIntercept implements HandlerInterceptor {
    /**
     * 返回 ture 表示攔截判斷通過, 可以訪問后面的接口, 如果返回false 表示攔截未通過,直接返回結果給前端
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
     HttpSession session =  request.getSession(false);
     if (session != null && session.getAttribute("userinfo") != null ){
         // 表示已經(jīng)登陸
         return true;
     }
     // 使用重定向方法 將表示未登錄,就可以使用戶跳轉登陸頁面
        response.sendRedirect("/login.html");
     return  false;
    }
}

將自定義攔截器加入到框架的配置中去

package com.example.demo.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

//配置存儲
@Configuration
public class AppConfig implements WebMvcConfigurer {
    // 通過屬性注入到攔截器
    // 通過注入攔截器來配置規(guī)則
    @Autowired
    private LoginIntercept loginIntercept;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //通過registry.addInterceptor可以得到攔截器

        // 登陸攔截 需要 通過屬性注入來獲取有l(wèi)oginIntercept攔截器對象執(zhí)行攔截方法
           // addPathPatterns 是攔截方法
           // excludePathPatterns 不攔截方法是
        registry.addInterceptor(loginIntercept)
                .addPathPatterns("/**") //攔截所有 的url
                .excludePathPatterns("/user/login") //不攔截登陸
                .excludePathPatterns("/user/reg")   //不攔截注冊頁面
                .excludePathPatterns("/login.html") //不攔截登陸
                .excludePathPatterns("/reg.html")   //不攔截注冊頁面
                .excludePathPatterns("/**/*.js")    //所有的js都不攔截
                .excludePathPatterns("/**/*.css")   //所有的css都不攔截
                .excludePathPatterns("/**/*.png");  //所有的png照片都不攔截

    }
    // 給所有請求地址添加 訪問頁面 帶有api 前綴
//    @Override
//    public void configurePathMatch(PathMatchConfigurer configurer) {
//        configurer.addPathPrefix("api",c -> true);
//    }
}

1.5 驗證攔截功能

1.5.1 當沒有進行登陸,進入歡迎頁面

當我們在沒有進行登陸時,直接輸入歡迎頁面時

我們通過重定向的方法就可以將用戶引導到登陸頁面中

1.5.2 當用戶未成功輸入正確用戶名和密碼

我們會返回一個 false結果來提醒用戶輸入的用戶名和密碼錯誤

1.5.3 當用戶成功輸入正確用戶名和密碼后登陸歡迎頁面

我們先進行用戶登陸成功操作

再次輸入歡迎頁面,我們就可以看到歡迎頁面的內(nèi)容啦!

1.5.4 使用前綴方法進行登陸

上文我們可以使用

    // 給所有請求地址添加 訪問頁面 帶有api 前綴
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("api",c -> true);
    }