摘要:系統的核心是由的認證組件的看守器和提供器組成。使用的認證系統,幾乎所有東西都已經為你配置好了。其配置文件位于,其中包含了用于調整認證服務行為的注釋清晰的選項配置。
用戶認證系統(基礎介紹)
使用過Laravel的開發者都知道,Laravel自帶了一個認證系統來提供基本的用戶注冊、登錄、認證、找回密碼,如果Auth系統里提供的基礎功能不滿足需求還可以很方便的在這些基礎功能上進行擴展。這篇文章我們先來了解一下Laravel Auth系統的核心組件。
Auth系統的核心是由 Laravel 的認證組件的「看守器」和「提供器」組成。看守器定義了該如何認證每個請求中用戶。例如,Laravel 自帶的 session 看守器會使用 session 存儲和 cookies 來維護狀態。
下表列出了Laravel Auth系統的核心部件
名稱 | 作用 |
---|---|
Auth | AuthManager的Facade |
AuthManager | Auth認證系統面向外部的接口,認證系統通過它向應用提供所有Auth用戶認證相關的方法,而認證方法的具體實現細節由它代理的具體看守器(Guard)來完成。 |
Guard | 看守器,定義了該如何認證每個請求中用戶 |
User Provider | 用戶提供器,定義了如何從持久化的存儲數據中檢索用戶 |
在本文中我們會詳細介紹這些核心部件,然后在文章的最后更新每個部件的作用細節到上面給出的這個表中。
開始使用Auth系統只需在新的 Laravel 應用上運行?php artisan make:auth?和?php artisan migrate?命令就能夠在項目里生成Auth系統需要的路由和視圖以及數據表。
php artisan make:auth執行后會生成Auth認證系統需要的視圖文件,此外還會在路由文件web.php中增加響應的路由:
Auth::routes();
Auth Facade文件中多帶帶定義了routes這個靜態方法
public static function routes() { static::$app->make("router")->auth(); }
所以Auth具體的路由方法都定義在IlluminateRoutingRouter的auth方法中,關于如何找到Facade類代理的實際類可以翻看之前Facade源碼分析的章節。
namespace IlluminateRouting; class Router implements RegistrarContract, BindingRegistrar { /** * Register the typical authentication routes for an application. * * @return void */ public function auth() { // Authentication Routes... $this->get("login", "AuthLoginController@showLoginForm")->name("login"); $this->post("login", "AuthLoginController@login"); $this->post("logout", "AuthLoginController@logout")->name("logout"); // Registration Routes... $this->get("register", "AuthRegisterController@showRegistrationForm")->name("register"); $this->post("register", "AuthRegisterController@register"); // Password Reset Routes... $this->get("password/reset", "AuthForgotPasswordController@showLinkRequestForm")->name("password.request"); $this->post("password/email", "AuthForgotPasswordController@sendResetLinkEmail")->name("password.email"); $this->get("password/reset/{token}", "AuthResetPasswordController@showResetForm")->name("password.reset"); $this->post("password/reset", "AuthResetPasswordController@reset"); } }
在auth方法里可以清晰的看到認證系統里提供的所有功能的路由URI以及對應的控制器和方法。
使用Laravel的認證系統,幾乎所有東西都已經為你配置好了。其配置文件位于 config/auth.php,其中包含了用于調整認證服務行為的注釋清晰的選項配置。
[ "guard" => "web", "passwords" => "users", ], /* |-------------------------------------------------------------------------- | Authentication Guards |-------------------------------------------------------------------------- | | 定義項目使用的認證看守器,默認的看守器使用session驅動和Eloquent User 用戶數據提供者 | | 所有的驅動都有一個用戶提供者,它定義了如何從數據庫或者應用使用的持久化用戶數據的存儲中取出用戶信息 | | Supported: "session", "token" | */ "guards" => [ "web" => [ "driver" => "session", "provider" => "users", ], "api" => [ "driver" => "token", "provider" => "users", ], ], /* |-------------------------------------------------------------------------- | User Providers |-------------------------------------------------------------------------- | | 所有的驅動都有一個用戶提供者,它定義了如何從數據庫或者應用使用的持久化用戶數據的存儲中取出用戶信息 | | Laravel支持通過不同的Guard來認證用戶,這里可以定義Guard的用戶數據提供者的細節: | 使用什么driver以及對應的Model或者table是什么 | | Supported: "database", "eloquent" | */ "providers" => [ "users" => [ "driver" => "eloquent", "model" => AppModelsUser::class, ], // "users" => [ // "driver" => "database", // "table" => "users", // ], ], /* |-------------------------------------------------------------------------- | 重置密碼相關的配置 |-------------------------------------------------------------------------- | */ "passwords" => [ "users" => [ "provider" => "users", "table" => "password_resets", "expire" => 60, ], ], ];
Auth系統的核心是由 Laravel 的認證組件的「看守器」和「提供器」組成。看守器定義了該如何認證每個請求中用戶。例如,Laravel 自帶的 session 看守器會使用 session 存儲和 cookies 來維護狀態。
提供器中定義了該如何從持久化的存儲數據中檢索用戶。Laravel 自帶支持使用 Eloquent 和數據庫查詢構造器來檢索用戶。當然,你可以根據需要自定義其他提供器。
所以上面的配置文件的意思是Laravel認證系統默認使用了web guard配置項, 配置項里使用的是看守器是SessionGuard,使用的用戶提供器是EloquentProvider 提供器使用的model是AppUser。
Guard看守器定義了該如何認證每個請求中用戶。Laravel自帶的認證系統默認使用自帶的 SessionGuard ,SessionGuard除了實現IlluminateContractsAuth契約里的方法還實現IlluminateContractsAuthStatefulGuard 和IlluminateContractsAuthSupportsBasicAuth契約里的方法,這些Guard Contracts里定義的方法都是Laravel Auth系統默認認證方式依賴的基礎方法。
我們先來看一下這一些基礎方法都意欲完成什么操作,等到分析Laravel是如何通過SessionGuard認證用戶時在去關系這些方法的具體實現。
IlluminateContractsAuthGuard這個文件定義了基礎的認證方法
namespace IlluminateContractsAuth; interface Guard { /** * 返回當前用戶是否時已通過認證,是返回true,否者返回false * * @return bool */ public function check(); /** * 驗證是否時訪客用戶(非登錄認證通過的用戶) * * @return bool */ public function guest(); /** * 獲取當前用戶的用戶信息數據,獲取成功返回用戶User模型實例(AppUser實現了Authenticatable接口) * 失敗返回null * @return IlluminateContractsAuthAuthenticatable|null */ public function user(); /** * 獲取當前認證用戶的用戶ID,成功返回ID值,失敗返回null * * @return int|null */ public function id(); /** * 通過credentials(一般是郵箱和密碼)驗證用戶 * * @param array $credentials * @return bool */ public function validate(array $credentials = []); /** * 將一個AppUser實例設置成當前的認證用戶 * * @param IlluminateContractsAuthAuthenticatable $user * @return void */ public function setUser(Authenticatable $user); }IlluminateContractsAuthStatefulGuard
這個Contracts定義了Laravel auth系統里認證用戶時使用的方法,除了認證用戶外還會涉及用戶認證成功后如何持久化用戶的認證狀態。
IlluminateContractsAuthSupportsBasicAuth定義了通過Http Basic Auth 認證用戶的方法
namespace IlluminateContractsAuth; interface SupportsBasicAuth { /** * 嘗試通過HTTP Basic Auth來認證用戶 * * @param string $field * @param array $extraConditions * @return SymfonyComponentHttpFoundationResponse|null */ public function basic($field = "email", $extraConditions = []); /** * 進行無狀態的Http Basic Auth認證 (認證后不會設置session和cookies) * * @param string $field * @param array $extraConditions * @return SymfonyComponentHttpFoundationResponse|null */ public function onceBasic($field = "email", $extraConditions = []); }User Provider用戶提供器中定義了該如何從持久化的存儲數據中檢索用戶,Laravel定義了用戶提供器契約(interface),所有用戶提供器都要實現這個接口里定義的抽象方法,因為實現了統一的接口所以使得無論是Laravel 自帶的還是自定義的用戶提供器都能夠被Guard使用。
用戶提供器契約如下是契約中定義的必需被用戶提供器實現的抽象方法:
通過配置文件config/auth.php可以看到Laravel默認使用的用戶提供器是IlluminateAuthEloquentUserProvider , 下一章節我們分析Laravel Auth系統實現細節的時候我們再來看看EloquentUserProvider是怎么實現用戶提供器契約中的抽象方法的。
總結本節我們主要介紹Laravel Auth系統的基礎,包括Auth系統的核心組件看守器和提供器,AuthManager通過調用配置文件里指定的看守器來完成用戶認證,在認證過程需要的用戶數據是看守器通過用戶提供器獲取到的,下面的表格里總結了Auth系統的核心部件以及每個部件的作用。
名稱 | 作用 |
---|---|
Auth | AuthManager的Facade |
AuthManager | Auth認證系統面向外部的接口,認證系統通過它向應用提供所有Auth用戶認證相關的方法,而認證方法的具體實現細節由它代理的具體看守器(Guard)來完成。 |
Guard | 看守器,定義了該如何認證每個請求中用戶,認證時需要的用戶數據會通過用戶數據提供器來獲取。 |
User Provider | 用戶提供器,定義了如何從持久化的存儲數據中檢索用戶,Guard認證用戶時會通過提供器取用戶的數據,所有的提供器都是IlluminateContractsAuthUserProvider接口的實現,提供了從持久化存儲中取用戶數據的具體實現細節。 |
下一章節我們會看看Laravel自帶的用戶認證功能的實現細節。
本文已經收錄在系列文章Laravel源碼學習里,歡迎訪問閱讀。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/28910.html
摘要:擴展用戶認證系統上一節我們介紹了系統實現的一些細節知道了是如何應用看守器和用戶提供器來進行用戶認證的,但是針對我們自己開發的項目或多或少地我們都會需要在自帶的看守器和用戶提供器基礎之上做一些定制化來適應項目,本節我會列舉一個在做項目時遇到的 擴展用戶認證系統 上一節我們介紹了Laravel Auth系統實現的一些細節知道了Laravel是如何應用看守器和用戶提供器來進行用戶認證的,但是...
摘要:過去一年時間寫了多篇文章來探討了我認為的框架最核心部分的設計思路代碼實現。為了大家閱讀方便,我把這些源碼學習的文章匯總到這里。數據庫算法和數據結構這些都是編程的內功,只有內功深厚了才能解決遇到的復雜問題。 過去一年時間寫了20多篇文章來探討了我認為的Larave框架最核心部分的設計思路、代碼實現。通過更新文章自己在軟件設計、文字表達方面都有所提高,在剛開始決定寫Laravel源碼分析地...
摘要:通過裝載看守器和用戶提供器裝載看守器和用戶提供器用到的方法比較多,用文字描述不太清楚,我們通過注解這個過程中用到的方法來看具體的實現細節。 用戶認證系統的實現細節 上一節我們介紹來Laravel Auth系統的基礎知識,說了他的核心組件都有哪些構成,這一節我們會專注Laravel Auth系統的實現細節,主要關注Auth也就是AuthManager是如何裝載認證用的看守器(Guard)...
摘要:的契約是一組定義框架提供的核心服務的接口,例如我們在介紹用戶認證的章節中到的用戶看守器契約和用戶提供器契約以及框架自帶的模型所實現的契約。接口與團隊開發當你的團隊在開發大型應用時,不同的部分有著不同的開發速度。 Contracts Laravel 的契約是一組定義框架提供的核心服務的接口, 例如我們在介紹用戶認證的章節中到的用戶看守器契約IllumninateContractsAuth...
摘要:如何做用戶認證根據文檔描述,提供用戶認證的接口,他的核心是看守器和提供器,看守器定義怎么認證用戶,提供器定義怎么檢索用戶。 最近的一個PHP項目,上一個項目是采用ThinkPHP來弄的,因為很早就聽說過Laravel的大名,所以進了Laravel的官網,意外發現了Lumen,正好我項目是提供API的,所以選擇了Lumen,因為是Laravel的精簡版,看了幾天的Laravel文檔,也總...
閱讀 3259·2021-11-15 11:37
閱讀 1065·2021-11-02 14:45
閱讀 3893·2021-09-04 16:48
閱讀 3569·2019-08-30 15:55
閱讀 748·2019-08-23 17:53
閱讀 994·2019-08-23 17:03
閱讀 2020·2019-08-23 16:43
閱讀 2183·2019-08-23 16:22