PhpStorm 2020.3新增的PHP 8屬性

PhpStorm 2020.3新增的PHP 8屬性？相信很多沒有經驗的人對此束手無策，為此本文總結了問題出現的原因和解決方法，通過這篇文章希望你能解決這個問題。

PhpStorm是一個輕量級且便捷的PHP IDE，其旨在提高用戶效率，可深刻理解用戶的編碼，提供智能代碼補全，快速導航以及即時錯誤檢查。可隨時幫助用戶對其編碼進行調整，運行單元測試或者提供可視化debug功能。

下載PHPSTORM 2020.2最新試用

PhpStorm 2020.3將附帶幾個開箱即用的PHP 8屬性：
#[ArrayShape]，#[ExpectedValues]，#[NoReturn]，#[Pure]，#[Deprecated]，#[Immutable]。繼續閱讀以了解有關屬性的更多信息。

你可能已經聽說過 PHP 8 中的屬性，但也許你不知道的是它們將是取代 PHPDoc 的結構化元數據的新格式，現在將成為該語言的一部分。

PHP 8 中的屬性是什么？
除了調用 ReflectionAttribute::newInstance()時的語法定義和驗證之外，PHP 8 沒有提供任何開箱即用的屬性。對于你定義的屬性，你必須自己實現它們的行為。

在 PhpStorm 2020.3 中會有哪些屬性？
在PhpStorm 2020.3中，一些屬性將在\JetBrains\PhpStorm\命名空間下可用。#[ExpectedValues]和#[NoReturn]是.phpstorm.meta.php函數的高級后裔。而#[ArrayShape]是PHPDoc的數組描述的一個備受期待的進化。此外，還會有#[Deprecated]、#[Pure]和#[Immutable]。

以下屬性的設計仍在進行中，非常歡迎你的反饋。

#[Deprecated]
這個屬性類似于@deprecated PHPDoc標簽，用于標記方法、函數、類或類常量，它表示這些方法、函數、類或類常量在未來的版本中會被刪除，因為它們已經過時了。

這個新屬性的主要優點是，你可以指定替換函數和方法。這將幫助被廢棄功能的用戶進行遷移。

如果為屬性指定了reason參數，那么它將在檢查工具提示中顯示給用戶。

#[Deprecated(reason: '', replacement: '')]

讓我們看一個真實的例子。

在Symfony 5.2中，/Symfony/Component/DependencyInjection/Alias::setPrivate()將被廢棄。有了#[Deprecated]屬性，我們可以更容易地進行遷移。

#[Deprecated(
 reason: 'since Symfony 5.2, use setPublic() instead',
 replacement: '%class%->setPublic(!%parameter0%)'
)]

＃[ArrayShape]

PhpStorm要求最多的功能之一是支持更具體的數組PHPDoc注釋。這在Psalm支持下得到了部分實現。

但另一部分--指定可能的鍵和它們對應的值類型--仍然缺失。當處理簡單的數據結構或類似對象的數組時，當定義一個真正的類可能會感覺過度時，這個功能可能會很有用。

從PhpStorm 2020.3開始，可以使用#[ArrayShape]來定義這種數組的結構。

語法如下。

#[ArrayShape([
 // ‘key' => 'type',
 ‘key1' => ‘int',
 ‘key2' => ‘string',
 ‘key3' => ‘Foo',
 ‘key3' => App\PHP 8\Foo::class,
])]
function functionName(...): array

如您所見，“類型”可以指定為字符串中的標量，也可以指定為FQN字符串或::class常量形式的類引用。.

您可以將定義形狀的數組提取為常量，然后在其適用的屬性內重用它：

const MY_ARRAY_SHAPE = [];
#[ArrayShape(MY_ARRAY_SHAPE)]

那些不能升級到PHP 8的遺留項目呢？
幸運的是，單行屬性的語法是向后兼容的。這意味著，如果將#[ArrayShape]屬性添加到PHP 7. *項目的單獨一行中，則PHP解釋器會將其解析為一行注釋，并且不會出現解析錯誤。但是，多行屬性對于8之前的PHP版本并不安全。

與PHP解釋器不同，PhpStorm仍然會分析屬性！因此，即使您的項目在PHP 7.4或更低版本上運行，您仍然可以從添加#[ArrayShape]屬性中受益。

請注意，在PhpStorm中使用較早的PHP版本時，您將完成代碼，但是檢查將僅在8級及以上的語言下進行。

＃[Immutable]

不可變對象是初始化或創建后無法更改的對象。使用它們的好處如下：

• 程序狀態更可預測。
• 調試更容易。

可以使用getter和setter或魔術方法在某種程度上模擬不可變的對象。從PhpStorm 2020.3開始，您可以簡單地用#[Immutable]屬性標記對象或屬性。

PhpStorm將檢查對象和屬性的用法，并突出顯示更改嘗試。

你可以將寫范圍限制調整為只限制構造函數，或者模擬私有和保護范圍。要做到這一點，請將常量CONSTRUCTOR_WRITE_SCOPE、PRIVATE_WRITE_SCOPE、PROTECTED_WRITE_SCOPE中的一個傳遞給#[Immutable]屬性構造函數。

＃[Immutable]屬性即使在PHP 7.4及更低版本中也可以使用！

＃[Pure]

您可以將不會產生任何副作用的函數標記為pure函數。如果之后執行的結果未在代碼中使用，則可以安全地刪除此類函數。

PhpStorm將檢測pure函數的冗余調用。

如果該函數被標記為pure函數，但您嘗試在函數外部進行更改，即產生副作用，則PhpStorm將警告您并突出顯示不安全的代碼。

＃[ExpectedValues]

使用此屬性，您可以指定函數接受哪些值作為參數，以及可以返回哪些值。

這與expectedArguments()函數可以執行的操作類似.phpstorm.meta.php，不同之處在于meta版本更像是完成對手。相反，該屬性假定參數或返回值沒有其他可能的值。

例如，讓我們看一下count函數：
count ( array|Countable $array_or_countable [, int $mode = COUNT_NORMAL ] ) : int

它接受的第二個參數是整數，但實際上，它不是整數。而是它是常數COUNT_NORMALor之一COUNT_RECURSIVE，對應于0和1。

您可以將#[ExpectedValues]屬性添加到第二個參數。這就是這種情況下代碼完成的方式。

沒有元

在.phpstorm.meta.php中具有ExpectedArguments（）

使用＃[ExpectedValues]屬性

如何指定可能的值或位掩碼。

＃[ExpectedValues]示例

讓我們看一下response()Laravel中的助手。它以HTTP狀態代碼作為第二個參數。

這使我們缺少兩個關鍵功能：

• 可能狀態代碼的代碼完成
• 在編輯器中驗證

我們可以通過添加屬性 #[ExpectedValues(valuesFromClass: Response::class)]來解決此問題

＃[NoReturn]

代碼庫中的某些功能可能會導致腳本執行停止。首先，從函數名稱中并不總是很明顯，例如，trigger_error()根據第二個參數可以停止執行。其次，PhpStorm不能總是檢測到此類功能，因為深入分析可能會導致性能問題。

這就是為什么將這些功能標記為出口點，以通過添加#[NoReturn]屬性來進行更準確的控制流分析的原因。

而且，PhpStorm將提供通過快速修復在整個層次結構中向下傳播屬性的功能，以進行更加明確的分析。

看完上述內容，你們掌握PhpStorm 2020.3新增的PHP 8屬性的方法了嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！