自動生成文件

根據反射的分析類，介面，函數和方法的內部結構，方法和函數的引數，以及類的屬性和方法，可以自動生成文件。

/**
 * 學生類
 *
 * 描述資訊
 */
class Student
{
    const NORMAL = 1;
    const FORBIDDEN = 2;
    /**
     * 使用者ID
     * @var 型別
     */
    public $id;
    /**
     * 獲取id
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }
    public function setId($id = 1)
    {
        $this->id = $id;
    }
}
$ref = new ReflectionClass('Student');
$doc = $ref->getDocComment();
echo $ref->getName() . ':' . getComment($ref) , "n";
echo "屬性列表：n";
printf("%-15s%-10s%-40sn", 'Name', 'Access', 'Comment');
$attr = $ref->getProperties();
foreach ($attr as $row) {
    printf("%-15s%-10s%-40sn", $row->getName(), getAccess($row), getComment($row));
}
echo "常數列表：n";
printf("%-15s%-10sn", 'Name', 'Value');
$const = $ref->getConstants();
foreach ($const as $key => $val) {
    printf("%-15s%-10sn", $key, $val);
}
echo "nn";
echo "方法列表n";
printf("%-15s%-10s%-30s%-40sn", 'Name', 'Access', 'Params', 'Comment');
$methods = $ref->getMethods();
foreach ($methods as $row) {
    printf("%-15s%-10s%-30s%-40sn", $row->getName(), getAccess($row), getParams($row), getComment($row));
}
// 獲取許可權
function getAccess($method)
{
    if ($method->isPublic()) {
        return 'Public';
    }
    if ($method->isProtected()) {
        return 'Protected';
    }
    if ($method->isPrivate()) {
        return 'Private';
    }
}
// 獲取方法引數資訊
function getParams($method)
{
    $str = '';
    $parameters = $method->getParameters();
    foreach ($parameters as $row) {
        $str .= $row->getName() . ',';
        if ($row->isDefaultValueAvailable()) {
            $str .= "Default: {$row->getDefaultValue()}";
        }
    }
    return $str ? $str : '';
}
// 獲取注釋
function getComment($var)
{
    $comment = $var->getDocComment();
    // 簡單的獲取了第一行的資訊，這裡可以自行擴充套件
    preg_match('/* (.*) *?/', $comment, $res);
    return isset($res[1]) ? $res[1] : '';
}

執行 php file.php 就可以看到相應的文件資訊。

實現 MVC 架構

現在好多框架都是 MVC 的架構，根據路由資訊定位控制器($controller) 和方法($method) 的名稱，之後使用反射實現自動呼叫。

$class = new ReflectionClass(ucfirst($controller) . 'Controller');
$controller = $class->newInstance();
if ($class->hasMethod($method)) {
    $method = $class->getMethod($method);
    $method->invokeArgs($controller, $arguments);
} else {
    throw new Exception("{$controller} controller method {$method} not exists!");
}

實現單元測試

一般情況下我們會對函數和類進行測試，判斷其是否能夠按我們預期返回結果，我們可以用反射實現一個簡單通用的類測試用例。

class Calc
{
    public function plus($a, $b)
    {
        return $a + $b;
    }
    public function minus($a, $b)
    {
        return $a - $b;
    }
}
function testEqual($method, $assert, $data)
{
    $arr = explode('@', $method);
    $class = $arr[0];
    $method = $arr[1];
    $ref = new ReflectionClass($class);
    if ($ref->hasMethod($method)) {
        $method = $ref->getMethod($method);
        $res = $method->invokeArgs(new $class, $data);
        var_dump($res === $assert);
    }
}
testEqual('[email protected]', 3, [1, 2]);
testEqual('[email protected]', -1, [1, 2]);

這是類的測試方法，也可以利用反射實現函數的測試方法。
這裡只是我簡單寫的一個測試用例，PHPUnit 單元測試框架很大程度上依賴了 Reflection 的特性，可以了解下。

配合 DI 容器解決依賴

Laravel 等許多框架都是使用 Reflection 解決依賴注入問題，具體可檢視 Laravel 原始碼進行分析。
下面我們程式碼簡單實現一個 DI 容器演示 Reflection 解決依賴注入問題。

class DI
{
    protected static $data = [];
    public function __set($k, $v)
    {
        self::$data[$k] = $v;
    }
    public function __get($k)
    {
        return $this->bulid(self::$data[$k]);
    }
    // 獲取範例
    public function bulid($className)
    {
        // 如果是匿名函數，直接執行，並返回結果
        if ($className instanceof Closure) {
            return $className($this);
        }
        
        // 已經是範例化物件的話，直接返回
        if(is_object($className)) {
            return $className;
        }
        // 如果是類的話，使用反射載入
        $ref = new ReflectionClass($className);
        // 監測類是否可範例化
        if (!$ref->isInstantiable()) {
            throw new Exception('class' . $className . ' not find');
        }
        // 獲取建構函式
        $construtor = $ref->getConstructor();
        // 無建構函式，直接範例化返回
        if (is_null($construtor)) {
            return new $className;
        }
        // 獲取建構函式引數
        $params = $construtor->getParameters();
        // 解解構造函數
        $dependencies = $this->getDependecies($params);
        // 建立新範例
        return $ref->newInstanceArgs($dependencies);
    }
    // 分析引數，如果引數中出現依賴類，遞回範例化
    public function getDependecies($params)
    {
        $data = [];
        foreach($params as $param)
        {
            $tmp = $param->getClass();
            if (is_null($tmp)) {
                $data[] = $this->setDefault($param);
            } else {
                $data[] = $this->bulid($tmp->name);
            }
        }
        return $data;
    }
    
    // 設定預設值
    public function setDefault($param)
    {
        if ($param->isDefaultValueAvailable()) {
            return $param->getDefaultValue();
        }
        throw new Exception('no default value!');
    }
}
class Demo
{
    public function __construct(Calc $calc)
    {
        echo $calc->plus(1, 2);
    }
}
$di = new DI();
$di->calc = 'Calc'; // 載入單元測試用例中 Calc 類
$di->demo = 'Demo';
$di->demo;

注意上面的 calc 和 demo 的順序，不能顛倒，不然的話會報錯，原因是由於 Demo 依賴 Calc，首先要定義依賴關係。
在 Demo 範例化的時候，會用到 Calc 類，也就是說 Demo 依賴於 Calc，但是在 $data 上面找不到的話，會丟擲錯誤，所以首先要定義 $di->calc = 'Calc'。

Reflection 是一個非常 Cool 的功能，使用它，但不要濫用它。

End

堅持原創技術分享，您的支援將鼓勵我繼續

推薦教學：《php教學》

詳解PHP的反射使用

自動生成文件

實現 MVC 架構

實現單元測試

配合 DI 容器解決依賴