Support setting multiple annotations by inheriting AbstractMultipleAnnotation, such as @Middleware. (#3791)

Co-authored-by: assert <[email protected]>
Co-authored-by: 李铭昕 <[email protected]>

Author: assert6

src/Annotation/AbstractMultipleAnnotation.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\Di\Annotation;
+
+abstract class AbstractMultipleAnnotation extends AbstractAnnotation
+{
+    public function collectClass(string $className): void
+    {
+        $annotation = AnnotationCollector::getClassAnnotation($className, static::class);
+
+        AnnotationCollector::collectClass($className, static::class, $this->formatAnnotation($annotation));
+    }
+
+    public function collectMethod(string $className, ?string $target): void
+    {
+        $annotation = AnnotationCollector::getClassMethodAnnotation($className, $target)[static::class] ?? null;
+
+        AnnotationCollector::collectMethod($className, $target, static::class, $this->formatAnnotation($annotation));
+    }
+
+    public function collectProperty(string $className, ?string $target): void
+    {
+        $annotation = AnnotationCollector::getClassPropertyAnnotation($className, $target)[static::class] ?? null;
+
+        AnnotationCollector::collectProperty($className, $target, static::class, $this->formatAnnotation($annotation));
+    }
+
+    protected function formatAnnotation(?MultipleAnnotation $annotation): MultipleAnnotation
+    {
+        if ($annotation instanceof MultipleAnnotation) {
+            return $annotation->insert($this);
+        }
+
+        return new MultipleAnnotation($this);
+    }
+}

src/Annotation/MultipleAnnotation.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\Di\Annotation;
+
+use Hyperf\Di\Exception\AnnotationException;
+
+class MultipleAnnotation implements MultipleAnnotationInterface
+{
+    /**
+     * @var AnnotationInterface[]
+     */
+    protected $annotations = [];
+
+    /**
+     * @var string
+     */
+    protected $className;
+
+    public function __construct(AnnotationInterface $annotation)
+    {
+        $this->annotations = [$annotation];
+        $this->className = get_class($annotation);
+    }
+
+    public function __get(string $name)
+    {
+        if (count($this->annotations) > 1) {
+            throw new AnnotationException('MultipleAnnotation[' . $this->className() . '] has more than one annotations.');
+        }
+
+        return $this->annotations[0]->{$name};
+    }
+
+    public function className(): string
+    {
+        return $this->className;
+    }
+
+    public function insert(AnnotationInterface $annotation)
+    {
+        if (! $annotation instanceof $this->className) {
+            throw new AnnotationException(get_class($annotation) . ' must instanceof ' . $this->className);
+        }
+
+        $this->annotations[] = $annotation;
+        return $this;
+    }
+
+    public function toAnnotations(): array
+    {
+        return $this->annotations;
+    }
+
+    public function collectClass(string $className): void
+    {
+        throw new AnnotationException('MultipleAnnotation[' . $this->className() . '] does not support collectClass()');
+    }
+
+    public function collectMethod(string $className, ?string $target): void
+    {
+        throw new AnnotationException('MultipleAnnotation[' . $this->className() . '] does not support collectMethod()');
+    }
+
+    public function collectProperty(string $className, ?string $target): void
+    {
+        throw new AnnotationException('MultipleAnnotation[' . $this->className() . '] does not support collectProperty()');
+    }
+}

src/Annotation/MultipleAnnotationInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\Di\Annotation;
+
+use Hyperf\Di\Exception\AnnotationException;
+
+interface MultipleAnnotationInterface extends AnnotationInterface
+{
+    public function className(): string;
+
+    /**
+     * @throws AnnotationException
+     */
+    public function insert(AnnotationInterface $annotation);
+
+    /**
+     * @return AnnotationInterface[]
+     */
+    public function toAnnotations(): array;
+}

src/Aop/ProxyManager.php

@@ -181,9 +181,9 @@ protected function retrieveAnnotations(string $annotationCollectorKey): array
         $defined = [];
         $annotations = AnnotationCollector::get($annotationCollectorKey, []);
 
-        foreach ($annotations as $k => $annotation) {
+        foreach ($annotations as $name => $annotation) {
             if (is_object($annotation)) {
-                $defined[] = $k;
+                $defined[] = $name;
             } else {
                 $defined = array_merge($defined, array_keys($annotation));
             }