1. 程式人生 > 程式設計 >PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

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

下載PHPSTORM 2020.2最新試用

Jetbrains PhpStorm 2020.1 完美版(附安裝教程)

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%)'
)]

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

#[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常量形式的類引用。.

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

您可以將定義形狀的陣列提取為常量,然後在其適用的屬性內重用它:

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

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

那些不能升級到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將檢查物件和屬性的用法,並突出顯示更改嘗試。

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

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

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

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

#[Pure]

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

PhpStorm將檢測pure函式的冗餘呼叫。

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

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

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

#[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 2020.3:新增開箱即用的PHP 8屬性(推薦)

在.phpstorm.meta.php中具有ExpectedArguments()

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

使用#[ExpectedValues]屬性

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

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

#[ExpectedValues]示例

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

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

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

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

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

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

#[NoReturn]

程式碼庫中的某些功能可能會導致指令碼執行停止。首先,從函式名稱中並不總是很明顯,例如,trigger_error()根據第二個引數可以停止執行。其次,PhpStorm不能總是檢測到此類功能,因為深入分析可能會導致效能問題。

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

PhpStorm 2020.3:新增開箱即用的PHP 8屬性(推薦)

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

PhpStorm點選此處下載

到此這篇關於PhpStorm 2020.3:新增開箱即用的PHP 8屬性的文章就介紹到這了,更多相關PhpStorm 2020.3新增PHP 8屬性內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!