今天看到Swoft实现了注解引入依赖容器的效果，然后查了下原来这个Swoole框架的作者是Java出身的，怪不得有这功能。

然后想了下其实这功能挺强大的，我们用原生PHP也来实现下。

PHP的注解读取，依赖ReflectionClass反射类，不懂的朋友先去学下。

具体的实现流程分为：

  1. App.php 应用载入器
  2. Annotate.php 容器注入类
  3. DocParser.php 注解解析类
  5. 若干个应用类
  6. ...

下面的示例中，我们把助手类都统一放置在vendor目录下。

话不多说，具体的上代码，vendor/App.php应用载入器，该类主要实现跟MVC框架一样，加载指定的Controller/Action：

  1. class App {
  2.     public static function run($class, $function, ...$args) {
  3.         // 基于反射类实例化
  4.         $obj = new Annotate();
  5.         $obj->run($class, $function, ...$args);
  6.     }
  7. }

vendor/Annotate.php容器注入类，该类主要实现根据指定的Controller/Action，调用反射类获取注解内容并实例化对应的对象和方法：

  1. class Annotate {
  2.     private $Reflection;
  3.     private $instance;
  4.     private $method;
  6.     /**
  7.      * 启动注解解析
  8.      * @todo 无
  9.      * @author 小黄牛
  10.      * @version v1.0.1 + 2020.05.25
  11.      * @deprecated 暂不启用
  12.      * @global 无
  13.      * @param string $class 对应的控制器
  14.      * @param mixed $action 对应的操作
  15.      * @param array $args 操作的参数
  16.      * @return void
  17.     */
  18.     public function run($class, $action, ...$args) {
  19.         if (!class_exists($class)) die('该类不存在');
  21.         # 反射方法
  22.         $method = new \ReflectionMethod($class, $action);
  24.         # 不是公共方法，不给执行
  25.         if (!$method->isPublic()) {
  26.             die("{$class}::{$action}不是public方法");
  27.         }
  29.         # 使用ReflectionClass类
  30.         $this->Reflection = new \ReflectionClass($class);
  32.         # 解析注解
  33.         $doc = DocParserFactory::getInstance()->parse($this->getClass());
  35.         # 通过反射类进行实例化
  36.         $this->instance = $this->Reflection->newInstance();
  37.         # 获取方法的实例-但未执行
  38.         $this->method = $this->Reflection->getmethod($action);
  40.         # 注入全局容器
  41.         $this->Ioc($doc);
  43.         # 局部的注解
  44.         $doc = DocParserFactory::getInstance()->parse($this->getFunction($action));
  45.         # 注入局部容器
  46.         $this->Ioc($doc);
  48.         # 调用对应的方法
  49.         $this->method->invokeArgs($this->instance, $args);
  50.     }
  52.     // 容器注入
  53.     private function Ioc($doc) {
  54.         # 解析容器注入 - 因为是Controller等于全局容器注入
  55.         foreach ($doc as $val) {
  56.             foreach ($val as $key=>$value) {
  57.                 # IOC容器注入
  58.                 if ($key == 'Ioc') {
  59.                     # 这里你可能还要检查注入的类、方法是否存在
  60.                     # name指定的属性名称是否被冲突
  62.                     $args = [];
  63.                     if (!empty($value['args'])) {
  64.                         $args = $value['args'];
  65.                     }
  67.                     $name = $value['name'];
  68.                     $reflection = new \ReflectionClass($value['class']);
  69.                     $obj = $reflection->newInstance(); 
  71.                     # 动态属性注入
  72.                     if (!$this->method->isStatic()) {
  73.                         if ($value['function']) {
  74.                             $method = $reflection->getmethod($value['function']);
  75.                             $this->instance->$name = $method->invokeArgs($obj, $args);
  76.                         } else {
  77.                             $this->instance->$name = $obj;
  78.                         }
  79.                     # 静态属性注入
  80.                     } else {
  81.                         if ($value['function']) {
  82.                             $method = $reflection->getmethod($value['function']);
  83.                             $this->Reflection->setStaticPropertyValue($name, $method->invokeArgs($obj, $args));
  84.                         } else {
  85.                             $this->Reflection->setStaticPropertyValue($name, $obj);
  86.                         }
  87.                     }
  88.                 }
  89.             }
  90.         }
  91.     }
  93.     // 获得类对应的注解
  94.     public function getClass() {
  95.         return $this->Reflection->getDocComment();
  96.     }
  98.     // 获得指定方法对应的注解
  99.     public function getFunction($action) {
  100.         # 获得成员函数名称
  101.         $methods = $this->Reflection->getMethods();
  103.         foreach ($methods as $method) {
  104.             # 只要指定方法的
  105.             if ($method->name == $action) {
  106.                 # 获得成员函数对应的注释内容
  107.                 return $method->getDocComment();
  108.             }
  109.         }
  110.         return false;
  111.     }
  112. }

