Sessions

和 請(qǐng)求 和 響應(yīng)類似， 默認(rèn)可通過為yii/web/Session 實(shí)例的session 應(yīng)用組件 來訪問sessions。

開啟和關(guān)閉 Sessions

可使用以下代碼來開啟和關(guān)閉session。

1. $session = Yii::$app->session; 
2.  
3. // 檢查session是否開啟  
4.  
5. if ($session->isActive) ... 
6.  
7. // 開啟session 
8.  
9. $session->open(); 
10.  
11. // 關(guān)閉session 
12.  
13. $session->close(); 
14.  
15. // 銷毀session中所有已注冊(cè)的數(shù)據(jù) 
16.  
17. $session->destroy(); 

多次調(diào)用yii/web/Session::open() 和yii/web/Session::close() 方法并不會(huì)產(chǎn)生錯(cuò)誤， 因?yàn)榉椒▋?nèi)部會(huì)先檢查session是否已經(jīng)開啟。

訪問Session數(shù)據(jù)

To access the data stored in session, you can do the following: 可使用如下方式訪問session中的數(shù)據(jù)：

1. $session = Yii::$app->session; 
2.  
3. // 獲取session中的變量值，以下用法是相同的： 
4.  
5. $language = $session->get('language'); 
6.  
7. $language = $session['language']; 
8.  
9. $language = isset($_SESSION['language']) ? $_SESSION['language'] : null; 
10.  
11. // 設(shè)置一個(gè)session變量，以下用法是相同的： 
12.  
13. $session->set('language', 'en-US'); 
14.  
15. $session['language'] = 'en-US'; 
16.  
17. $_SESSION['language'] = 'en-US'; 
18.  
19. // 刪除一個(gè)session變量，以下用法是相同的： 
20.  
21. $session->remove('language'); 
22.  
23. unset($session['language']); 
24.  
25. unset($_SESSION['language']); 
26.  
27. // 檢查session變量是否已存在，以下用法是相同的： 
28.  
29. if ($session->has('language')) ... 
30.  
31. if (isset($session['language'])) ... 
32. //Vevb.com 
33. if (isset($_SESSION['language'])) ... 
34.  
35. // 遍歷所有session變量，以下用法是相同的： 
36.  
37. foreach ($session as $name => $value) ... 
38.  
39. foreach ($_SESSION as $name => $value) ... 

補(bǔ)充: 當(dāng)使用session組件訪問session數(shù)據(jù)時(shí)候，如果session沒有開啟會(huì)自動(dòng)開啟， 這和通過$_SESSION不同，$_SESSION要求先執(zhí)行session_start()。

當(dāng)session數(shù)據(jù)為數(shù)組時(shí)，session組件會(huì)限制你直接修改數(shù)據(jù)中的單元項(xiàng)，例如：

1. $session = Yii::$app->session; 
2.  
3. // 如下代碼不會(huì)生效 
4.  
5. $session['captcha']['number'] = 5; 
6.  
7. $session['captcha']['lifetime'] = 3600; 
8.  
9. // 如下代碼會(huì)生效： 
10.  
11. $session['captcha'] = [ 
12.  
13.   'number' => 5, 
14.  
15.   'lifetime' => 3600, 
16.  
17. ]; 
18.  
19. // 如下代碼也會(huì)生效： 
20.  
21. echo $session['captcha']['lifetime']; 

可使用以下任意一個(gè)變通方法來解決這個(gè)問題：

