SessionScope全面解析

在Java web開發過程中，session是一個不可或缺的重要概念，用於在伺服器和客戶端之間保存用戶狀態。Spring框架提供了另一個有用的特性，即SessionScope。本文將深入介紹SessionScope，包括如何使用以及使用注意事項等。

一、從SessionScope判斷

SessionScope是Spring Framework提供的一種作用域類型，它與HTTP Session相關，是一個在HTTP Session生命周期內存活的Bean作用域。

在一個HTTP Session中，我們可以存儲和獲取用戶狀態。但是，如果我們需要保留一些狀態，並且在多個頁面間分享，則需要使用SessionScope來管理Bean實例。

二、如何使用SessionScope

1、配置Bean作用域為SessionScope


import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;

@Component
@Scope(value="session", proxyMode=ScopedProxyMode.TARGET_CLASS)
public class User {
    private String username;
    private String password;
    
    // constructors and getters/setters
}

2、獲取SessionScope中的Bean實例

在SessionScope中，我們並不會像Singleton和Prototype那樣通過自動注入或構造函數注入到Bean中。相反的，我們需要通過Spring的SessionScope Bean Factory來手動創建SessionScope Bean實例。

我們可以使用注釋「@Autowired」將SessionScope Bean Factory注入到另一個Bean對象中，並使用它來手動創建SessionScope Bean實例。這裡需要注意，不能將SessionScope Bean Factory注入到Singleton Bean中。

3、使用注釋「@SessionAttributes」

除了手動創建和管理SessionScope Bean實例之外，我們還可以使用注釋「@SessionAttributes」自動將Bean的屬性添加到HTTP Session中，並在請求處理期間將其保留在HTTP Session中。

以下是一個用於演示的UserController類。


@RestController
@RequestMapping("/user")
@SessionAttributes("user")
public class UserController {
 
    @GetMapping("/{userId}")
    public User loadUser(@PathVariable String userId, Model model) {
        User user = userRepository.findOne(userId);
        model.addAttribute("user", user);
        return user;
    }
 
    @PutMapping("/{userId}")
    public User updateUser(@PathVariable String userId, @ModelAttribute("user") User user) {
        userRepository.save(user);
        return user;
    }

    // ...
}

在上述示例中，我們的User類被注釋為@SessionAttributes(“user”)。在GET方法中，我們使用「Model」將User Bean添加到模型中，並將其添加到HTTP Session中。在PUT方法中，我們使用@ModelAttribute將User Bean注入到方法中，並使用userRepository將其保存到資料庫中。

三、SessionScope和Session Attribute的區別

「Session Attribute」指的是將對象添加到HTTP Session中。Spring提供了@SessionAttributes注釋，使我們可以在請求處理期間保留這些對象。

而SessionScope是一個非常範圍特定的作用域類型。它管理在HTTP Session生命周期內存活的Bean實例。我們還可以手動在SessionScope Bean內部保存Session Attribute，但它們並不需要將這些屬性添加到@SessionAttributes注釋中聲明的列表中。

四、訪問SessionScope Bean實例中的屬性

我們已經知道如何手動將Bean添加到HTTP Session中或使用@SessionAttributes註解。那麼，如何在其他組件中訪問SessionScope Bean實例中的屬性呢？

下面是一個演示如何訪問SessionScope Bean實例中的屬性的例子。


@Controller
@RequestMapping("/user")
@SessionAttributes("user")
public class UserController {
 
    @GetMapping("/{userId}")
    public String loadUser(@PathVariable String userId, Model model) {
        User user = userRepository.findOne(userId);
        model.addAttribute("user", user);
        return "redirect:/user/home";
    }
 
    @GetMapping("/home")
    public String home(Model model) {
        User user = (User) model.asMap().get("user");
        System.out.println(user.getUsername() + " " + user.getPassword());
        return "home";
    }
 
    // ...
}

在上面的示例中，我們在「GET /{userId}」方法中手動將User添加到模型中，並將其添加到HTTP Session中。但是，在Model中添加User對象並不足以讓我們在不同的請求處理方法之間共享它。為了讓它在「GET /home」方法中可用，我們需要使用「@SessionAttributes」注釋將其聲明為Session屬性。

在「GET /home」方法中，我們從模型中獲取User對象並訪問它的屬性。

五、SessionScope和「@Autowired」

在SessionScope中，@Autowired將不會自動注入Session域中的Bean。


@Service
public class UserService {
 
