php反射實現(xiàn)Ioc/Di及注解

? PHP5之后提供了完整的反射API撞羽，添加了對類阐斜、接口、函數(shù)放吩、方法和擴展進行反向工程的能力智听。此外，反射API提供了方法來取出

函數(shù)渡紫、類和方法的文檔注釋到推。

Ioc/Di大家應該都不陌生，但是對小白來說呢聽起來就挺高大上的惕澎，下面就用代碼來實現(xiàn)：

<?php
/**
 * @author gaobinzhan <gaobinzhan@gmail.com>
 */

class Foo
{
    public function getClassName()
    {
        return 'this is Foo';
    }
}

class Bar
{
    public function getClassName()
    {
        return 'this is Bar';
    }
}

class Test
{
    public function __construct(Foo $foo, Bar $bar)
    {
        var_dump($foo->getClassName());
        var_dump($bar->getClassName());
    }

    public function index(Foo $foo)
    {
        var_dump($foo->getClassName());
    }
}

// 反射Test
$reflect = new ReflectionClass(Test::class);
// 獲取是否有構(gòu)造函數(shù)
$constructor = $reflect->getConstructor();
if ($constructor) {
    // 如果存在構(gòu)造 獲取參數(shù)
    $constructorParams = $constructor->getParameters();
    // 初始化注入的參數(shù)
    $args = [];
    // 循環(huán)去判斷參數(shù)
    foreach ($constructorParams as $param) {
        // 如果為class 就進行實例化
        if ($param->getClass()) {
            $args[] = $param->getClass()->newInstance();
        } else {
            $args[] = $param->getName();
        }
    }
    // 實例化注入?yún)?shù)
    $class = $reflect->newInstanceArgs($args);
} else {
    $class = $reflect->newInstance();
}


// 假設我們要調(diào)用index方法 在此之前自己判斷下方法是否存在 我省略了
$reflectMethod = new ReflectionMethod($class, 'index');
// 判斷方法修飾符是否為public
if ($reflectMethod->isPublic()) {
    // 以下代碼同等上面
    $args = [];
    $methodParams = $reflectMethod->getParameters();
    foreach ($methodParams as $param) {
        if ($param->getClass()) {
            $args[] = $param->getClass()->newInstance();
        } else {
            $args[] = $param->getName();
        }
    }
    $reflectMethod->invokeArgs($class, $args);
}

以上就簡單的實現(xiàn)了依賴注入莉测，下面我們接著封裝一下。

Ioc.php

<?php
/**
 * @author gaobinzhan <gaobinzhan@gmail.com>
 */

class Ioc
{
    public static function getInstance($className)
    {
        $args = self::getMethodParams($className);
        return (new ReflectionClass($className))->newInstanceArgs($args);
    }

    public static function make($className, $methodName, $params = []) {

        // 獲取類的實例
        $instance = self::getInstance($className);

        // 獲取該方法所需要依賴注入的參數(shù)
        $args = self::getMethodParams($className, $methodName);

        return $instance->{$methodName}(...array_merge($args, $params));
    }

    protected static function getMethodParams($className, $methodsName = '__construct')
    {

        // 通過反射獲得該類
        $class = new ReflectionClass($className);
        $args = []; // 記錄注入的參數(shù)

        // 判斷該類是否有構(gòu)造函數(shù)
        if ($class->hasMethod($methodsName)) {
            // 構(gòu)造函數(shù)存在 進行獲取
            $construct = $class->getMethod($methodsName);

            // 獲取構(gòu)造函數(shù)的參數(shù)
            $params = $construct->getParameters();

            // 構(gòu)造函數(shù)無參數(shù) 直接返回
            if (!$params) return $args;

            // 判斷參數(shù)類型
            foreach ($params as $param) {

                // 假設參數(shù)為類
                if ($paramClass = $param->getClass()) {

                    // 獲得參數(shù)類型名稱
                    $paramClassName = $paramClass->getName();
                    // 如果注入的這個參數(shù)也是個類 就要繼續(xù)判斷是否存在構(gòu)造函數(shù)
                    $methodArgs = self::getMethodParams($paramClassName);

                    // 存入數(shù)組中
                    $args[] = (new ReflectionClass($paramClass->getName()))->newInstanceArgs($methodArgs);
                }
            }
        }
        // 返回參數(shù)
        return $args;
    }
}

以上代碼實現(xiàn)了構(gòu)造函數(shù)的依賴注入及方法的依賴注入唧喉，下面進行測試捣卤。

<?php
class Bar
{
    public function getClassName()
    {
        return 'this is Bar';
    }
}

class Test
{
    public function __construct(Foo $foo, Bar $bar)
    {
        var_dump($foo->getClassName());
        var_dump($bar->getClassName());
    }

    public function index(Foo $foo)
    {
        var_dump($foo->getClassName());
    }
}
Ioc::getInstance(Test::class);
Ioc::make(Test::class,'index');

以上呢，就簡單的通過php的反射機制實現(xiàn)了依賴注入八孝。

繼基于swoole的微服務框架出現(xiàn)董朝，注解呢就開始慢慢出現(xiàn)在我們的視角里。據(jù)說php8也加入了注解支持：

use \Support\Attributes\ListensTo;

class ProductSubscriber
{
    <<ListensTo(ProductCreated::class)>>
    public function onProductCreated(ProductCreated $event) { /* … */ }

    <<ListensTo(ProductDeleted::class)>>
    public function onProductDeleted(ProductDeleted $event) { /* … */ }
}

就類似這樣的干跛，哈哈哈子姜。

而我們現(xiàn)在的注解則是通過反射拿到注釋去做到的解析。

