php - 如何在 PHP 项目中找到未使用的函数

Question

如何在 PHP 项目中找到任何未使用的函数？

PHP 中是否有内置的功能或 API 可以让我分析我的代码库 - 例如反射，token_get_all()？

这些 API 的功能是否足够丰富，让我不必依赖第三方工具来执行此类分析？

Answer 1

你可以试试 Sebastian Bergmann 的死代码检测器：

phpdcd是 PHP 代码的死代码检测器 (DCD)。它扫描 PHP 项目中所有声明的函数和方法，并将它们报告为至少没有调用一次的“死代码”。

来源：https ://github.com/sebastianbergmann/phpdcd

请注意，它是一个静态代码分析器，因此它可能会为仅动态调用的方法提供误报，例如它无法检测到$foo = 'fn'; $foo();

您可以通过 PEAR 安装它：

pear install phpunit/phpdcd-beta

之后，您可以使用以下选项：

Usage: phpdcd [switches] <directory|file> ...

--recursive Report code as dead if it is only called by dead code.

--exclude <dir> Exclude <dir> from code analysis.
--suffixes <suffix> A comma-separated list of file suffixes to check.

--help Prints this usage information.
--version Prints the version and exits.

--verbose Print progress bar.

更多工具：

• https://phpqa.io/

---

注意：根据存储库通知，此项目不再维护，其存储库仅用于存档目的。所以你的里程可能会有所不同。

Answer 2

感谢 Greg 和 Dave 的反馈。不是我想要的，但我决定花点时间研究它，并想出了这个快速而肮脏的解决方案：

<?php
    $functions = array();
    $path = "/path/to/my/php/project";
    define_dir($path, $functions);
    reference_dir($path, $functions);
    echo
        "<table>" .
            "<tr>" .
                "<th>Name</th>" .
                "<th>Defined</th>" .
                "<th>Referenced</th>" .
            "</tr>";
    foreach ($functions as $name => $value) {
        echo
            "<tr>" . 
                "<td>" . htmlentities($name) . "</td>" .
                "<td>" . (isset($value[0]) ? count($value[0]) : "-") . "</td>" .
                "<td>" . (isset($value[1]) ? count($value[1]) : "-") . "</td>" .
            "</tr>";
    }
    echo "</table>";
    function define_dir($path, &$functions) {
        if ($dir = opendir($path)) {
            while (($file = readdir($dir)) !== false) {
                if (substr($file, 0, 1) == ".") continue;
                if (is_dir($path . "/" . $file)) {
                    define_dir($path . "/" . $file, $functions);
                } else {
                    if (substr($file, - 4, 4) != ".php") continue;
                    define_file($path . "/" . $file, $functions);
                }
            }
        }       
    }
    function define_file($path, &$functions) {
        $tokens = token_get_all(file_get_contents($path));
        for ($i = 0; $i < count($tokens); $i++) {
            $token = $tokens[$i];
            if (is_array($token)) {
                if ($token[0] != T_FUNCTION) continue;
                $i++;
                $token = $tokens[$i];
                if ($token[0] != T_WHITESPACE) die("T_WHITESPACE");
                $i++;
                $token = $tokens[$i];
                if ($token[0] != T_STRING) die("T_STRING");
                $functions[$token[1]][0][] = array($path, $token[2]);
            }
        }
    }
    function reference_dir($path, &$functions) {
        if ($dir = opendir($path)) {
            while (($file = readdir($dir)) !== false) {
                if (substr($file, 0, 1) == ".") continue;
                if (is_dir($path . "/" . $file)) {
                    reference_dir($path . "/" . $file, $functions);
                } else {
                    if (substr($file, - 4, 4) != ".php") continue;
                    reference_file($path . "/" . $file, $functions);
                }
            }
        }       
    }
    function reference_file($path, &$functions) {
        $tokens = token_get_all(file_get_contents($path));
        for ($i = 0; $i < count($tokens); $i++) {
            $token = $tokens[$i];
            if (is_array($token)) {
                if ($token[0] != T_STRING) continue;
                if ($tokens[$i + 1] != "(") continue;
                $functions[$token[1]][1][] = array($path, $token[2]);
            }
        }
    }
