萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 魔術常量實測:__CLASS__、__METHOD__、__LINE__、__FILE__、__DIR__、__TRAIT__、__NAMESPACE__ 完整示範

前言

PHP 提供 8 個魔術常量,在編譯期依據所在位置解析為對應值。它們不是變數、不區分大小寫(慣例全大寫)、前後各兩底線。本文提供完整測試代碼、輸出結果解析、Trait/命名空間情境下的行為差異,並說明與 debug_backtrace() 的本質不同。

一、完整測試代碼

<?php
// 檔案:/var/www/project/src/Demo/MagicConstants.php
namespace Demo;

trait Loggable {
    public function log(string $msg): void {
        echo "[LOG] " . __METHOD__ . " : $msg\n"; // Demo\Loggable::log
    }
}

class MagicConstants {
    use Loggable;

    public const VERSION = '1.0';

    public function demonstrate(): void {
        echo "=== 魔術常量輸出 ===\n";
        echo "__CLASS__     = " . __CLASS__ . "\n";       // Demo\MagicConstants
        echo "__FUNCTION__  = " . __FUNCTION__ . "\n";   // demonstrate
        echo "__METHOD__    = " . __METHOD__ . "\n";     // Demo\MagicConstants::demonstrate
        echo "__LINE__      = " . __LINE__ . "\n";       // 當前行號
        echo "__FILE__      = " . __FILE__ . "\n";       // 完整絕對路徑
        echo "__DIR__       = " . __DIR__ . "\n";        // 目錄路徑
        echo "__TRAIT__     = " . __TRAIT__ . "\n";      // Demo\Loggable (在 trait 方法中)
        echo "__NAMESPACE__ = " . __NAMESPACE__ . "\n";  // Demo
    }
}

// 全域函式測試
function globalFunc() {
    echo "\n=== 全域函式 ===\n";
    echo "__FUNCTION__ = " . __FUNCTION__ . "\n"; // globalFunc
    echo "__METHOD__   = " . __METHOD__ . "\n";   // globalFunc (同 FUNCTION)
    echo "__CLASS__    = " . __CLASS__ . "\n";    // (空字串)
    echo "__NAMESPACE__= " . __NAMESPACE__ . "\n"; // Demo
}

// 執行
$obj = new MagicConstants();
$obj->demonstrate();
$obj->log("測試訊息"); // 觸發 Trait 方法
globalFunc();
?>

二、預期輸出結果解析

=== 魔術常量輸出 ===
__CLASS__     = Demo\MagicConstants
__FUNCTION__  = demonstrate
__METHOD__    = Demo\MagicConstants::demonstrate
__LINE__      = 15
__FILE__      = /var/www/project/src/Demo/MagicConstants.php
__DIR__       = /var/www/project/src/Demo
__TRAIT__     = Demo\Loggable
__NAMESPACE__ = Demo

=== 全域函式 ===
__FUNCTION__ = globalFunc
__METHOD__   = globalFunc
__CLASS__    = 
__NAMESPACE__ = Demo

關鍵觀察點

  1. __CLASS__、__METHOD__、__TRAIT__、__NAMESPACE__ 皆包含完整命名空間,區分大小寫。
  2. __FUNCTION__ 在類方法中只回傳方法名(不含類別),全域函式同 __METHOD__。
  3. __TRAIT__ 僅在 Trait 定義內部有意義,外部呼叫時解析為使用該 Trait 的類別方法。
  4. __FILE__ 為實際檔案絕對路徑(已解析 symlink),__DIR__ 等同 dirname(__FILE__) 但更快。

三、進階情境:繼承與 Trait 衝突

<?php
namespace App;

trait T1 {
    public function foo() { echo __METHOD__ . "\n"; } // App\T1::foo
}
trait T2 {
    public function foo() { echo __METHOD__ . "\n"; } // App\T2::foo
}

class Base {
    use T1 {
        T1::foo as baseFoo;
    }
    public function test() {
        echo "Base::__METHOD__ = " . __METHOD__ . "\n"; // App\Base::test
        $this->baseFoo();
    }
}

class Child extends Base {
    use T2 {
        T2::foo insteadof T1;
    }
    public function test() {
        echo "Child::__METHOD__ = " . __METHOD__ . "\n"; // App\Child::test
        $this->foo(); // 來自 T2
    }
}

$c = new Child();
$c->test();
/*
Child::__METHOD__ = App\Child::test
App\T2::foo
*/
?>

四、魔術常量 vs debug_backtrace()

特性魔術常量debug_backtrace()
解析時機編譯期執行期
呼叫堆疊感知無(寫死位置)完整堆疊
效能O(1) 極快O(n) 較慢
可取得參數值否是 (預設)
適用場景靜態日誌、路徑基準、編譯期資訊動態追蹤、除錯器、效能分析

五、實戰最佳實踐

1. 自動載入基準路徑

<?php
// composer 自動載入器常見模式
$loader = require __DIR__ . '/../vendor/autoload.php'; // __DIR__ 為專案根目錄
?>

2. 結構化日誌上下文

<?php
function logInfo(string $message, array $context = []): void {
    $context += [
        'class'  => __CLASS__,
        'method' => __METHOD__,
        'line'   => __LINE__,
        'file'   => basename(__FILE__),
        'time'   => microtime(true),
    ];
    // 送至 Monolog、Elasticsearch 等
}
?>

3. 匿名類別中的魔術常量 (PHP 7.0+)

<?php
$anon = new class {
    public function test() {
        echo __CLASS__ . "\n"; // class@anonymous\n/path/file.php:10
    }
};
$anon->test();
?>

六、常見誤區釐清

誤區:__CLASS__ 在繼承子類別中會變成子類別名。
事實:__CLASS__ 永遠是定義該常量的類別。需取得實際類別用 static::class (PHP 5.5+) 或 get_class($this)。

誤區:__DIR__ 結尾有斜線。
事實:無尾隨斜線,需自行 __DIR__ . '/config.php'。

誤區:魔術常量可用 defined() 檢查。
事實:defined('__CLASS__') 永遠回傳 false,它們非 define() 定義。

結語

魔術常量是 PHP 靜態資訊的「編譯期快照」,零成本、高可靠。掌握 __CLASS__/__METHOD__/__DIR__ 三大核心,搭配 static::class 處理繼承多態,即可覆蓋 95% 除錯與日誌需求。將本文測試代碼存為專案 tests/MagicConstantsTest.php,新成員跑一次即可建立直覺。

copyright © 萬盛學電腦網 all rights reserved