caterpillar/hyperf-annotation-parse-body

v1.1.1 2023-01-29 03:04 UTC

Requires

• php: >=8.0
• hyperf/di: 3.0.*
• hyperf/framework: 3.0.*

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• jetbrains/phpstorm-attributes: ^1.0
• mockery/mockery: ^1.0
• phpstan/phpstan: ^0.12
• phpunit/phpunit: >=7.0
• swoole/ide-helper: ^4.5
• swow/swow: dev-develop
• symfony/var-dumper: ^5.1

MIT

• php
• hyperf

README

本插件利用了Aop+注解功能实现

• 环境需求

  • PHP >= 7.4
  • Hyperf >= 2.2.0
  • 请避免路由配置中使用 /user/{id} 进行参数定义
  • 暂时不支持指定数据源

• 安装项目

  composer require caterpillar/hyperf-annotation-parse-body

  • 使用项目

    • 使用方式(在方法上注解只在当前方法生效，在类上注解可在本类生效)

    <?php
    
    declare(strict_types=1);
    
    namespace xxx;
    use Caterpillar\HyperfAnnotationParseBody\Annotation\ParseBody;
    use Hyperf\HttpServer\Annotation\GetMapping;
      // 举例一个控制器
    class TestController {
    	
        #[GetMapping(path: '/testAnnotationByFunction')]
        #[ParseBody]
        public function testAnnotationFunction(TestEntity $testEntity)
        {
            return [
              'testEntity' => $testEntity->getName()
            ]
        }
    }
    
    class TestEntity {
        private string $name;
        private int $age;
        private string $birth_day;
      
        // ... getter/setter
    }

    在此示例方法中，我们可以用命令行进行请求 curl "http://127.0.0.1:9501/testAnnotationByFunction?name=1&age=2&birth_day=3" 它会自动的帮我们把参数封装到 TestEntity 中，我们可以通过 TestEntity 中的getter方法获取到请求数据

    • 使用方式2

    <?php
    
    declare(strict_types=1);
    
    namespace xxx;
    use Caterpillar\HyperfAnnotationParseBody\Annotation\ParseBody;
    use Hyperf\HttpServer\Annotation\GetMapping;
    // 举例一个控制器
    class TestController {
    	
        #[GetMapping(path: '/testAnnotationByFunction')]
        #[ParseBody]
        public function testAnnotationFunction(?string $name, ?int $age, ?$birth_day)
        {
             return [
              'name' => $name,
              'age' => $age,
              'birth_day' => $birth_day
            ]
        }
    }

    在此示例方法中， 我们可以用命令行进行请求 curl "http://127.0.0.1:9501/testAnnotationByFunction?name=1&age=2&birth_day=3" 它会自动的帮我们注入相同参数名字的变量

    • 使用方式3

    <?php
    
    declare(strict_types=1);
    
    namespace xxx;
    use Caterpillar\HyperfAnnotationParseBody\Annotation\ParseBody;
    use Hyperf\HttpServer\Annotation\GetMapping;
    
    // 类注解则本类均可生效
    #[ParseBody]
    class TestController {
    	
        #[GetMapping(path: '/testAnnotationByFunction')]
        #[ParseBody]
        public function testAnnotationFunction(UserEntity $user, ?int $id)
        {
             return [
              'user' => $user->getProperty()->getCar(),
              'age' => $age,
              'birth_day' => $birth_day
            ]
        }
    }
    
    class UserEntity {
      private int $id;
      private Property $property;
    
      // getter/setter
    }
    
    class Property {
      private bool $has_car;
      private bool $has_house;
      // getter/setter
    }

    在此示例方法中， 我们可以在请求体中使用json进行请求，请注意请求头设置Content-Type 为 application/json 他就会自动帮我们同时注入Property类

    {"id": 9, "property": { "has_car": false, "has_house": false}}