PhpStorm 2020.3：新增開(kāi)箱即用的PHP 8屬性(推薦)

PhpStorm是一個(gè)輕量級(jí)且便捷的PHP IDE，其旨在提高用戶(hù)效率，可深刻理解用戶(hù)的編碼，提供智能代碼補(bǔ)全，快速導(dǎo)航以及即時(shí)錯(cuò)誤檢查?？呻S時(shí)幫助用戶(hù)對(duì)其編碼進(jìn)行調(diào)整，運(yùn)行單元測(cè)試或者提供可視化debug功能。

下載PHPSTORM 2020.2最新試用

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

PhpStorm 2020.3將附帶幾個(gè)開(kāi)箱即用的PHP 8屬性：
#[ArrayShape]，#[ExpectedValues]，#[NoReturn]，#[Pure]，#[Deprecated]，#[Immutable]。繼續(xù)閱讀以了解有關(guān)屬性的更多信息。

你可能已經(jīng)聽(tīng)說(shuō)過(guò) PHP 8 中的屬性，但也許你不知道的是它們將是取代 PHPDoc 的結(jié)構(gòu)化元數(shù)據(jù)的新格式，現(xiàn)在將成為該語(yǔ)言的一部分。

PHP 8 中的屬性是什么？
除了調(diào)用 ReflectionAttribute::newInstance()時(shí)的語(yǔ)法定義和驗(yàn)證之外，PHP 8 沒(méi)有提供任何開(kāi)箱即用的屬性。對(duì)于你定義的屬性，你必須自己實(shí)現(xiàn)它們的行為。

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

以下屬性的設(shè)計(jì)仍在進(jìn)行中，非常歡迎你的反饋。

#[Deprecated]
這個(gè)屬性類(lèi)似于@deprecated PHPDoc標(biāo)簽，用于標(biāo)記方法、函數(shù)、類(lèi)或類(lèi)常量，它表示這些方法、函數(shù)、類(lèi)或類(lèi)常量在未來(lái)的版本中會(huì)被刪除，因?yàn)樗鼈円呀?jīng)過(guò)時(shí)了。

這個(gè)新屬性的主要優(yōu)點(diǎn)是，你可以指定替換函數(shù)和方法。這將幫助被廢棄功能的用戶(hù)進(jìn)行遷移。

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

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

讓我們看一個(gè)真實(shí)的例子。

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

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

＃[ArrayShape]

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

但另一部分--指定可能的鍵和它們對(duì)應(yīng)的值類(lèi)型--仍然缺失。當(dāng)處理簡(jiǎn)單的數(shù)據(jù)結(jié)構(gòu)或類(lèi)似對(duì)象的數(shù)組時(shí)，當(dāng)定義一個(gè)真正的類(lèi)可能會(huì)感覺(jué)過(guò)度時(shí)，這個(gè)功能可能會(huì)很有用。

從PhpStorm 2020.3開(kāi)始，可以使用#[ArrayShape]來(lái)定義這種數(shù)組的結(jié)構(gòu)。

語(yǔ)法如下。

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

如您所見(jiàn)，“類(lèi)型”可以指定為字符串中的標(biāo)量，也可以指定為FQN字符串或::class常量形式的類(lèi)引用。.

您可以將定義形狀的數(shù)組提取為常量，然后在其適用的屬性?xún)?nèi)重用它：

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

那些不能升級(jí)到PHP 8的遺留項(xiàng)目呢？
幸運(yùn)的是，單行屬性的語(yǔ)法是向后兼容的。這意味著，如果將#[ArrayShape]屬性添加到PHP 7. *項(xiàng)目的單獨(dú)一行中，則PHP解釋器會(huì)將其解析為一行注釋?zhuān)⑶也粫?huì)出現(xiàn)解析錯(cuò)誤。但是，多行屬性對(duì)于8之前的PHP版本并不安全。

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

請(qǐng)注意，在PhpStorm中使用較早的PHP版本時(shí)，您將完成代碼，但是檢查將僅在8級(jí)及以上的語(yǔ)言下進(jìn)行。

＃[Immutable]

不可變對(duì)象是初始化或創(chuàng)建后無(wú)法更改的對(duì)象。使用它們的好處如下：

• 程序狀態(tài)更可預(yù)測(cè)。
• 調(diào)試更容易。

可以使用getter和setter或魔術(shù)方法在某種程度上模擬不可變的對(duì)象。從PhpStorm 2020.3開(kāi)始，您可以簡(jiǎn)單地用#[Immutable]屬性標(biāo)記對(duì)象或?qū)傩浴?/p>

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

你可以將寫(xiě)范圍限制調(diào)整為只限制構(gòu)造函數(shù)，或者模擬私有和保護(hù)范圍。要做到這一點(diǎn)，請(qǐng)將常量CONSTRUCTOR_WRITE_SCOPE、PRIVATE_WRITE_SCOPE、PROTECTED_WRITE_SCOPE中的一個(gè)傳遞給#[Immutable]屬性構(gòu)造函數(shù)。

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

＃[Pure]

您可以將不會(huì)產(chǎn)生任何副作用的函數(shù)標(biāo)記為pure函數(shù)。如果之后執(zhí)行的結(jié)果未在代碼中使用，則可以安全地刪除此類(lèi)函數(shù)。

PhpStorm將檢測(cè)pure函數(shù)的冗余調(diào)用。

如果該函數(shù)被標(biāo)記為pure函數(shù)，但您嘗試在函數(shù)外部進(jìn)行更改，即產(chǎn)生副作用，則PhpStorm將警告您并突出顯示不安全的代碼。

＃[ExpectedValues]

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

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

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

它接受的第二個(gè)參數(shù)是整數(shù)，但實(shí)際上，它不是整數(shù)。而是它是常數(shù)COUNT_NORMALor之一COUNT_RECURSIVE，對(duì)應(yīng)于0和1。

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

沒(méi)有元

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

使用＃[ExpectedValues]屬性

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

＃[ExpectedValues]示例

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

這使我們?nèi)鄙賰蓚€(gè)關(guān)鍵功能：

• 可能狀態(tài)代碼的代碼完成
• 在編輯器中驗(yàn)證

我們可以通過(guò)添加屬性 #[ExpectedValues(valuesFromClass: Response::class)]來(lái)解決此問(wèn)題

＃[NoReturn]

代碼庫(kù)中的某些功能可能會(huì)導(dǎo)致腳本執(zhí)行停止。首先，從函數(shù)名稱(chēng)中并不總是很明顯，例如，trigger_error()根據(jù)第二個(gè)參數(shù)可以停止執(zhí)行。其次，PhpStorm不能總是檢測(cè)到此類(lèi)功能，因?yàn)樯钊敕治隹赡軙?huì)導(dǎo)致性能問(wèn)題。

這就是為什么將這些功能標(biāo)記為出口點(diǎn)，以通過(guò)添加#[NoReturn]屬性來(lái)進(jìn)行更準(zhǔn)確的控制流分析的原因。

而且，PhpStorm將提供通過(guò)快速修復(fù)在整個(gè)層次結(jié)構(gòu)中向下傳播屬性的功能，以進(jìn)行更加明確的分析。

PhpStorm點(diǎn)擊此處下載

到此這篇關(guān)于PhpStorm 2020.3：新增開(kāi)箱即用的PHP 8屬性的文章就介紹到這了,更多相關(guān)PhpStorm 2020.3新增PHP 8屬性?xún)?nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！