?>

我可能会花更多时间在上面，以便我可以快速找到函数定义和引用的文件和行号；正在收集此信息，只是未显示。

Answer 3

这段 bash 脚本可能会有所帮助：

grep -rhio ^function\ .*\(  .|awk -F'[( ]'  '{print "echo -n " $2 " && grep -rin " $2 " .|grep -v function|wc -l"}'|bash|grep 0

这基本上递归地 greps 函数定义的当前目录，将命中传递给 awk，它形成一个命令来执行以下操作：

• 打印函数名
• 再次递归地 grep
• 管道输出到 grep -v 以过滤掉函数定义，以便保留对函数的调用
• 将此输出通过管道传输到 wc -l 以打印行数

然后将此命令发送到 bash 以执行，并将输出 grep 为 0，这表示对该函数的调用为 0。

请注意，这不会解决上面 calebbrown 引用的问题，因此输出中可能存在一些误报。

Answer 4

用法：find_unused_functions.php <root_directory>

注意：这是解决问题的“快速-n-dirty”方法。此脚本仅对文件执行词法传递，并且不考虑不同模块定义相同名称的函数或方法的情况。如果您使用 IDE 进行 PHP 开发，它可能会提供更全面的解决方案。

需要 PHP 5

为了节省您的复制和粘贴、直接下载和任何新版本，都可以在此处获得。

#!/usr/bin/php -f
 
<?php
 
// ============================================================================
//
// find_unused_functions.php
//
// Find unused functions in a set of PHP files.
// version 1.3
//
// ============================================================================
//
// Copyright (c) 2011, Andrey Butov. All Rights Reserved.
// This script is provided as is, without warranty of any kind.
//
// http://www.andreybutov.com
//
// ============================================================================
 
// This may take a bit of memory...
ini_set('memory_limit', '2048M');
 
if ( !isset($argv[1]) ) 
{
    usage();
}
 
$root_dir = $argv[1];
 
if ( !is_dir($root_dir) || !is_readable($root_dir) )
{
    echo "ERROR: '$root_dir' is not a readable directory.\n";
    usage();
}
 
$files = php_files($root_dir);
$tokenized = array();
 
if ( count($files) == 0 )
{
    echo "No PHP files found.\n";
    exit;
}
 
$defined_functions = array();
 
foreach ( $files as $file )
{
    $tokens = tokenize($file);
 
    if ( $tokens )
    {
        // We retain the tokenized versions of each file,
        // because we'll be using the tokens later to search
        // for function 'uses', and we don't want to 
        // re-tokenize the same files again.
 
        $tokenized[$file] = $tokens;
 
        for ( $i = 0 ; $i < count($tokens) ; ++$i )
        {
            $current_token = $tokens[$i];
            $next_token = safe_arr($tokens, $i + 2, false);
 
            if ( is_array($current_token) && $next_token && is_array($next_token) )
            {
                if ( safe_arr($current_token, 0) == T_FUNCTION )
                {
                    // Find the 'function' token, then try to grab the 
                    // token that is the name of the function being defined.
                    // 
                    // For every defined function, retain the file and line
                    // location where that function is defined. Since different
                    // modules can define a functions with the same name,
                    // we retain multiple definition locations for each function name.
 
                    $function_name = safe_arr($next_token, 1, false);
                    $line = safe_arr($next_token, 2, false);
 
                    if ( $function_name && $line )
                    {
                        $function_name = trim($function_name);
                        if ( $function_name != "" )
                        {
                            $defined_functions[$function_name][] = array('file' => $file, 'line' => $line);
                        }
                    }
                }
            }
        }
    }
}
 
// We now have a collection of defined functions and
// their definition locations. Go through the tokens again, 
// and find 'uses' of the function names. 
 
foreach ( $tokenized as $file => $tokens )
{
    foreach ( $tokens as $token )
    {
        if ( is_array($token) && safe_arr($token, 0) == T_STRING )
        {
            $function_name = safe_arr($token, 1, false);
            $function_line = safe_arr($token, 2, false);;
 
            if ( $function_name && $function_line )
            {
                $locations_of_defined_function = safe_arr($defined_functions, $function_name, false);
 
                if ( $locations_of_defined_function )
                {
                    $found_function_definition = false;
 
                    foreach ( $locations_of_defined_function as $location_of_defined_function )
                    {
                        $function_defined_in_file = $location_of_defined_function['file'];
                        $function_defined_on_line = $location_of_defined_function['line'];
 
                        if ( $function_defined_in_file == $file && 
                             $function_defined_on_line == $function_line )
                        {
                            $found_function_definition = true;
                            break;
                        }
                    }
 
                    if ( !$found_function_definition )
                    {
                        // We found usage of the function name in a context
                        // that is not the definition of that function. 
                        // Consider the function as 'used'.
 
                        unset($defined_functions[$function_name]);
                    }
                }
            }
        }
    }
}
 
 
print_report($defined_functions);   
exit;
 
 
// ============================================================================
 
function php_files($path) 
{
    // Get a listing of all the .php files contained within the $path
    // directory and its subdirectories.
 
    $matches = array();
    $folders = array(rtrim($path, DIRECTORY_SEPARATOR));
 
    while( $folder = array_shift($folders) ) 
    {
        $matches = array_merge($matches, glob($folder.DIRECTORY_SEPARATOR."*.php", 0));
        $moreFolders = glob($folder.DIRECTORY_SEPARATOR.'*', GLOB_ONLYDIR);
        $folders = array_merge($folders, $moreFolders);
    }
 
    return $matches;
}
 
// ============================================================================
 
function safe_arr($arr, $i, $default = "")
{
    return isset($arr[$i]) ? $arr[$i] : $default;
}
 
// ============================================================================
 
function tokenize($file)
{
    $file_contents = file_get_contents($file);
 
    if ( !$file_contents )
    {
        return false;
    }
 
    $tokens = token_get_all($file_contents);
    return ($tokens && count($tokens) > 0) ? $tokens : false;
}
 
// ============================================================================
 
function usage()
{
    global $argv;
    $file = (isset($argv[0])) ? basename($argv[0]) : "find_unused_functions.php";
    die("USAGE: $file <root_directory>\n\n");
}
 
// ============================================================================
 
function print_report($unused_functions)
{
    if ( count($unused_functions) == 0 )
    {
        echo "No unused functions found.\n";
    }
 
    $count = 0;
    foreach ( $unused_functions as $function => $locations )
    {
        foreach ( $locations as $location )
        {
            echo "'$function' in {$location['file']} on line {$location['line']}\n";
            $count++;
        }
    }
 
    echo "=======================================\n";
    echo "Found $count unused function" . (($count == 1) ? '' : 's') . ".\n\n";
}
 
// ============================================================================
 
/* EOF */

Answer 5

2020 更新

我已经使用了上面列出的其他方法，即使这里的 2019 更新答案也已过时。

Tomáš Votruba 的回答让我找到了 Phan，因为 ECS 路线现已被弃用。Symplify 已删除已死的公共方法检查器。

Phan 是 PHP 的静态分析器

我们可以利用 Phan 来搜索死代码。以下是使用 composer 安装的步骤。这些步骤也可以在phan 的 git repo 中找到。这些说明假设您位于项目的根目录。

第 1 步 - 使用 composer 安装 Phan

composer require phan/phan

第 2 步 - 安装 php-ast

PHP-AST是 Phan 的要求 因为我使用的是 WSL，所以我已经能够使用 PECL 进行安装，但是，php-ast可以在 git repo 中找到其他安装方法

pecl install ast

第 3 步 - 找到并编辑 php.ini 以使用 php-ast

定位当前php.ini

php -i | grep 'php.ini'

现在获取该文件位置和 nano（或您选择的任何一个来编辑此文档）。找到所有扩展的区域并添加以下行：

extension=ast.so

第 4 步 - 为 Phan 创建一个配置文件

配置文件的步骤可以在 Phan 的关于如何创建配置文件的文档中找到。 您将希望使用他们的示例文件，因为这是一个很好的起点。编辑以下数组以在 directory_list&上添加您自己的路径exclude_analysis_directory_list。请注意，它exclude_analysis_directory_list仍然会被解析但不会被验证，例如。在此处添加 Wordpress 目录意味着，主题中调用的 wordpress 函数的误报不会出现，因为它在 wordpress 中找到了该函数，但同时它不会验证 wordpress 文件夹中的函数。我的看起来像这样

......

'directory_list' => [
  'public_html'
],

......

'exclude_analysis_directory_list' => [
    'vendor/',
    'public_html/app/plugins',
    'public_html/app/mu-plugins',
    'public_html/admin'
],
......

第 5 步 - 使用死代码检测运行 Phan

现在我们已经安装了 phan 和 ast，配置了我们希望解析的文件夹，是时候运行 Phan。我们将向 phan 传递一个--dead-code-detection不言自明的参数。

./vendor/bin/phan --dead-code-detection

该输出需要使用细齿梳进行验证，但它肯定是最好的起点

控制台中的输出将如下所示

the/path/to/php/file.php:324 PhanUnreferencedPublicMethod Possibly zero references to public method\the\path\to\function::the_funciton()
the/path/to/php/file.php:324 PhanUnreferencedPublicMethod Possibly zero references to public method\the\path\to\function::the_funciton()
the/path/to/php/file.php:324 PhanUnreferencedPublicMethod Possibly zero references to public method\the\path\to\function::the_funciton()
the/path/to/php/file.php:324 PhanUnreferencedPublicMethod Possibly zero references to public method\the\path\to\function::the_funciton()

请随时添加到此答案或纠正我的错误:)

