当前位置:首页 > 技术 > 正文内容

PHPStan 有什么用?怎么用?

代码老兵 技术 14

PHPStan 是一个 PHP 的静态分析工具,在不运行代码的情况下就能帮你发现潜在问题,比如:

  • 传错类型(把 string 传给接受 int 的函数)

  • 访问不存在的属性 / 方法

  • null 没处理好

  • 永远不会执行到的代码

  • 数组 key/值类型不一致

  • 返回值不符合声明

  • 注释和真实类型不匹配

它非常适合:

想提升代码质量、减少线上 bug、统一团队风格的人(尤其是中大型项目)。


一、PHPStan 有什么用(通俗点说)

1. 比 IDE 检查更严格

IDE 通常只做简单检查
PHPStan 会进行类型推断,比如:

/** @return int */
function foo() {
   return 'abc';
}

PHPStan 会报:

Return type int does not match string


2. 让 PHP “像强类型语言一样安全”

例如:

$user = null;
echo $user->name;

PHPStan 直接警告:

Access to property name on null

避免线上 500 error


3. 帮助发现逻辑 bug

if ($x > 10 && $x < 5) {
  ...
}

PHPStan:

Condition is always false


4. 提示你补全类型声明 / PHPDoc

长远看:

  • 更好维护

  • IDE 更聪明

  • 减少“这玩意到底是什么类型”的痛苦


二、PHPStan 怎么用?

1. 安装(推荐 composer 局部安装)

composer require --dev phpstan/phpstan

安装完成后会有执行文件:

vendor/bin/phpstan

2. 初始化配置

vendor/bin/phpstan init

会生成:

phpstan.neon

3. 运行分析

检查 src 目录:

vendor/bin/phpstan analyse src

或者多个目录:

vendor/bin/phpstan analyse src app

三、设置分析级别(1–10)

  • level 1:最宽松

  • level 10:最严格(几乎强迫写完美类型)

配置文件示例:

parameters:
   level: 5
   paths:
       - src
       - app

建议:

阶段level
老项目起步2–4
中期提升5–7
新项目/规范团队8–10

四、常用高级功能

忽略某些错误

parameters:
   ignoreErrors:
       - '#Call to an undefined method .*#'

Laravel 项目(用扩展)

composer require --dev nunomaduro/larastan

然后:

vendor/bin/phpstan analyse

Symfony 有 symfony 插件

WordPress、Doctrine、PHPUnit…也有专门扩展。


五、与 IDE 一起用

建议配合:

  • PhpStorm Inspection

  • CodeSniffer (PSR 规范)

  • Rector(自动重构)

  • PHP-CS-Fixer

PHPStan 负责 逻辑安全
CS 工具负责 格式规范


六、示例:真实问题 PHPStan 能抓出来

function add(int $a, int $b): int {
   return $a + $b;
}

echo add("123", 5);

PHP 执行没问题
PHPStan 会报警

Parameter #1 $a of function add expects int, string given

帮助你提前发现“隐形 bug”


七、持续集成(CI)

GitHub Actions 示例:

- name: PHPStan
 run: vendor/bin/phpstan analyse

防止“不规范代码”被合并 👍


标签: PHPStanPHP

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。