Support collect swagger validation rules and attribute for mediaType …

…request body. (#6380)
hyperf · Dec 14, 2023 · 2776915 · 2776915
1 parent e3e7f2c
commit 2776915
Show file tree

Hide file tree

Showing 7 changed files with 294 additions and 112 deletions.
diff --git a/composer.json b/composer.json
@@ -25,6 +25,11 @@
             "Hyperf\\Swagger\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "HyperfTest\\Swagger\\": "tests/"
+        }
+    },
     "suggest": {
         "hyperf/validation": "Required to use SwaggerRequest."
     },

diff --git a/src/Request/AttributeCollector.php b/src/Request/AttributeCollector.php
diff --git a/src/Request/RuleCollector.php b/src/Request/RuleCollector.php
@@ -11,49 +11,13 @@
  */
 namespace Hyperf\Swagger\Request;
 
-use Hyperf\Di\Annotation\AnnotationCollector;
-use Hyperf\Swagger\Annotation\JsonContent;
-use Hyperf\Swagger\Annotation\Property;
-use Hyperf\Swagger\Annotation\QueryParameter;
-use Hyperf\Swagger\Annotation\RequestBody;
-use Hyperf\Swagger\Util;
-
+/**
+ * @deprecated will remove, please use Hyperf\Swagger\Request\ValidationCollector instead
+ */
 class RuleCollector
 {
-    protected static $rules = [];
-
     public static function get(string $class, string $method): array
     {
-        if (! empty(static::$rules[$class][$method])) {
-            return static::$rules[$class][$method];
-        }
-        $methodAnnotations = AnnotationCollector::getClassMethodAnnotation($class, $method);
-        /** @var QueryParameter[] $queryParameters */
-        $queryParameters = Util::findAnnotations($methodAnnotations, QueryParameter::class);
-
-        $rules = [];
-        foreach ($queryParameters as $parameter) {
-            if ($parameter->rules) {
-                $rules[$parameter->name] = $parameter->rules;
-            }
-        }
-
-        /** @var RequestBody $body */
-        $body = Util::findAnnotations($methodAnnotations, RequestBody::class)[0] ?? null;
-        if ($body) {
-            if ($body->_content instanceof JsonContent) {
-                if (is_array($body->_content->properties)) {
-                    foreach ($body->_content->properties as $property) {
-                        if ($property instanceof Property) {
-                            if ($property->rules) {
-                                $rules[$property->property] = $property->rules;
-                            }
-                        }
-                    }
-                }
-            }
-        }
-
-        return static::$rules[$class][$method] = $rules;
+        return ValidationCollector::get($class, $method, 'rules');
     }
 }
diff --git a/src/Request/SwaggerRequest.php b/src/Request/SwaggerRequest.php
@@ -31,21 +31,19 @@ public function authorize(): bool
      */
     public function rules(): array
     {
-        /** @var Dispatched $dispatched */
-        $dispatched = RequestContext::getOrNull()?->getAttribute(Dispatched::class);
-        if (! $dispatched) {
-            throw new RuntimeException('The request is invalid.');
-        }
+        $callback = $this->getCallbackByContext();
 
-        $callback = $dispatched->handler?->callback;
-        if (! $callback || ! is_array($callback)) {
-            throw new RuntimeException('The SwaggerRequest is only used by swagger annotations.');
-        }
-
-        return RuleCollector::get($callback[0], $callback[1]);
+        return ValidationCollector::get($callback[0], $callback[1], 'rules');
     }
 
     public function attributes(): array
+    {
+        $callback = $this->getCallbackByContext();
+
+        return ValidationCollector::get($callback[0], $callback[1], 'attribute');
+    }
+
+    protected function getCallbackByContext(): array
     {
         /** @var Dispatched $dispatched */
         $dispatched = RequestContext::getOrNull()?->getAttribute(Dispatched::class);
@@ -54,10 +52,31 @@ public function attributes(): array
         }
 
         $callback = $dispatched->handler?->callback;
-        if (! $callback || ! is_array($callback)) {
+        if (! $callback) {
             throw new RuntimeException('The SwaggerRequest is only used by swagger annotations.');
         }
 
-        return AttributeCollector::get($callback[0], $callback[1]);
+        return $this->prepareHandler($callback);
+    }
+
+    /**
+     * @see \Hyperf\HttpServer\CoreMiddleware::prepareHandler()
+     */
+    protected function prepareHandler(array|string $handler): array
+    {
+        if (is_string($handler)) {
+            if (str_contains($handler, '@')) {
+                return explode('@', $handler);
+            }
+            $array = explode('::', $handler);
+            if (! isset($array[1]) && class_exists($handler) && method_exists($handler, '__invoke')) {
+                $array[1] = '__invoke';
+            }
+            return [$array[0], $array[1] ?? null];
+        }
+        if (is_array($handler) && isset($handler[0], $handler[1])) {
+            return $handler;
+        }
+        throw new RuntimeException('Handler not exist.');
     }
 }