1. $session = Yii::$app->session; 
2.  
3. // 直接使用$_SESSION (確保Yii::$app->session->open() 已經(jīng)調(diào)用) 
4.  
5. $_SESSION['captcha']['number'] = 5; 
6.  
7. $_SESSION['captcha']['lifetime'] = 3600; 
8.  
9. // 先獲取session數(shù)據(jù)到一個(gè)數(shù)組，修改數(shù)組的值，然后保存數(shù)組到session中 
10.  
11. $captcha = $session['captcha']; 
12.  
13. $captcha['number'] = 5; 
14.  
15. $captcha['lifetime'] = 3600; 
16.  
17. $session['captcha'] = $captcha; 
18.  
19. // 使用ArrayObject 數(shù)組對(duì)象代替數(shù)組 
20.  
21. $session['captcha'] = new /ArrayObject; 
22.  
23. ... 
24.  
25. $session['captcha']['number'] = 5; 
26.  
27. $session['captcha']['lifetime'] = 3600; 
28.  
29. // 使用帶通用前綴的鍵來存儲(chǔ)數(shù)組 
30.  
31. $session['captcha.number'] = 5; 
32.  
33. $session['captcha.lifetime'] = 3600; 

為更好的性能和可讀性，推薦最后一種方案，也就是不用存儲(chǔ)session變量為數(shù)組， 而是將每個(gè)數(shù)組項(xiàng)變成有相同鍵前綴的session變量。

自定義Session存儲(chǔ)

yii/web/Session 類默認(rèn)存儲(chǔ)session數(shù)據(jù)為文件到服務(wù)器上，Yii提供以下session類實(shí)現(xiàn)不同的session存儲(chǔ)方式：

yii/web/DbSession: 存儲(chǔ)session數(shù)據(jù)在數(shù)據(jù)表中

yii/web/CacheSession: 存儲(chǔ)session數(shù)據(jù)到緩存中，緩存和配置中的緩存組件相關(guān)

yii/redis/Session: 存儲(chǔ)session數(shù)據(jù)到以redis 作為存儲(chǔ)媒介中

yii/mongodb/Session: 存儲(chǔ)session數(shù)據(jù)到MongoDB.

所有這些session類支持相同的API方法集，因此，切換到不同的session存儲(chǔ)介質(zhì)不需要修改項(xiàng)目使用session的代碼。

注意: 如果通過$_SESSION訪問使用自定義存儲(chǔ)介質(zhì)的session，需要確保session已經(jīng)用yii/web/Session::open() 開啟， 這是因?yàn)樵谠摲椒ㄖ凶?cè)自定義session存儲(chǔ)處理器。

學(xué)習(xí)如何配置和使用這些組件類請(qǐng)參考它們的API文檔，如下為一個(gè)示例 顯示如何在應(yīng)用配置中配置yii/web/DbSession將數(shù)據(jù)表作為session存儲(chǔ)介質(zhì)。

1. return [ 
2.  
3.   'components' => [ 
4.  
5.     'session' => [ 
6.  
7.       'class' => 'yii/web/DbSession', 
8.  
9.       // 'db' => 'mydb', // 數(shù)據(jù)庫連接的應(yīng)用組件ID，默認(rèn)為'db'. 
10.  
11.       // 'sessionTable' => 'my_session', // session 數(shù)據(jù)表名，默認(rèn)為'session'. 
12.  
13.     ], 
14.  
15.   ], 
16.  
17. ]; 

也需要?jiǎng)?chuàng)建如下數(shù)據(jù)庫表來存儲(chǔ)session數(shù)據(jù)：

1. CREATE TABLE session 
2.  
3. ( 
4.  
5.   id CHAR(40) NOT NULL PRIMARY KEY, 
6.  
7.   expire INTEGER, 
8.  
9.   data BLOB 
10.  
11. ) 

其中'BLOB' 對(duì)應(yīng)你選擇的數(shù)據(jù)庫管理系統(tǒng)的BLOB-type類型，以下一些常用數(shù)據(jù)庫管理系統(tǒng)的BLOB類型：

MySQL: LONGBLOB

PostgreSQL: BYTEA

MSSQL: BLOB

注意: 根據(jù)php.ini 設(shè)置的 session.hash_function，你需要調(diào)整id列的長(zhǎng)度， 例如，如果session.hash_function=sha256 ，應(yīng)使用長(zhǎng)度為64而不是40的char類型。

