PHP 原生枚举深度支持 (#646)

* beans 配置注入支持枚举 * InEnum 验证器支持原生枚举 * 修复 * 修复 * 修复一个类有多个Bean名称时，beans 注入的属性值不正确 * 完善测试 * 修复 * 修复
imiphp · Nov 14, 2023 · ba917f2 · ba917f2
1 parent 62c9d6f
commit ba917f2
Show file tree

Hide file tree

Showing 14 changed files with 397 additions and 50 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -49,4 +49,14 @@ parameters:
             message: '#(Extending|Creating new|Calling) \S+ is not covered by backward compatibility promise\. The (class|method) might change in a minor PHPStan version\.#'
             paths:
                 - dev/PHPStan/FileFinder.php
+        - '#Class UnitEnum not found#'
+        - '#Class BackedEnum not found#'
+        - '#Call to static method .+\(\) on an unknown class (Backed|Unit)Enum#'
+        - '#Method Imi\\Util\\EnumUtil::.+\(\) has invalid return type (Backed|Unit)Enum#'
+        - '#unknown class Imi\\Test\\Component\\Bean\\EnumBean#'
+        - '#unknown class Imi\\Test\\Component\\Enum\\TestEnumBean#'
+        - '#unknown class Imi\\Test\\Component\\Enum\\TestEnumBeanBacked#'
+        - '#Class Imi\\Test\\Component\\Bean\\EnumBean not found#'
+        - '#Class Imi\\Test\\Component\\Enum\\TestEnumBean not found#'
+        - '#Class Imi\\Test\\Component\\Enum\\TestEnumBeanBacked not found#'
 services:
diff --git a/src/Bean/BeanFactory.php b/src/Bean/BeanFactory.php
@@ -38,8 +38,23 @@ class BeanFactory
      */
     public static function newInstance(string $class, ...$args)
     {
-        $object = self::newInstanceNoInit($class, ...$args);
-        static::initInstance($object, $args);
+        return static::newBeanInstance($class, null, ...$args);
+    }
+
+    /**
+     * 实例化.
+     *
+     * @template T
+     *
+     * @param class-string<T> $class
+     * @param mixed           ...$args
+     *
+     * @return T
+     */
+    public static function newBeanInstance(string $class, ?string $beanName = null, ...$args)
+    {
+        $object = static::newInstanceNoInit($class, ...$args);
+        static::initInstance($object, $args, $beanName);
 
         return $object;
     }
@@ -63,7 +78,7 @@ public static function newInstanceNoInit(string $class, ...$args)
         }
         else
         {
-            if (self::$enableFileCache)
+            if (static::$enableFileCache)
             {
                 static::parseEvalName($class, $fileName, $className);
                 if (is_file($fileName))
@@ -102,8 +117,22 @@ public static function newInstanceNoInit(string $class, ...$args)
      */
     public static function newInstanceEx(string $class, array $args = [])
     {
-        $object = self::newInstanceExNoInit($class, $args, $resultArgs);
-        static::initInstance($object, $resultArgs);
+        return static::newBeanInstanceEx($class, null, $args);
+    }
+
+    /**
+     * 增强实例化.
+     *
+     * @template T
+     *
+     * @param class-string<T> $class
+     *
+     * @return T
+     */
+    public static function newBeanInstanceEx(string $class, ?string $beanName = null, array $args = [])
+    {
+        $object = static::newInstanceExNoInit($class, $args, $resultArgs);
+        static::initInstance($object, $resultArgs, $beanName);
 
         return $object;
     }
@@ -137,16 +166,16 @@ public static function newInstanceExNoInit(string $class, array $args, ?array &$
             }
         }
 
-        return self::newInstanceNoInit($class, ...$resultArgs);
+        return static::newInstanceNoInit($class, ...$resultArgs);
     }
 
     /**
      * 初始化Bean对象
      */