diff --git a/src/Request/ValidationCollector.php b/src/Request/ValidationCollector.php
@@ -0,0 +1,111 @@
+<?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\Swagger\Request;
+
+use Hyperf\Di\Annotation\AnnotationCollector;
+use Hyperf\Swagger\Annotation\JsonContent;
+use Hyperf\Swagger\Annotation\MediaType;
+use Hyperf\Swagger\Annotation\Property;
+use Hyperf\Swagger\Annotation\QueryParameter;
+use Hyperf\Swagger\Annotation\RequestBody;
+use Hyperf\Swagger\Util;
+
+class ValidationCollector
+{
+    protected static array $data = [];
+
+    /**
+     * @param string $field rules or attribute
+     */
+    public static function get(string $class, string $method, string $field): array
+    {
+        if (! empty(static::$data[$class][$method][$field])) {
+            return static::$data[$class][$method][$field];
+        }
+
+        $methodAnnotations = AnnotationCollector::getClassMethodAnnotation($class, $method);
+
+        $data = [];
+        $data = self::collectQueryParameter($methodAnnotations, $data, $field);
+        $data = self::collectJsonContentRequestBody($methodAnnotations, $data, $field);
+        $data = self::collectMediaTypeRequestBody($methodAnnotations, $data, $field);
+
+        return static::$data[$class][$method][$field] = $data;
+    }
+
+    protected static function collectQueryParameter($methodAnnotations, array $data, string $field): array
+    {
+        /** @var QueryParameter[] $queryParameters */
+        $queryParameters = Util::findAnnotations($methodAnnotations, QueryParameter::class);
+
+        foreach ($queryParameters as $parameter) {
+            if (isset($property->{$field}) && $property->{$field}) {
+                $data[$parameter->name] = $parameter->{$field};
+            }
+        }
+        return $data;
+    }
+
+    protected static function collectJsonContentRequestBody($methodAnnotations, array $data, string $field): array
+    {
+        /** @var RequestBody $body */
+        $body = Util::findAnnotations($methodAnnotations, RequestBody::class)[0] ?? null;
+        if (! $body) {
+            return $data;
+        }
+
+        if (! $body->_content instanceof JsonContent) {
+            return $data;
+        }
+
+        if (! is_array($body->_content->properties)) {
+            return $data;
+        }
+
+        foreach ($body->_content->properties as $property) {
+            if ($property instanceof Property) {
+                if (isset($property->{$field}) && $property->{$field}) {
+                    $data[$property->property] = $property->{$field};
+                }
+            }
+        }
+
+        return $data;
+    }
+
+    protected static function collectMediaTypeRequestBody($methodAnnotations, array $data, string $field): array
+    {
+        /** @var RequestBody $body */
+        $body = Util::findAnnotations($methodAnnotations, RequestBody::class)[0] ?? null;
+        if (! $body || ! is_array($body->content)) {
+            return $data;
+        }
+
+        foreach ($body->content as $content) {
+            if (! $content instanceof MediaType) {
+                continue;
+            }
+            if (! $content->schema || ! is_array($content->schema->properties)) {
+                continue;
+            }
+            foreach ($content->schema->properties as $property) {
+                if (! $property instanceof Property) {
+                    continue;
+                }
+                if (isset($property->{$field}) && $property->{$field}) {
+                    $data[$property->property] = $property->{$field};
+                }
+            }
+        }
+        return $data;
+    }
+}
diff --git a/tests/Stub/ExampleController.php b/tests/Stub/ExampleController.php
@@ -0,0 +1,61 @@
+<?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\Swagger\Stub;
+
+use Hyperf\Swagger\Annotation as SA;
+use Hyperf\Swagger\Request\SwaggerRequest;
+
+class ExampleController
+{
+    #[SA\Post('/hyperf/example/index', summary: '单测 index', tags: ['hyperf'])]
+    #[SA\QueryParameter(
+        name: 'token',
+        description: 'token',
+        example: 'token',
+        rules: 'required|string|max:25',
+    )]
+    #[SA\RequestBody(
+        description: '请求参数',
+        content: [
+            new SA\MediaType(
+                mediaType: 'application/x-www-form-urlencoded',
+                schema: new SA\Schema(
+                    properties: [
+                        new SA\Property(property: 'name', description: '昵称', type: 'string', example: 'user-2', rules: 'required|string|max:3', attribute: 'nickname'),
+                    ]
+                ),
+            ),
+        ],
+    )]
+    public function index(SwaggerRequest $request): void
+    {
+    }
+
+    #[SA\Post('/hyperf/example/json', summary: '单测 json', tags: ['hyperf'])]
+    #[SA\QueryParameter(
+        name: 'token',
+        description: 'token',
+        example: 'token',
+        rules: 'required|string|max:25',
+    )]
+    #[SA\RequestBody(
+        description: '请求参数',
+        content: new SA\JsonContent(
+            properties: [
+                new SA\Property(property: 'name', description: '昵称', type: 'string', example: 'user-2', rules: 'required|int', attribute: 'json-name'),
+            ]
+        ),
+    )]
+    public function json(SwaggerRequest $request): void
+    {
+    }
+}