    @Autowired
    private User user;
 
    public void printUsername() {
        System.out.println(user.getUsername());
    }
}

當我們運行上面的代碼時會拋出一個異常「java.lang.NullPointerException: Cannot invoke ‘xxx’ because ‘user’ is null」。

當我們創建Session域Bean實例時，它並不會自動注入到其他組件中——即使它們具有與之匹配的類型和名稱。相反，我們需要通過SessionScope Bean Factory手動獲取SessionScope Bean實例，如下所示：


@Service
public class UserService {
 
    private User user;
 
    public void setUser(User user) {
        this.user = user;
    }
 
    public void printUsername() {
        System.out.println(user.getUsername());
    }
}
 
@RestController
@RequestMapping("/user")
@SessionAttributes("user")
public class UserController {
 
    private final UserService userService;// 先通過顯式裝配導入UserService，以便在當前會話中引用它。

    @Autowired // 裝配 SessionScope Bean Factory
    public UserController(SessionScope sessionScope) {
        this.userService = sessionScope.getProxy(UserService.class);
    }
 
    @GetMapping("/{userId}")
    public String loadUser(@PathVariable String userId, Model model) {
        User user = userRepository.findOne(userId);
        model.addAttribute("user", user);
        userService.setUser(user);
        return "redirect:/user/home";
    }
 
    // ...
}

在上面的示例中，我們將SessionScope Bean Factory注入到UserController中。我們通過SessionScope Bean Factory手動獲取UserService Bean，並在loadUser()方法中設置User對象。

六、SessionScope和Prototype

在SessionScope中，Prototype Bean實例與Session實例之間的關係與Singleton Bean實例不同。雖然SessionScope Bean實例只是特定HTTP Session的一個實例，但Prototype Bean實例不是實例化器的一部分，而是每次請求Spring Container時創建。

當我們將Prototype Bean注入到SessionScope Bean中時，單個Prototype Bean實例將在一次HTTP Session中被重複使用。


@Component
@Scope(value="prototype")
public class PrototypeBean {
    private String name;

    // constructors and getters/setters
}
 
@Component
@Scope(value="session", proxyMode=ScopedProxyMode.TARGET_CLASS)
public class SessionBean {
 
    @Autowired
    private PrototypeBean prototypeBean;
 
    public void printPrototypeName() {
        System.out.println(prototypeBean.getName());
    }
}

在上面的示例中，我們將PrototypeBean注入到SessionBean中。prototypeBean在SessionBean中循環注入。在一次HTTP Session中，SessionBean只會創建一個實例，但是PrototypeBean實例根據每個HTTP請求來創建。

這種情況下，我們建議使用「@Scope(value=”request”)」代替「@Scope(value=”prototype”)」，因為Session Bean的代理是在Session Bean源對象創建時創建的，因此不會受到非線程安全的影響。

七、使用Session and Session scope

雖然SessionScope與HTTP Session相關聯，但是我們並不應該直接使用HTTP Session。相反，我們應該盡量避免在應用程序的各個層中使用HTTP Session，並使用更抽象的概念（例如Spring Security）來處理會話管理。

如果我們確實需要使用HTTP Session，請遵循以下準則：

在適當的時候清除HTTP Session以釋放資源和減少安全性風險。
避免HTTP Session中保存太多狀態，以免泄露敏感信息。
避免在HTTP Session中保存太長時間的數據，因為它們可能會變得過時或無用。

八、使用注意事項

下面是一些使用SessionScope過程中注意事項：

不能將SessionScope Bean注入到Singleton Bean中。
SessionScope Bean代理可能導致性能問題。
SessionScope Bean實例化不是線程安全的，必須小心處理。
不能使用「@Autowired」將SessionScope Bean直接注入到其他Bean中。
Prototype Bean實例化與Session Scope Bean不同。

九、總結

在Java web開發中，SessionScope是一個重要的作用域類型。它允許我們在HTTP Session生命周期內管理Bean實例，並在多個請求處理方法之間共享它們。

本文中，我們介紹了如何配置SessionScope Bean，如何使用@SessionAttributes自動添加Bean到HTTP Session中，以及如何手動在HTTP Session中保存屬性。此外，本文還討論了SessionScope Bean和Prototype Bean的關係，以及使用SessionScope時應遵循的最佳實踐。

最後，我們提醒您在使用SessionScope時需要小心處理，遵循HTTP Session最佳實踐。

原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-tw/n/201357.html