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属性的方法了吗?如果还想学到更多技能或想了解更多相关内容,欢迎关注亿速云行业资讯频道,感谢各位的阅读!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。