接下來我們?nèi)ビ脛e人寫好的組件去實現(xiàn)annotations

編寫我們的composer.json：

{
    "require": {
        "doctrine/annotations": "^1.8"
    },
    "autoload": {
        "psr-4": {
            "app\\": "app/",
            "library\\": "library/"
        }
    }
}

接下來要執(zhí)行啥楼入？哥捕？牧抽？這個你要是再不會，真的我勸你回家種地吧ＲＷ扬舒！哈哈哈鬧著玩呢！

composer install

然后我們接下來去創(chuàng)建目錄：

- app // app目錄
    - Http
        - HomeController.php
- library // 核心注解庫
    - annotation
        - Mapping
            - Controller.php
            - RequestMapping.php
        - Parser
- vendor
- composer.json
- index.php // 測試文件

php-annotation目錄

害圖片有點大凫佛。讲坎。。御蒲。衣赶。咋整。厚满。府瞄。算了，就這樣吧５夤俊Ｗ窆荨！

溫馨提示：在phpstrom里面丰榴，安裝插件PHP Annotation寫代碼會更友好盎醯恕！四濒！

創(chuàng)建library\Mapping\Controller.php

<?php
/**
 * @author gaobinzhan <gaobinzhan@gmail.com>
 */


namespace library\annotation\Mapping;


use Doctrine\Common\Annotations\Annotation\Attribute;
use Doctrine\Common\Annotations\Annotation\Attributes;
use Doctrine\Common\Annotations\Annotation\Required;
use Doctrine\Common\Annotations\Annotation\Target;

/**
 * Class Controller
 * @package library\annotation\Mapping
 * @Attributes({
 *     @Attribute("prefix", type="string"),
 * })
 * @Annotation
 * @Target("CLASS")
 */
final class Controller
{
    /**
     * @Required()
     * @var string
     */
    private $prefix = '';
    public function __construct(array $value)
    {
        if (isset($value['value'])) $this->prefix = $value['value'];
        if (isset($value['prefix'])) $this->prefix = $value['prefix'];
    }

    public function getPrefix(){
        return $this->prefix;
    }
}

@Annotation表示這是個注解類换况，讓IDE提示更加友好！

@Target表示這個注解類只能被類使用盗蟆！

@Required表示這個屬性是必須填寫的戈二！

@Attributes表示這個注解類有多少個屬性！

創(chuàng)建library\Mapping\RequestMapping.php

<?php
/**
 * @author gaobinzhan <gaobinzhan@gmail.com>
 */


namespace library\annotation\Mapping;


use Doctrine\Common\Annotations\Annotation\Required;
use Doctrine\Common\Annotations\Annotation\Target;

/**
 * Class RequestMapping
 * @package library\annotation\Mapping
 * @Annotation
 * @Attributes({
 *     @Attribute("route", type="string"),
 * })
 * @Target("METHOD")
 */
final class RequestMapping
{
    /**
     * @Required()
     */
    private $route;
    public function __construct(array $value)
    {
        if (isset($value['value'])) $this->route = $value['value'];
        if (isset($value['route'])) $this->route = $value['route'];
    }

    public function getRoute(){
        return $this->route;
    }
}

這里的代碼就不用再重復解釋了吧喳资！我偏不解釋了觉吭！哈哈哈

創(chuàng)建app\Http\HomeController.php

<?php
/**
 * @author gaobinzhan <gaobinzhan@gmail.com>
 */


namespace app\Http;


use library\annotation\Mapping\Controller;
use library\annotation\Mapping\RequestMapping;

/**
 * Class HomeController
 * @package app\Http
 * @Controller(prefix="/home")
 */
class HomeController
{
    /**
     * @RequestMapping(route="/test")
     */
    public function test(){
        echo 111;
    }
}

這里代碼沒啥解釋的。仆邓。鲜滩。

哈哈，下面來測試我們的結(jié)果节值！

index.php

<?php
/**
 * @author gaobinzhan <gaobinzhan@gmail.com>
 */

$loader = require './vendor/autoload.php';

// 獲取一個反射類
$refClass = new \ReflectionClass('\app\Http\HomeController');

// 注冊load
\Doctrine\Common\Annotations\AnnotationRegistry::registerLoader([$loader, 'loadClass']);

// new 我們的注解讀取器
$reader = new \Doctrine\Common\Annotations\AnnotationReader();

// 獲取該類上的所有注解
$classAnnotations = $reader->getClassAnnotations($refClass);

// 這是個循環(huán) 說明$classAnnotations是個數(shù)組
foreach ($classAnnotations as $annotation){
    // 因為我們定義了Controller注解類 要判斷好啊
    if ($annotation instanceof \library\annotation\Mapping\Controller){
        // 獲取我們的 prefix 這地方能看懂吧徙硅。。搞疗。
        echo $routePrefix = $annotation->getPrefix().PHP_EOL;
        // 獲取類中所有方法
        $refMethods = $refClass->getMethods();
    }

    // 進行循環(huán)
    foreach ($refMethods as $method){
        // 獲取方法上的所有注解
        $methodAnnotations = $reader->getMethodAnnotations($method);
        // 循環(huán)
        foreach ($methodAnnotations as $methodAnnotation){
            if ($methodAnnotation instanceof \library\annotation\Mapping\RequestMapping){
                // 輸出我們的route
                echo $methodAnnotation->getRoute().PHP_EOL;
            }
        }
    }
}

執(zhí)行結(jié)果：

/home
/test

之前我們不是建立了個Parser的目錄嘛闷游，可以在里面創(chuàng)建對應的解析類，然后去解析贴汪，把它們封裝一下子Ｆ晖！