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

php

19795 观看

9回复

5091 作者的声誉

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

是否有功能或API内置到PHP,让我分析我的代码库-例如反射token_get_all()

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

作者: Stacey Richards 的来源 发布者: 2008 年 8 月 14 日

回应 (9)


24

5091 作者的声誉

决定

感谢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]);
            }
        }
    }
?>

我可能会花更多的时间在上面,这样我就可以快速找到函数定义和引用的文件和行号; 这些信息正在收集,只是没有显示。

作者: Stacey Richards 发布者: 18.08.2008 01:47

3

20132 作者的声誉

如果我没记错的话,你可以使用phpCallGraph来做到这一点。它将为您生成一个漂亮的图形(图像),包含所有相关方法。如果某个方法没有与任何其他方法相关联,则表明该方法是孤立的。

这是一个例子:classGallerySystem.png

该方法getKeywordSetOfCategories()是孤儿。

顺便说一句,你不必拍摄图像 - phpCallGraph也可以生成文本文件,或PHP数组等。

作者: Till 发布者: 29.03.2009 02:12

3

42385 作者的声誉

因为可以动态调用PHP函数/方法,所以没有编程方法可以确定地知道函数是否永远不会被调用。

唯一可行的方法是通过人工分析。

作者: webbiedave 发布者: 01.06.2010 12:38

-1

41304 作者的声誉

phpxref将识别调用函数的位置,这将有助于分析 - 但仍然需要一定量的手动工作。

作者: symcbean 发布者: 01.06.2010 08:59

-1

8265 作者的声誉

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

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

作者: manuel aldana 发布者: 01.06.2010 09:19

33

265526 作者的声誉

你可以试试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.

更多工具:


注意:根据存储库通知,此项目不再维护,其存储库仅用于存档目的。所以你的里程可能不一样。

作者: Gordon 发布者: 25.01.2011 09:50

7

1974 作者的声誉

用法:find_unused_functions.php

注意:这是解决问题的“快速肮脏”方法。此脚本仅对文件执行词法传递,并且不考虑不同模块定义具有相同名称的函数或方法的情况。如果您使用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 */
作者: Andrey Butov 发布者: 20.08.2011 04:57

18

191 作者的声誉

这一点bash脚本可能会有所帮助:

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

这基本上递归地抓取当前目录的函数定义,将命中传递给awk,这形成了执行以下操作的命令:

  • 打印功能名称
  • 递归grep再次
  • 输出到grep -v的管道,用于过滤掉函数定义,以便保留对函数的调用
  • 将此输出传递给wc -l,它打印行数

然后将此命令发送到bash执行,输出被grepped为0,这表示0调用该函数。

请注意,这不是解决问题calebbrown上述列举,所以有可能在输出一些误报。

作者: Tim Cullen 发布者: 02.04.2012 03:43

0

9596 作者的声誉

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

查看报告的方法并删除那些没用的👍


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

作者: Tomáš Votruba 发布者: 16.03.2019 11:55
32x32