SpringBoot中Session的使用及說(shuō)明

更新時(shí)間：2024年06月01日 09:43:28 作者：程序員徐師兄

這篇文章主要介紹了SpringBoot中Session的使用及說(shuō)明,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

SpringBoot中的Session是什么，如何使用

在 Web 應(yīng)用程序中，Session 是一個(gè)非常常見(jiàn)的概念。

它用于在客戶端和服務(wù)器之間維護(hù)狀態(tài)信息，例如登錄狀態(tài)、購(gòu)物車內(nèi)容等。在 Spring Boot 中，Session 也是一個(gè)重要的概念。

本文將介紹 Spring Boot 中的 Session 是什么以及如何使用它。

什么是Session

Session 是一種在客戶端和服務(wù)器之間維護(hù)狀態(tài)信息的機(jī)制。

它的工作原理是：當(dāng)客戶端發(fā)送請(qǐng)求到服務(wù)器時(shí)，服務(wù)器會(huì)為該請(qǐng)求創(chuàng)建一個(gè) Session，并為該 Session 分配一個(gè)唯一的標(biāo)識(shí)符。

這個(gè)標(biāo)識(shí)符會(huì)被發(fā)送到客戶端，并保存在客戶端的 Cookie 中。

當(dāng)客戶端發(fā)送下一次請(qǐng)求時(shí)，客戶端會(huì)將該標(biāo)識(shí)符再次發(fā)送給服務(wù)器，服務(wù)器通過(guò)該標(biāo)識(shí)符來(lái)獲取對(duì)應(yīng)的 Session，從而獲取之前保存的狀態(tài)信息。

在 Spring Boot 中，Session 是通過(guò) HttpSession 接口來(lái)實(shí)現(xiàn)的。

我們可以通過(guò) HttpSession 接口來(lái)獲取和設(shè)置 Session 中的屬性，例如：

@Controller
public class MyController {
    @GetMapping("/login")
    public String login(HttpSession session) {
        session.setAttribute("username", "張三");
        return "login";
    }

    @GetMapping("/home")
    public String home(HttpSession session) {
        String username = (String) session.getAttribute("username");
        System.out.println("當(dāng)前登錄用戶：" + username);
        return "home";
    }
}

在上面的代碼中，我們定義了兩個(gè)請(qǐng)求處理方法，分別是 /login 和 /home。

在 /login 方法中，我們通過(guò) HttpSession 接口來(lái)設(shè)置一個(gè)名為 username 的屬性。

在 /home 方法中，我們通過(guò) HttpSession 接口來(lái)獲取 username 屬性，并打印出當(dāng)前登錄用戶的用戶名。

使用Session

在 Spring Boot 中使用 Session 非常簡(jiǎn)單。只需要按照以下步驟進(jìn)行配置即可。

1. 添加依賴

首先需要在 pom.xml 文件中添加以下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

這個(gè)依賴包含了 Spring Boot Web 應(yīng)用程序的核心功能和一些常用的依賴。

2. 配置 Session

在 Spring Boot 中，我們可以通過(guò) application.properties 文件來(lái)配置 Session 的一些屬性。

例如，我們可以通過(guò)以下配置來(lái)設(shè)置 Session 的超時(shí)時(shí)間為 30 分鐘：

server.servlet.session.timeout=30m

在以上配置中，我們使用了 server.servlet.session.timeout 屬性來(lái)設(shè)置 Session 的超時(shí)時(shí)間。這個(gè)屬性的值可以是一個(gè)時(shí)間段，例如 30m 表示 30 分鐘。

3. 使用 Session

在使用 Session 時(shí)，我們可以通過(guò) HttpSession 接口來(lái)獲取和設(shè)置 Session 中的屬性。例如，在上面的代碼中，我們使用了 session.setAttribute 方法來(lái)設(shè)置一個(gè)名為 username 的屬性，并使用了 session.getAttribute 方法來(lái)獲取 username 屬性。

在 Spring Boot 中，我們也可以通過(guò)注解來(lái)獲取和設(shè)置 Session 中的屬性。

例如，我們可以使用 @SessionAttributes 注解來(lái)標(biāo)記一個(gè)控制器類，以表示該控制器類需要使用 Session 中的哪些屬性。

例如：

@Controller
@SessionAttributes("username")
public class MyController {
    @GetMapping("/login")
    public String login(Model model) {
        model.addAttribute("username", "張三");
        return "login";
    }

    @GetMapping("/home")
    public String home(@ModelAttribute("username") String username) {
        System.out.println("當(dāng)前登錄用戶：" + username);
        return "home";
    }
}

在上面的代碼中，我們使用了 @SessionAttributes 注解來(lái)標(biāo)記了一個(gè)控制器類，并指定了需要使用的 Session 屬性名為 username。

在 /login 方法中，我們使用了 Model.addAttribute 方法來(lái)設(shè)置 username 屬性。

在 /home 方法中，我們使用了 @ModelAttribute 注解來(lái)獲取 username 屬性。

示例代碼

下面是一個(gè)完整的示例代碼，演示了如何在 Spring Boot 中使用 Session。

Application.java

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

MyController.java

@Controller
@SessionAttributes("username")
public class MyController {
    @GetMapping("/login")
    public String login(Model model) {
        model.addAttribute("username", "張三");
        return "login";
    }

    @GetMapping("/home")
    public String home(@ModelAttribute("username") String username) {
        System.out.println("當(dāng)前登錄用戶：" + username);
        return "home";
    }
}

login.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Login</title>
</head>
<body>
    <h1>Login</h1>
    <p>當(dāng)前登錄用戶：${username}</p>
    <a href="/home" rel="external nofollow" >進(jìn)入主頁(yè)</a>
</body>
</html>

home.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Home</title>
</head>
<body>
    <h1>Home</h1>
    <p>當(dāng)前登錄用戶：${username}</p>
</body>
</html>

在以上示例代碼中，我們定義了一個(gè)名為 MyController 的控制器類，其中包含了兩個(gè)請(qǐng)求處理方法 /login 和 /home。

在 /login 方法中，我們使用了 Model.addAttribute 方法來(lái)設(shè)置一個(gè)名為 username 的 Session 屬性，并返回 login 視圖。
在 login 視圖中，我們使用了 ${username} 表達(dá)式來(lái)獲取 username 屬性，并將其顯示在頁(yè)面上。
在 /home 方法中，我們使用了 @ModelAttribute 注解來(lái)獲取 username 屬性，并將其打印到控制臺(tái)中。
在 home 視圖中，我們也使用了 ${username} 表達(dá)式來(lái)獲取 username 屬性，并將其顯示在頁(yè)面上。