Flash 數(shù)據(jù)

Flash數(shù)據(jù)是一種特別的session數(shù)據(jù)，它一旦在某個(gè)請(qǐng)求中設(shè)置后，只會(huì)在下次請(qǐng)求中有效，然后該數(shù)據(jù)就會(huì)自動(dòng)被刪除。 常用于實(shí)現(xiàn)只需顯示給終端用戶一次的信息，如用戶提交一個(gè)表單后顯示確認(rèn)信息。

可通過session應(yīng)用組件設(shè)置或訪問session，例如：

1. $session = Yii::$app->session; 
2.  
3. // 請(qǐng)求 #1 
4.  
5. // 設(shè)置一個(gè)名為"postDeleted" flash 信息 
6.  
7. $session->setFlash('postDeleted', 'You have successfully deleted your post.'); 
8.  
9. // 請(qǐng)求 #2 
10.  
11. // 顯示名為"postDeleted" flash 信息 
12.  
13. echo $session->getFlash('postDeleted'); 
14.  
15. // 請(qǐng)求 #3 
16.  
17. // $result 為 false，因?yàn)閒lash信息已被自動(dòng)刪除 
18.  
19. $result = $session->hasFlash('postDeleted'); 

和普通session數(shù)據(jù)類似，可將任意數(shù)據(jù)存儲(chǔ)為flash數(shù)據(jù)。

當(dāng)調(diào)用yii/web/Session::setFlash()時(shí), 會(huì)自動(dòng)覆蓋相同名的已存在的任何數(shù)據(jù)， 為將數(shù)據(jù)追加到已存在的相同名flash中，可改為調(diào)用yii/web/Session::addFlash()。 例如:

1. $session = Yii::$app->session; 
2.  
3. // 請(qǐng)求 #1 
4.  
5. // 在名稱為"alerts"的flash信息增加數(shù)據(jù) 
6.  
7. $session->addFlash('alerts', 'You have successfully deleted your post.'); 
8.  
9. $session->addFlash('alerts', 'You have successfully added a new friend.'); 
10.  
11. $session->addFlash('alerts', 'You are promoted.'); 
12.  
13. // 請(qǐng)求 #2 
14.  
15. // $alerts 為名為'alerts'的flash信息，為數(shù)組格式 
16.  
17. $alerts = $session->getFlash('alerts'); 

注意: 不要在相同名稱的flash數(shù)據(jù)中使用yii/web/Session::setFlash() 的同時(shí)也使用yii/web/Session::addFlash()， 因?yàn)楹笠粋€(gè)防范會(huì)自動(dòng)將flash信息轉(zhuǎn)換為數(shù)組以使新的flash數(shù)據(jù)可追加進(jìn)來，因此， 當(dāng)你調(diào)用yii/web/Session::getFlash()時(shí)，會(huì)發(fā)現(xiàn)有時(shí)獲取到一個(gè)數(shù)組，有時(shí)獲取到一個(gè)字符串， 取決于你調(diào)用這兩個(gè)方法的順序。

Cookies

Yii使用 yii/web/Cookie對(duì)象來代表每個(gè)cookie，yii/web/Request 和 yii/web/Response 通過名為'cookies'的屬性維護(hù)一個(gè)cookie集合，前者的cookie 集合代表請(qǐng)求提交的cookies， 后者的cookie集合表示發(fā)送給用戶的cookies。

讀取 Cookies

當(dāng)前請(qǐng)求的cookie信息可通過如下代碼獲取：

