您好,登錄后才能下訂單哦!
這篇文章主要介紹“Laravel中如何設(shè)置PHPStan最高驗(yàn)證級別”,在日常操作中,相信很多人在Laravel中如何設(shè)置PHPStan最高驗(yàn)證級別問題上存在疑惑,小編查閱了各式資料,整理出簡單好用的操作方法,希望對大家解答”Laravel中如何設(shè)置PHPStan最高驗(yàn)證級別”的疑惑有所幫助!接下來,請跟著小編一起來學(xué)習(xí)吧!
先創(chuàng)建一個(gè)名為 larastan-test 的新 Laravel 項(xiàng)目:
laravel new larastan-test
新建項(xiàng)目后,安裝 Larastan,通過運(yùn)行以下 composer 命令:
composer require nunomaduro/larastan --dev
我們希望它作為開發(fā)依賴項(xiàng)的原因是因?yàn)樵谏a(chǎn)中我們不應(yīng)該運(yùn)行任何靜態(tài)分析 - 它僅用于開發(fā)目的,以確保您的代碼盡可能安全。 PHPStan 使用一種稱為 neon 的配置格式,在某種程度上類似于 yaml。 因此,我們將在 out 應(yīng)用程序的根目錄中創(chuàng)建一個(gè)名為 ./phpstan.neon 的新文件 - 如果您正在構(gòu)建一個(gè)包,推薦的方法是將 .dist 添加到這些配置文件的末尾。 在這個(gè)文件中,我們將開始定義 phpstan 運(yùn)行所需的配置以及我們可能想要強(qiáng)加的規(guī)則,將以下代碼添加到配置文件中,我們可以了解它的含義:
includes:
- ./vendor/nunomaduro/larastan/extension.neon
parameters:
paths:
- app
level: 9
ignoreErrors:
excludePaths:
我們從 includes
開始,這些通常是我們希望包含在我們的基本 phpstan 規(guī)則集中的包中的規(guī)則。這個(gè)配置的參數(shù)部分,第一個(gè)選項(xiàng) paths
允許我們定義我們希望 PHPStan 檢查的位置——在案例中,我們只需要聚焦到應(yīng)用程序代碼所在的 app
目錄。如果你愿意,你可以將其擴(kuò)展到覆蓋多個(gè)目錄,但要小心你所引入的范圍,因?yàn)樗械氖虑榧磳⒆兊脟?yán)格(嚴(yán)謹(jǐn))!接下來,PHPStan 的 level
參數(shù)決定了可以檢查的各種級別,0 是最低的,9 目前是最高的。
如你所見,我們已將級別設(shè)置為 9,我建議在現(xiàn)有應(yīng)用程序上這樣做,因?yàn)橹挥欣硐肭闆r下你才達(dá)到這個(gè)級別 - 但由于這是一個(gè)全新的項(xiàng)目,我們可以在 9 時(shí)感到非常舒服(畢竟技術(shù)債務(wù)沒有那么多)。
接下來,ignoreErrors
和 excludePaths
這兩個(gè)選項(xiàng)允許我們告訴 PHPStan 忽略我們不感興趣的文件或特定的錯(cuò)誤,比如現(xiàn)階段我們無法控制或修復(fù)的錯(cuò)誤。也許你正在重構(gòu)一些業(yè)務(wù)并且遇到了錯(cuò)誤。你可能正在重構(gòu)這段代碼,以便稍后進(jìn)行靜態(tài)分析,那你可以通過這個(gè)配置,讓 PHPStan 在你結(jié)束重構(gòu)前,忽略相關(guān)的錯(cuò)誤。
includes
包含基本的 phpstan 的規(guī)則。parameters
配置參數(shù),第一個(gè)選項(xiàng) paths
配置 phpstan 檢查的目錄——在我的例子中,我只對應(yīng)用程序代碼所在的 app
目錄進(jìn)行檢查,當(dāng)然您也可以配置其他目錄。 level
配置級別,PHPStan 可以配置各種級別,0 是最低的,9 目前是最高的。如您所見,我已將級別設(shè)置為 9,我建議將級別設(shè)置為 9。接下來有 ignoreErrors
和 excludePaths
這兩個(gè)選項(xiàng)告訴 PHPStan 忽略不檢測的文件或特定錯(cuò)誤,或者現(xiàn)在不需要檢測的文件和錯(cuò)誤。例如正在重構(gòu)的代碼,您希望在完成之前忽略錯(cuò)誤,完成后再進(jìn)行靜態(tài)分析。
因此,讓我們針對默認(rèn)的 Laravel 應(yīng)用程序運(yùn)行 phpstan,看看我們遇到了什么錯(cuò)誤,如果有的話。在終端中運(yùn)行以下命令:
./vendor/bin/phpstan analyse
我們從默認(rèn) Laravel 應(yīng)用程序獲得的輸出如下所示:
Note: Using configuration file /Users/steve/code/sites/larastan-test/phpstan.neon.
18/18 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
------ ----------------------------------------------------------------------------------------------------------------------------
Line Providers/RouteServiceProvider.php
------ ----------------------------------------------------------------------------------------------------------------------------
49 Parameter #1 $key of method Illuminate\Cache\RateLimiting\Limit::by() expects string, int<min, -1>|int<1, max>|string|null
given.
------ ----------------------------------------------------------------------------------------------------------------------------
[ERROR] Found 1 error
正如你所看到的,我們在默認(rèn)的 Laravel 應(yīng)用程序中只得到一個(gè)錯(cuò)誤,即使我們將檢查的級別設(shè)置到了最嚴(yán)格的等級。
這很好,對吧?當(dāng)然,如果你將其添加到現(xiàn)有項(xiàng)目中,你可能會(huì)看到不同的結(jié)果,按照本教程,你將學(xué)習(xí)如何解決這些問題,以便你有一個(gè)很好的工作流程可以遵循。
在 Laravel 應(yīng)用程序運(yùn)行 phpstan,如果發(fā)生錯(cuò)誤。 在終端中運(yùn)行以下命令:
./vendor/bin/phpstan analyse
輸出如下所示
Note: Using configuration file /Users/steve/code/sites/larastan-test/phpstan.neon.
18/18 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
------ ----------------------------------------------------------------------------------------------------------------------------
Line Providers/RouteServiceProvider.php
------ ----------------------------------------------------------------------------------------------------------------------------
49 Parameter #1 $key of method Illuminate\Cache\RateLimiting\Limit::by() expects string, int<min, -1>|int<1, max>|string|null
given.
------ ----------------------------------------------------------------------------------------------------------------------------
[ERROR] Found 1 error
現(xiàn)在,我們在最嚴(yán)格的級別下,在默認(rèn)的 Laravel 應(yīng)用程序中也只得到一個(gè)錯(cuò)誤。 當(dāng)然,如果您將其添加到現(xiàn)有項(xiàng)目中,您可能會(huì)看到不同的結(jié)果,但是按照本教程,您將學(xué)習(xí)如何解決這些問題。
如果您希望有一種簡便的運(yùn)行方式,可以將腳本添加到您的composer文件中來運(yùn)行此命令,那么現(xiàn)在讓我們添加它,以便我們可以更輕松地運(yùn)行此命令,將以下代碼塊添加到你的 composer.json
文件中:
"scripts": {
"phpstan": [
"./vendor/bin/phpstan analyse"
]
},
"scripts-descriptions": {
"phpstan": "Run PHPStan static analysis against your application."
},
你的 composer 文件中有了 scripts
記錄 - 只需將 phpstan
腳本附加到塊的末尾即可。 現(xiàn)在我們可以再次運(yùn)行 PHPStan ,但這次使用 composer , 更容易輸入:
composer phpstan
所以當(dāng)我們有 1 個(gè)錯(cuò)誤時(shí),查看對應(yīng)的行,并且查看它當(dāng)前的樣子:
protected function configureRateLimiting()
{
RateLimiter::for('api', function (Request $request) {
return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
});
}
本節(jié)開始,我們會(huì)聊聊靜態(tài)分析讓人抱怨的一些具體問題:
$request->user()?->id ?: $request->ip()
當(dāng)我們想要獲取請求用戶,如果有的話返回ID,或者如果第一部分為空,則返回 IP 地址。在這個(gè)例子中,沒有真正的方法來確保這永遠(yuǎn)是一個(gè)字符串,用戶可能是空的,請求 IP 也可能是空的。
這是你想要消除錯(cuò)誤的情況,但因?yàn)樗莵碜怨?yīng)商(第三方包)的代碼,你無法強(qiáng)制執(zhí)行此操作。在這種特定情況下,你可以做的最好的事情是告訴 PHPStan 忽略該錯(cuò)誤,但這不是全局性的。我們在這里要做的是添加一個(gè)命令塊而不是設(shè)置規(guī)則,以告訴 PHPStan 在分析此代碼時(shí)忽略此特定行。將此方法重構(gòu)為如下所示:
protected function configureRateLimiting(): void
{
RateLimiter::for('api', static function (Request $request): Limit {
/** @phpstan-ignore-next-line */
return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
});
}
我們?yōu)榉椒ㄌ砑恿朔祷仡愋?,使回調(diào)成為靜態(tài)閉包 - 并提示返回類型。但隨后我們在返回值上方添加命令塊,告訴 PHPStan 我們要忽略下一行。如果我們現(xiàn)在再次在命令行中運(yùn)行 PHPStan,你將看到以下輸出:
Note: Using configuration file /Users/steve/code/sites/larastan-test/phpstan.neon.
18/18 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
[OK] No errors
所以我們有默認(rèn)的 Laravel 應(yīng)用程序在 PHPStan 上運(yùn)行,現(xiàn)在我們需要開始向我們的應(yīng)用程序添加一些實(shí)際的邏輯,以便我們在添加功能和邏輯時(shí)可以確保類型安全。為此,我們將創(chuàng)建一個(gè)簡單的應(yīng)用程序來存儲書簽,這沒什么特別的。
讓我們開始使用 artisan 添加模型,并使用 -mf 參數(shù)同時(shí)創(chuàng)建遷移任務(wù)和工廠模式:
php artisan make:model Bookmark -mf
其中,遷移任務(wù)的 up
方法如下所示:
Schema::create('bookmarks', static function (Blueprint $table): void {
$table->id();
$table->string('name');
$table->string('url');
$table->boolean('starred')->default(false);
$table->foreignId('user_id')->index()->constrained()->cascadeOnDelete();
$table->timestamps();
});
將以下代碼添加到我們的模型中:
class Bookmark extends Model
{
use HasFactory;
protected $fillable = [
'name',
'url',
'starred',
'user_id',
];
protected $casts = [
'starred' => 'boolean',
];
/**
* @return BelongsTo
*/
public function user(): BelongsTo
{
return $this->belongsTo(
related: User::class,
foreignKey: 'user_id',
);
}
}
從上面可以看出,我們在這里唯一關(guān)心的是名稱、url,如果用戶想要加星標(biāo)/收藏書簽并且該書簽屬于用戶?,F(xiàn)在我們可以把它留在這里,但我個(gè)人喜歡將類型定義添加到我的模型屬性中——因?yàn)槟壳霸?Laravel 9 中我無法輸入提示它們。因此,重構(gòu)你的模型,使其如下所示:
class Bookmark extends Model
{
use HasFactory;
/**
* @var array<int,string>
*/
protected $fillable = [
'name',
'url',
'starred',
'user_id',
];
/**
* @var array<string,string>
*/
protected $casts = [
'starred' => 'boolean',
];
/**
* @return BelongsTo
*/
public function user(): BelongsTo
{
return $this->belongsTo(
related: User::class,
foreignKey: 'user_id',
);
}
}
我們在這里所做的只是告訴 PHP 和我們的 IDE,可填充數(shù)組是一個(gè)沒有鍵的字符串?dāng)?shù)組——這意味著它將默認(rèn)為整數(shù)。然后我們的 casts 數(shù)組是一個(gè)帶鍵的字符串?dāng)?shù)組,其中的鍵也是字符串?,F(xiàn)在,即使在沒有類型定義的情況下運(yùn)行靜態(tài)分析,它也不會(huì)失敗 - 但這是一個(gè)很好的實(shí)踐,以便你的 IDE 在你工作時(shí)擁有盡可能多的信息。
讓我們繼續(xù)處理路由和控制器,以便我們可以繼續(xù)運(yùn)行靜態(tài)分析檢查?,F(xiàn)在我是可調(diào)用控制器的忠實(shí)粉絲——我發(fā)現(xiàn)它們非常適合我的代碼風(fēng)格,但是你可能不喜歡它們或有不同的偏好,所以如果你是的話,下一部分可以隨意偏離我的編碼風(fēng)格,會(huì)讓你更舒服。
我們現(xiàn)在將創(chuàng)建一個(gè)控制器,運(yùn)行以下 artisan 命令來為書簽創(chuàng)建索引控制器:
登錄后復(fù)制php artisan make:controller Bookmarks/IndexController --invokable
這是我們路由所需的索引控制器,所以我們可以去添加一個(gè)新的路由組在 routes/web.php
:
Route::middleware(['auth'])->prefix('bookmarks')->as('bookmarks:')->group(static function (): void {
Route::get('/', App\Http\Controllers\Bookmarks\IndexController::class)->name('index');
});
添加在在我們的 auth 中間件中,以便我們控制作者對書簽的訪問,我們還希望在 bookmarks
下為所有路由添加前綴,并將該組的命名策略設(shè)置為 bookmarks:*
。 如果我們現(xiàn)在在我們的代碼庫上運(yùn)行我們的靜態(tài)分析,我們會(huì)看到一些錯(cuò)誤,但這主要是因?yàn)槲覀兊目刂破髦袥]有內(nèi)容:
composer phpstan
Note: Using configuration file /Users/steve/code/sites/larastan-test/phpstan.neon.
20/20 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
------ -------------------------------------------------------------------------------------------------
Line Http/Controllers/Bookmarks/IndexController.php
------ -------------------------------------------------------------------------------------------------
15 Method App\Http\Controllers\Bookmarks\IndexController::__invoke() has no return type specified.
------ -------------------------------------------------------------------------------------------------
------ -----------------------------------------------------------------------------------------------------------------------------
Line Models/Bookmark.php
------ -----------------------------------------------------------------------------------------------------------------------------
33 Method App\Models\Bookmark::user() return type with generic class Illuminate\Database\Eloquent\Relations\BelongsTo does not
specify its types: TRelatedModel, TChildModel
? You can turn this off by setting checkGenericClassInNonGenericObjectType: false in your
phpstan.neon.
------ -----------------------------------------------------------------------------------------------------------------------------
------ ----------------------------------------------------------------------------------------------------------------------------
Line Models/User.php
------ ----------------------------------------------------------------------------------------------------------------------------
49 Method App\Models\User::bookmarks() return type with generic class Illuminate\Database\Eloquent\Relations\HasMany does not
specify its types: TRelatedModel
? You can turn this off by setting checkGenericClassInNonGenericObjectType: false in your
phpstan.neon.
------ ----------------------------------------------------------------------------------------------------------------------------
[ERROR] Found 3 errors
擺在我面前的第一個(gè)錯(cuò)誤是 Method App\Models\User::bookmarks() return type with generic class
?,F(xiàn)在我不想在這個(gè)應(yīng)用中過度依賴通用類型。這一錯(cuò)誤實(shí)際上告訴我們可以做什么,所以讓我們將checkGenericClassInNonGenericObjectType: false
添加到我們的 phpstan.neon
文件中:
includes:
- ./vendor/nunomaduro/larastan/extension.neon
parameters:
paths:
- app
level: 9
ignoreErrors:
excludePaths:
checkGenericClassInNonGenericObjectType: false
現(xiàn)在,如果我們再次運(yùn)行分析,將只有 5 個(gè)錯(cuò)誤,這些錯(cuò)誤都和控制器相關(guān) - 讓我們從 IndexController
開始,看看我們能做些什么。像這樣重構(gòu) IndexController
:
class IndexController extends Controller
{
public function __invoke(Request $request)
{
return View::make(
view: 'bookmarks.list',
data: [
'bookmarks' => Bookmark::query()
->where('user_id', $request->user()->id)
->paginate(),
]
);
}
}
如果我們現(xiàn)在對我們的代碼進(jìn)行靜態(tài)分析,并且只關(guān)注正在使用的控制器,我們將看到如下問題:
------ -------------------------------------------------------------------------------------------------
Line Http/Controllers/Bookmarks/IndexController.php
------ -------------------------------------------------------------------------------------------------
15 Method App\Http\Controllers\Bookmarks\IndexController::__invoke() has no return type specified.
21 Cannot access property $id on App\Models\User|null.
------ -------------------------------------------------------------------------------------------------
那么我們對這兩個(gè)錯(cuò)誤能做些什么呢?第一個(gè)相對容易修復(fù),我們可以添加返回類型:
public function __invoke(Request $request): \Illuminate\Contracts\View\View
我們可以對此約束起個(gè)別名,使之看起來更為美觀:
public function __invoke(Request $request): ViewContract
然而下一個(gè)問題,Cannot access property $id on App\Models\User|null.
,類似于我們在默認(rèn) Laravel 應(yīng)用中,在請求的用戶可以為空的情況下去獲取ID時(shí)會(huì)碰到的問題。因此我用以解決此問題的方法是,使用 Auth 的輔助函數(shù)直接從 Auth 守衛(wèi)中獲取 ID。重構(gòu)查詢?nèi)缦拢?/p>
Bookmark::query()
->where('user_id', auth()->id())
->paginate()
使用 Auth 的 ID 方法,我們直接從認(rèn)證守衛(wèi)中獲取 ID,而不是從可能是 null 的請求(request)中獲取。需要記住的一點(diǎn)是,如果路由沒有使用認(rèn)證中間件,那么 id 方法會(huì)出現(xiàn)“正在嘗試獲取 null 的屬性ID(you are trying to get the property ID of null)”的報(bào)錯(cuò)。因此,請記得為該路由設(shè)置對應(yīng)中間件。
現(xiàn)在,如果我們再次運(yùn)行靜態(tài)分析,我們應(yīng)該已經(jīng)消除了這些錯(cuò)誤:
composer phpstan
Note: Using configuration file /Users/steve/code/sites/larastan-test/phpstan.neon.
20/20 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
[OK] No errors
既然 IndexController
已經(jīng)沒有錯(cuò)誤了。下一步我們要做的是遍歷我們的應(yīng)用,確保在重要的節(jié)點(diǎn)中都運(yùn)行靜態(tài)分析檢查。我們最不想做的事情就是等到 sprint 格式化打印結(jié)束,或者在添加新功能來運(yùn)行它時(shí),才發(fā)現(xiàn)我們必須花費(fèi)無數(shù)個(gè)小時(shí)來修復(fù)靜態(tài)分析問題。無論如何,到最后 - 你將擁有可信任的代碼了,這也是我通常喜歡使用靜態(tài)分析的一個(gè)重要原因。如果你可以配合好的測試套件進(jìn)行靜態(tài)分析,那么就沒有理由不信任你的代碼。
到此,關(guān)于“Laravel中如何設(shè)置PHPStan最高驗(yàn)證級別”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識,請繼續(xù)關(guān)注億速云網(wǎng)站,小編會(huì)繼續(xù)努力為大家?guī)砀鄬?shí)用的文章!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。