vendor/DocParser.php注解解析类，该类主要用于切割注解内容，并解析出容器的注释风格，最终返回容器的调用参数数组：

  1. class DocParser {
  2.     private $params = [];
  3.     /**
  4.      * args的单引号占位符
  5.     */
  6.     private $placeholder = '%SSSSS%';
  8.     /**
  9.      * 切割注解
  10.      * @todo 无
  11.      * @author 小黄牛
  12.      * @version v1.0.1 + 2020.05.25
  13.      * @deprecated 暂不启用
  14.      * @global 无
  15.      * @param string $doc 注解
  16.      * @return array
  17.     */
  18.     public function parse($doc = '') {
  19.         // 清空单例缓存
  20.         $this->params = [];
  22.         if ($doc == '') return $this->params;
  24.         // 使用正则匹配出/***/
  25.         if (preg_match('#^/\*\*(.*)\*/#s', $doc, $comment ) === false) return $this->params;
  27.         // 获取注解
  28.         $comment = trim($comment[1]);
  30.         // 将注解按*号切割
  31.         if (preg_match_all('#^\s*\*(.*)#m', $comment, $lines ) === false) return $this->params;
  33.         // 开始解析注解
  34.         $this->parseLines($lines[1]);
  36.         return $this->params;
  37.     }
  39.     /**
  40.      * 注解按行解析
  41.      * @todo 无
  42.      * @author 小黄牛
  43.      * @version v1.0.1 + 2020.05.25
  44.      * @deprecated 暂不启用
  45.      * @global 无
  46.      * @param array $lines 注解
  47.      * @return void
  48.     */
  49.     private function parseLines($lines) {
  50.         foreach ($lines as $line) {
  51.             $doc = $this->parseLine($line);
  52.             if ($doc) $this->params[] = $doc;
  53.         }
  54.     }
  56.     /**
  57.      * 注解解析行
  58.      * @todo 无
  59.      * @author 小黄牛
  60.      * @version v1.0.1 + 2020.05.25
  61.      * @deprecated 暂不启用
  62.      * @global 无
  63.      * @param string $line 每行的注解
  64.      * @return array
  65.     */
  66.     private function parseLine($line) {
  67.         // 删除左右两侧空格
  68.         $line = trim ( $line );
  70.         if (empty($line)) return false;
  72.         $return = [];
  73.         if (strpos($line, '@') === 0) {
  74.             $string = substr($line, 1, strlen($line));
  76.             $array = explode('(', $string);
  77.             $param = $array[0];
  78.             $string = str_replace($param.'(', '', $string);
  79.             $value = substr($string, 0, strlen($string)-1);
  80.             $value = preg_replace ( "/\s(?=\s)/","\\1", $value );
  81.             $value = str_replace('" ,', '",', $value);
  83.             $value_list = explode('",', $value);
  85.             foreach ($value_list as $v) {
  86.                 $length = strpos($v, '=');
  87.                 $key = trim(substr($v, 0, $length));
  88.                 $val = str_replace('"', '', trim(substr($v, $length+1, strlen($v))));
  90.                 # 参数要特殊处理
  91.                 if ($key == 'args') {
  92.                     $val = $this->parseArgs($val);
  93.                 }
  94.                 $return[$param][$key] = $val;
  95.             }
  97.             return $return;
  98.         }
  100.         return false;
  101.     }
  103.     /**
  104.      * 特殊处理传递的参数
  105.      * @todo 无
  106.      * @author 小黄牛
  107.      * @version v1.0.1 + 2020.05.12
  108.      * @deprecated 暂不启用
  109.      * @global 无
  110.      * @param string $val 参数
  111.      * @return array
  112.     */
  113.     private function parseArgs($val) {
  114.         # 提取单引号里的内容
  115.         preg_match_all('/([\'"])([^\'"\.]*?)\1/',$val, $match);
  116.         $list = $match[2];
  117.         foreach ($list as $v) {
  118.             # 加上单引号
  119.             $v = "'".$v."'";
  120.             # 植入占位符
  121.             $string = str_replace(",", $this->placeholder, $v);
  122.             # 替换内容
  123.             $val = str_replace($v, $string, $val);
  124.         }
  125.         # 切割参数
  126.         $param = explode(',', $val);
  127.         # 把占位符取消掉
  128.         foreach ($param as $k=>$v) {
  129.             $param[$k] = str_replace($this->placeholder, ",", $v);
  130.         }
  132.         return $param;
  133.     }
  135. }
  136. class DocParserFactory{
  138.     private static $p;
  139.     private function __construct(){
  140.     }
  142.     public static function getInstance(){
  143.         if(self::$p == null){
  144.             self::$p = new DocParser ();
  145.         }
  146.         return self::$p;
  147.     }
  149. }

