proklung/annotatedparamresolverbundle
Composer 安装命令:
composer require proklung/annotatedparamresolverbundle
包简介
Symfony bundle for transform parameters of request to DTO.
README 文档
README
За основу взят https://github.com/piku235/JungiFrameworkExtraBundle и творчески доработан под личные нужды.
Например, кроме, DTO в виде stdClass поддерживаются SpatieDTO. Кое-что выпилено за ненадобностью (куки, заголовки и тому подобное).
Установка
composer require proklung/annotatedparamresolverbundle
Аннотации:
- RequestBody - Преобразует request body в аргумент контроллера (DTO).
- RequestParams - Преобразует POST параметры запроса в аргумент контроллера (DTO).
- QueryParams - Преобразует GET параметры запроса в аргумент контроллера (DTO).
Также поддерживаются аннотации PHP 8 (даже на версиях 7.2+). При использовании PHP 8 в дело пойдет нативный парсер аннотаций.
Общий принцип
RequestBodyConverted - пользовательский класс, реализующий (использующий интерфейс в качестве метки)
Prokl\AnnotatedParamResolverBundle\ArgumentResolver\Contracts\UnserializableRequestInterface.
В экземпляр этого класса после всех манипуляций лягут, в зависимости от аннотации, - GET, POST параметры запроса или сконвертированный request body.
Можно использовать [https://github.com/spatie/data-transfer-object](Spatie DTO), отнаследовавшись от DataTransferObject, и реализовав интерфейс UnserializableRequestInterface.
use Prokl\AnnotatedParamResolverBundle\Annotation\RequestBody; use Prokl\AnnotatedParamResolverBundle\Examples\RequestBodyConverted; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\JsonResponse; class ExampleController extends AbstractController { /** * Параметры аннотации необязательны! * * @param RequestBodyConverted $unserialized * * @return JsonResponse $content * @RequestBody( var="unserialized", class="Prokl\AnnotatedParamResolverBundle\Examples\RequestBodyConverted", validate=true ) */ public function action( RequestBodyConverted $unserialized ): JsonResponse { return new JsonResponse(); } }
Так тоже можно (валидация по умолчанию включена):
use Prokl\AnnotatedParamResolverBundle\Annotation\RequestBody; use Prokl\AnnotatedParamResolverBundle\Examples\RequestBodyConverted; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\JsonResponse; class ExampleController extends AbstractController { /** * Параметры аннотации необязательны! * * @param RequestBodyConverted $unserialized * * @return JsonResponse $content * @RequestBody() */ public function action( RequestBodyConverted $unserialized ): JsonResponse { return new JsonResponse(); } }
Валидация
В описании класса, реализующего UnserializableRequestInterface к свойствам класса допустимо
применять любые стандартные и кастомные валидаторы Symfony.
Опция validate в аннотации управляет валидацией, вне зависимости от аннотаций свойства класса.
use Prokl\AnnotatedParamResolverBundle\ArgumentResolver\Contracts\UnserializableRequestInterface; use Spatie\DataTransferObject\DataTransferObject; use Symfony\Component\Validator\Constraints as Assert; class RequestBodyConvertedSpatie extends DataTransferObject implements UnserializableRequestInterface { /** * @var string $email * * @Assert\Length( * min=3, * minMessage="Email must be at least {{ limit }} characters long" * ) */ public $email; /** * @var integer */ public $numeric; }
proklung/annotatedparamresolverbundle 适用场景与选型建议
proklung/annotatedparamresolverbundle 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 71 次下载、GitHub Stars 达 1, 最近一次更新时间为 2021 年 04 月 20 日, 在 PHP 生态内属于活跃度较高的组件。
我们在过去多个企业项目中使用过 proklung/annotatedparamresolverbundle 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 proklung/annotatedparamresolverbundle 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
统计信息
- 总下载量: 71
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 1
- 点击次数: 10
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2021-04-20