Symfony8.0 Finder stopOnVCSIgnored 使用方法

星辰君_8183

星辰君_8183

2026-10-10

571人浏览

原创

stoponvcsignored 是 symfony finder ≥6.2 引入的目录级剪枝方法,需先调用 ignorevcsignored(true) 才生效,遇含 .gitignore 的目录即终止递归,提升大规模项目扫描性能。

symfony8.0 finder stoponvcsignored 使用方法

stopOnVCSIgnored 是 Symfony Finder 组件 自 6.2 版本起引入 的一个方法(注意:Symfony 8.0 默认捆绑的是 Finder v6.4+),用于控制 Finder 在遍历目录时,是否在遇到 .gitignore(或其他 VCS ignore 文件)所在目录时停止向下递归。它不是“跳过被忽略的文件”,而是提前终止对整个子树的扫描,从而提升大规模项目中的查找性能。

这个方法仅在启用 .gitignore 支持的前提下生效,且需配合 ignoreVCSIgnored(true) 使用。


✅ 正确使用前提

  • 你使用的是 Finder ≥ 6.2(Symfony 8.0 满足)
  • 已启用 .gitignore 解析(默认不启用,需显式开启)
  • stopOnVCSIgnored(true) 必须在 ignoreVCSIgnored(true) 之后调用才有效
use Symfony\Component\Finder\Finder;

$finder = Finder::create()
    ->in(__DIR__.'/src')
    ->ignoreVCSIgnored(true)      // ? 必须先启用 .gitignore 解析
    ->stopOnVCSIgnored(true);     // ? 遇到含 .gitignore 的目录即停止递归

此时,若 __DIR__.'/src/Tests' 下存在 .gitignore,Finder 将完全跳过 Tests/ 及其所有子目录(哪怕里面还有匹配的 PHP 文件)。


⚠️ 常见误区与说明

  • stopOnVCSIgnored(true) 不等于 “跳过被 .gitignore 匹配的文件”
    → 它是目录级剪枝(pruning),不是文件级过滤。被忽略的文件仍可能被上层目录中其他规则匹配到(如果未被剪枝)。
  • 若某目录没有 .gitignore,但其父目录有,Finder 不会回溯停止;只在当前目录存在 .gitignore 时触发停止。
  • 它目前只识别 .gitignore(不支持 .hgignore 或 .svnignore)。
  • 该行为不影响 exclude()、notName() 等其他过滤逻辑,仅作用于递归路径遍历阶段。

? 实际效果对比示例

假设目录结构如下:

project/
├── .gitignore              # 内容:/vendor/\n/tests/
├── src/
│   ├── Command/
│   └── Tests/             # ← 这里也会被自动创建 .gitignore?不,实际只看项目根下的 .gitignore
├── tests/                   # ← 根目录下有 /tests/ 被 ignore,且该目录存在
└── vendor/

执行以下代码:

Symfony Linux版
Symfony Linux版

Symfony Linux版整理 Symfony CLI 5.17.1 官方下载入口和 Symfony 框架安装配置说明。

下载
$finder = Finder::create()
    ->files()
    ->name('*.php')
    ->in(__DIR__)
    ->ignoreVCSIgnored(true)
    ->stopOnVCSIgnored(true);

Finder 将:

  • 扫描 project/ 下所有子目录;
  • 进入 tests/ 前,发现根目录 .gitignore 中声明了 /tests/ → 直接跳过整个 tests/ 目录及其子目录;
  • 同样跳过 vendor/(因 /vendor/ 被 ignore);
  • 继续扫描 src/、bin/ 等未被 ignore 的目录。

? 提示:这对 CI 场景或静态分析工具(如 PHPStan、PHP-CS-Fixer)提速明显,避免无谓遍历 tests/ 或 var/。


? 补充:如何确认是否生效?

可结合 getIterator() + 调试输出路径来验证:

foreach ($finder as $file) {
    echo $file->getPathname() . "\n";
}

若 tests/SomeTest.php 未出现在输出中,且你已启用 stopOnVCSIgnored(true),基本说明剪枝成功。

不复杂但容易忽略。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10384

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6121

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2115

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3848

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4554

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3571

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5097

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3982

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11962

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 15.5万人学习