index.php应用类，这就不需要多说拉，就相当于Controller/Action类：

  1. /**
  2.  * 注解说明：
  3.  * @Ioc(class="类的路径，例如：\think\Db::name()", function="", name="test", args="1,2,3")  
  4.  * 容器注入：
  5.  * class=容器的地址
  6.  * function=容器的执行方法
  7.  * name=要绑定的成员属性名称
  8.  * args=需要传入function的参数
  9. */
  11. require_once 'vendor/App.php'; // 应用类
  12. require_once 'vendor/Annotate.php'; // 注解类
  13. require_once 'vendor/DocParser.php'; // 注解解析类
  15. echo '<pre>';
  16. // 启动应用加载
  17. App::run('Test', 'A', '小黄牛', '真帅~');
  19. /**
  20.  * 假设我是一个 静态的Test控制器
  21.  * 静态的容器注入，需要提前声明被注入的成员属性，并且需要是public类型的，否则无法注入
  22.  * @Ioc(class="Demo", name="all")
  23. */
  24. class Test {
  25.     /**
  26.      * 全局容器
  27.     */
  28.     public static $all;
  30.     /**
  31.      * 局部容器
  32.     */
  33.     public static $local;
  35.     /**
  36.      * 尼妹的函数
  37.      * @Ioc(class="Demo", name="local", function="_echo", args="'1,1',2,'1,3,0'")
  38.      * @param string $name 打死你
  39.      * @return void
  40.     */
  41.     public static function A($a=0, $b=1) {
  42.         // 调用全局容器
  43.         var_dump(self::$all->_echo(4,5,6));
  44.         // 调用局部容器
  45.         var_dump(self::$local);
  46.         // 调用自身变量
  47.         var_dump($a, $b);
  48.     }
  49. }
  51. /**
  52.  * 假设我是一个 动态的Test2控制器
  53.  * @Ioc(class="Demo", name="all")
  54. */
  55. class Test2 {
  57.     /**
  58.      * 尼妹的函数
  59.      * @Ioc(class="Demo", name="local", function="_echo", args="'1,1',2,'1,3,0'")
  60.      * @param string $name 打死你
  61.      * @return void
  62.     */
  63.     public function A($a=0, $b=1) {
  64.         // 调用全局容器
  65.         var_dump($this->all->_echo(4,5,6));
  66.         // 调用局部容器
  67.         var_dump($this->local);
  68.         // 调用自身变量
  69.         var_dump($a, $b);
  70.     }
  71. }
  74. // 而我是需要被注入的容器
  75. class Demo {
  76.     public function _echo ($a, $b, $c) {
  77.         return [$a, $b, $c];
  78.     }
  79. }

完整案例代码：下载