Support ignoreAnnotations for Annotation Reader. (#4880)

Author: limingxinleo

src/Annotation/AnnotationReader.php

@@ -21,6 +21,10 @@
  */
 class AnnotationReader
 {
+    public function __construct(protected array $ignoreAnnotations = [])
+    {
+    }
+
     public function getClassAnnotations(ReflectionClass $class)
     {
         return $this->getAttributes($class);
@@ -83,6 +87,9 @@ public function getAttributes(\Reflector $reflection): array
         }
         $attributes = $reflection->getAttributes();
         foreach ($attributes as $attribute) {
+            if (in_array($attribute->getName(), $this->ignoreAnnotations, true)) {
+                continue;
+            }
             if (! class_exists($attribute->getName())) {
                 $className = $methodName = $propertyName = '';
                 if ($reflection instanceof ReflectionClass) {

src/Annotation/Scanner.php

@@ -98,7 +98,7 @@ public function scan(array $classMap = [], string $proxyDir = ''): array
 
         $this->deserializeCachedScanData($collectors);
 
-        $annotationReader = new AnnotationReader();
+        $annotationReader = new AnnotationReader($this->scanConfig->getIgnoreAnnotations());
 
         $paths = $this->normalizeDir($paths);
 

tests/AnnotationReaderTest.php

@@ -12,6 +12,8 @@
 namespace HyperfTest\Di;
 
 use Hyperf\Di\Annotation\AnnotationReader;
+use HyperfTest\Di\Stub\FooWithNotExistAnnotation;
+use HyperfTest\Di\Stub\IgnoreDemoAnnotation;
 use HyperfTest\Di\Stub\NotFoundAttributeTarget;
 use PHPUnit\Framework\TestCase;
 use ReflectionClass;
@@ -41,9 +43,6 @@ public function testGetNotFoundAttributesOfClass()
         }
     }
 
-    /**
-     * @requires PHP 8.0
-     */
     public function testGetNotFoundAttributesOfMethod()
     {
         $reflectionClass = new ReflectionClass(NotFoundAttributeTarget::class);
@@ -64,9 +63,6 @@ public function testGetNotFoundAttributesOfMethod()
         }
     }
 
-    /**
-     * @requires PHP 8.0
-     */
     public function testGetNotFoundAttributesOfProperty()
     {
         $reflectionClass = new ReflectionClass(NotFoundAttributeTarget::class);
@@ -86,4 +82,20 @@ public function testGetNotFoundAttributesOfProperty()
             $this->assertSame($exceptionMessage, $actual);
         }
     }
+
+    public function testIgnoreAnnotations()
+    {
+        $reader = new AnnotationReader(['NotExistAnnotation']);
+
+        $res = $reader->getClassAnnotations(new \ReflectionClass(FooWithNotExistAnnotation::class));
+
+        $this->assertSame(1, count($res));
+        $this->assertInstanceOf(IgnoreDemoAnnotation::class, $res[0]);
+
+        $reader = new AnnotationReader(['NotExistAnnotation', IgnoreDemoAnnotation::class]);
+
+        $res = $reader->getClassAnnotations(new \ReflectionClass(FooWithNotExistAnnotation::class));
+
+        $this->assertSame([], $res);
+    }
 }

tests/Stub/FooWithNotExistAnnotation.php

@@ -0,0 +1,20 @@
+<?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 HyperfTest\Di\Stub;
+
+use NotExistAnnotation;
+
+#[NotExistAnnotation]
+#[IgnoreDemoAnnotation]
+class FooWithNotExistAnnotation
+{
+}