Answer 6

如果我没记错的话，你可以使用phpCallGraph来做到这一点。它会为您生成一个漂亮的图表（图像），其中包含所有涉及的方法。如果一个方法没有与任何其他方法连接，这是一个很好的迹象，表明该方法是孤立的。

这是一个示例：classGallerySystem.png

该方法getKeywordSetOfCategories()是孤立的。

顺便说一句，您不必拍摄图像——phpCallGraph 还可以生成文本文件，或者 PHP 数组等。

Answer 7

因为 PHP 函数/方法可以动态调用，所以没有编程方式可以确定某个函数是否永远不会被调用。

唯一确定的方法是通过人工分析。

Answer 8

2019+ 更新

我受到安德烈的回答的启发，并将其变成了编码标准嗅探。

检测非常简单但功能强大：

• 找到所有方法public function someMethod()
• 然后找到所有方法调用${anything}->someMethod()
• 并简单地报告那些从未被调用的公共函数

它帮助我删除了 20 多种我必须维护和测试的方法。

找到它们的 3 个步骤

安装 ECS：

composer require symplify/easy-coding-standard --dev

设置ecs.yaml配置：

# ecs.yaml
services:
    Symplify\CodingStandard\Sniffs\DeadCode\UnusedPublicMethodSniff: ~

运行命令：

vendor/bin/ecs check src

查看报告的方法并删除那些你不认为有用的方法

---

您可以在此处阅读更多相关信息：从您的代码中删除已死的公共方法

Answer 9

phpxref将识别从哪里调用函数，这将有助于分析 - 但仍然涉及一定数量的手动工作。

Answer 10

afaik 没有办法。要知道哪些函数“属于谁”，您需要执行系统（运行时后期绑定函数查找）。

但是重构工具是基于静态代码分析的。我真的很喜欢动态类型语言，但在我看来它们很难扩展。大型代码库和动态类型语言缺乏安全重构是可维护性和处理软件演化的主要缺点。