-    public static function initInstance(object $object, array $args = []): void
+    public static function initInstance(object $object, array $args = [], ?string $beanName = null): void
     {
-        $class = self::getObjectClass($object);
-        BeanProxy::injectProps($object, $class);
+        $class = static::getObjectClass($object);
+        BeanProxy::injectProps($object, $class, false, $beanName);
         $ref = ReflectionContainer::getClassReflection($class);
         if ($ref->hasMethod('__init'))
         {

diff --git a/src/Bean/BeanProxy.php b/src/Bean/BeanProxy.php
@@ -17,6 +17,7 @@
 use Imi\Aop\JoinPoint;
 use Imi\Aop\Model\AopItem;
 use Imi\Config;
+use Imi\Util\EnumUtil;
 use Imi\Util\Imi;
 
 class BeanProxy
@@ -137,9 +138,9 @@ public static function &call(object $object, string $className, string $method,
     /**
      * 注入属性.
      */
-    public static function injectProps(object $object, string $className, bool $reInit = false): void
+    public static function injectProps(object $object, string $className, bool $reInit = false, ?string $beanName = null): void
     {
-        [$injects, $configs] = static::getInjects($className);
+        [$injects, $configs] = static::getInjects($className, $beanName);
         if (!$injects && !$configs)
         {
             return;
@@ -171,6 +172,44 @@ public static function injectProps(object $object, string $className, bool $reIn
             {
                 $propRef = $refClass->getProperty($name);
                 $propRef->setAccessible(true);
+                if ($propRef->hasType())
+                {
+                    $type = $propRef->getType();
+                    foreach ((static function () use ($type) {
+                        if ($type instanceof \ReflectionNamedType)
+                        {
+                            if (is_subclass_of($typeName = $type->getName(), \UnitEnum::class))
+                            {
+                                yield $typeName;
+                            }
+                        }
+                        elseif ($type instanceof \ReflectionUnionType)
+                        {
+                            foreach ($type->getTypes() as $type)
+                            {
+                                if (is_subclass_of($typeName = $type->getName(), \UnitEnum::class))
+                                {
+                                    yield $typeName;
+                                }
+                            }
+                        }
+                    })() as $enumType)
+                    {
+                        if (is_subclass_of($enumType, \BackedEnum::class))
+                        {
+                            $case = $enumType::tryFrom($value);
+                        }
+                        else
+                        {
+                            $case = EnumUtil::tryFromName($enumType, $value);
+                        }
+                        if ($case)
+                        {
+                            $value = $case;
+                            break;
+                        }
+                    }
+                }
                 $propRef->setValue($object, $value);
             }
         }
@@ -179,37 +218,54 @@ public static function injectProps(object $object, string $className, bool $reIn
     /**
      * 获取注入属性的配置们.
      */
-    public static function getConfigInjects(string $className): array
+    public static function getConfigInjects(string $className, ?string $beanName = null): array
     {
-        // 配置文件注入
-        $beanData = BeanManager::get($className);
-        if ($beanData)
+        $originBeanName = $beanName;
+        $count = 2;
+        while ($count--)
         {
-            $beanName = $beanData['beanName'];
-        }
-        else
-        {
-            $beanName = $className;
-        }
-        $beans = Config::get('@currentServer.beans');
-        if (isset($beans[$beanName]))
-        {
-            return $beans[$beanName];
-        }
-        elseif ($beanName !== $className && isset($beans[$className]))
-        {
-            return $beans[$className];
-        }
-        else
-        {
-            $beans = Config::get('@app.beans');
-            if (isset($beans[$beanName]))
+            // 配置文件注入
+            if (null === $beanName)
+            {
+                $beanData = BeanManager::get($className);
+                if ($beanData)
+                {
+                    $beanName = $beanData['beanName'];
+                }
+                else
+                {
+                    $beanName = $className;
+                }
+            }
+            $serverBeans ??= Config::get('@currentServer.beans');
+            if (isset($serverBeans[$beanName]))
+            {
+                return $serverBeans[$beanName];
+            }
+            elseif ($beanName !== $className && isset($serverBeans[$className]))
             {
-                return $beans[$beanName];
+                return $serverBeans[$className];
             }
-            elseif ($beanName !== $className && isset($beans[$className]))
+            else
+            {
+                $appBeans ??= Config::get('@app.beans');
+                if (isset($appBeans[$beanName]))
+                {
+                    return $appBeans[$beanName];
+                }
+                elseif ($beanName !== $className && isset($appBeans[$className]))
+                {
+                    return $appBeans[$className];
+                }
+            }
+            if (null === $originBeanName)
+            {
+                break;
+            }
+            else
             {
-                return $beans[$className];
+                // 下次循环会根据类名尝试获取注入配置
+                $beanName = null;
             }
         }
 
@@ -221,9 +277,9 @@ public static function getConfigInjects(string $className): array
      *
      * 返回：[$annotations, $configs]
      */
-    public static function getInjects(string $className): array
+    public static function getInjects(string $className, ?string $beanName = null): array
     {
-        $configs = static::getConfigInjects($className);
+        $configs = static::getConfigInjects($className, $beanName);
         $injects = BeanManager::getPropertyInjects($className);
         if ($configs && $injects)
         {
@@ -318,9 +374,9 @@ private static function doAspect(string $className, string $method, string $poin
      *
      * @return mixed
      */
-    public static function getInjectValue(string $className, string $propertyName)
+    public static function getInjectValue(string $className, string $propertyName, ?string $beanName = null)
     {
-        [$annotations, $configs] = static::getInjects($className);
+        [$annotations, $configs] = static::getInjects($className, $beanName);
         if (isset($configs[$propertyName]))
         {
             return $configs[$propertyName];

diff --git a/src/Bean/Container.php b/src/Bean/Container.php
@@ -171,7 +171,7 @@ private function __newInstance(string $id, array $params, bool $allowStore)
         if ($data['recursion'] ?? true)
         {
             // @phpstan-ignore-next-line
-            BeanFactory::initInstance($object, $params);
+            BeanFactory::initInstance($object, $params, $originId);
             if ($stored && $object !== $beanObjects[$originId])
             {
                 // 防止类 __init() 方法有协程上下文切换，导致单例被覆盖

diff --git a/src/Components/grpc/composer.json b/src/Components/grpc/composer.json
@@ -8,7 +8,9 @@
         "yurunsoft/yurun-http": "^4.0.0",
         "google/protobuf": "^3.10.0"
     },
-    "require-dev": {},
+    "require-dev": {
+        "psr/http-message": "~1.0"
+    },
     "autoload": {
         "psr-4": {
             "Imi\\Grpc\\": "src/",

diff --git a/src/Util/EnumUtil.php b/src/Util/EnumUtil.php
@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Imi\Util;
+
+use Imi\Util\Traits\TStaticClass;
+
+if (\PHP_VERSION_ID >= 80100)
+{
+    class EnumUtil
+    {
+        use TStaticClass;
+
+        public static function fromName(string $enum, string $case): \UnitEnum
+        {
+            $result = static::tryFromName($enum, $case);
+            if ($result)
+            {
+                return $result;
+            }
+            throw new \ValueError('"' . $case . '" is not a valid name for enum "' . static::class . '"');
+        }
+
+        public static function tryFromName(string $enum, string $case): ?\UnitEnum
+        {
+            foreach ($enum::cases() as $c)
+            {
+                if ($c->name === $case)
+                {
+                    return $c;
+                }
+            }
+
+            return null;
+        }
+
+        /**
+         * @param mixed $value
+         */
+        public static function in(string $enum, $value): bool
+        {
+            foreach ($enum::cases() as $case)
+            {
+                if ($case === $value || ($case->value ?? $case->name) === $value)
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+    }
+}
diff --git a/src/Validate/ValidatorHelper.php b/src/Validate/ValidatorHelper.php
@@ -4,7 +4,7 @@
 
 namespace Imi\Validate;
 
-use Imi\Enum\BaseEnum;
+use Imi\Util\EnumUtil;
 
 /**
  * 验证器工具类.
@@ -404,23 +404,28 @@ public static function notIn($value, $list): bool
     /**
      * 值在枚举值范围内.
      *
-     * @param mixed                  $value
-     * @param class-string<BaseEnum> $enumClass
+     * @param mixed $value
      */
     public static function inEnum($value, string $enumClass): bool
     {
-        return \in_array($value, $enumClass::getValues());
+        if (is_subclass_of($enumClass, \UnitEnum::class))
+        {
+            return EnumUtil::in($enumClass, $value);
+        }
+        else
+        {
+            return \in_array($value, $enumClass::getValues());
+        }
     }
 
     /**
      * 值不在枚举值范围内.
      *
-     * @param mixed                  $value
-     * @param class-string<BaseEnum> $enumClass
+     * @param mixed $value
      */
     public static function notInEnum($value, string $enumClass): bool
     {
-        return !\in_array($value, $enumClass::getValues());
+        return !static::inEnum($value, $enumClass);
     }
 
     /**