1. // 從 "request"組件中獲取cookie集合(yii/web/CookieCollection) 
2.  
3. $cookies = Yii::$app->request->cookies; 
4.  
5. // 獲取名為 "language" cookie 的值，如果不存在，返回默認(rèn)值"en" 
6.  
7. $language = $cookies->getValue('language', 'en'); 
8.  
9. // 另一種方式獲取名為 "language" cookie 的值 
10.  
11. if (($cookie = $cookies->get('language')) !== null) { 
12.  
13.   $language = $cookie->value; 
14.  
15. } 
16.  
17. // 可將 $cookies當(dāng)作數(shù)組使用 
18.  
19. if (isset($cookies['language'])) { 
20.  
21.   $language = $cookies['language']->value; 
22. //Vevb.com 
23. } 
24.  
25. // 判斷是否存在名為"language" 的 cookie 
26.  
27. if ($cookies->has('language')) ... 
28.  
29. if (isset($cookies['language'])) ... 

發(fā)送 Cookies

You can send cookies to end users using the following code: 可使用如下代碼發(fā)送cookie到終端用戶：

1. // 從"response"組件中獲取cookie 集合(yii/web/CookieCollection) 
2.  
3. $cookies = Yii::$app->response->cookies; 
4.  
5. // 在要發(fā)送的響應(yīng)中添加一個(gè)新的cookie 
6.  
7. $cookies->add(new /yii/web/Cookie([ 
8.  
9.   'name' => 'language', 
10.  
11.   'value' => 'zh-CN', 
12.  
13. ])); 
14.  
15. // 刪除一個(gè)cookie 
16.  
17. $cookies->remove('language'); 
18.  
19. // 等同于以下刪除代碼 
20.  
21. unset($cookies['language']); 

除了上述例子定義的 yii/web/Cookie::name 和 yii/web/Cookie::value 屬性 yii/web/Cookie 類也定義了其他屬性來實(shí)現(xiàn)cookie的各種信息，如 yii/web/Cookie::domain, yii/web/Cookie::expire 可配置這些屬性到cookie中并添加到響應(yīng)的cookie集合中。

注意: 為安全起見yii/web/Cookie::httpOnly 被設(shè)置為true，這可減少客戶端腳本訪問受保護(hù)cookie（如果瀏覽器支持）的風(fēng)險(xiǎn)， 更多詳情可閱讀 httpOnly wiki article for more details.

Cookie驗(yàn)證

在上兩節(jié)中，當(dāng)通過request 和 response 組件讀取和發(fā)送cookie時(shí)，你會(huì)喜歡擴(kuò)展的cookie驗(yàn)證的保障安全功能，它能 使cookie不被客戶端修改。該功能通過給每個(gè)cookie簽發(fā)一個(gè)哈希字符串來告知服務(wù)端cookie是否在客戶端被修改， 如果被修改，通過request組件的yii/web/Request::cookiescookie集合訪問不到該cookie。

注意: Cookie驗(yàn)證只保護(hù)cookie值被修改，如果一個(gè)cookie驗(yàn)證失敗，仍然可以通過$_COOKIE來訪問該cookie， 因?yàn)檫@是第三方庫對(duì)未通過cookie驗(yàn)證自定義的操作方式。

Cookie驗(yàn)證默認(rèn)啟用，可以設(shè)置yii/web/Request::enableCookieValidation屬性為false來禁用它，盡管如此，我們強(qiáng)烈建議啟用它。

注意: 直接通過$_COOKIE 和 setcookie() 讀取和發(fā)送的Cookie不會(huì)被驗(yàn)證。

當(dāng)使用cookie驗(yàn)證，必須指定yii/web/Request::cookieValidationKey，它是用來生成s上述的哈希值， 可通過在應(yīng)用配置中配置request 組件。

1. return [ 
2.  
3.   'components' => [ 
4.  
5.     'request' => [ 
6.  
7.       'cookieValidationKey' => 'fill in a secret key here', 
8.  
9.     ], 
10.  
11.   ], 
12.  
13. ]; 

補(bǔ)充: yii/web/Request::cookieValidationKey 對(duì)你的應(yīng)用安全很重要， 應(yīng)只被你信任的人知曉，請(qǐng)不要將它放入版本控制中。