README

注意：此库在 1.0 版本发布之前不应被视为生产就绪。请提供您的反馈使其成为现实！

为什么？

Symfony 表单组件是处理表单的一个非常强大的工具。但如今情况已经改变。复杂的表单大多在客户端处理。至于简单的表单，symfony/forms 有非常大的开销。

在某些情况下，您甚至没有表单。例如，如果您正在开发 HTTP API，您可能只需要与请求体交互。那么为什么不让请求体封装在一个用户定义的对象中，并仅验证它呢？这也鼓励了关注点的分离，并有助于您处理 API 版本控制。

用法

首先，我们需要通过 composer 安装此包

composer require fesor/request-objects

并注册捆绑包

    public function registerBundles()
    {
        $bundles = [
            // ...
            new \Fesor\RequestObject\Bundle\RequestObjectBundle(),
        ];
    }

捆绑包不需要任何额外的配置，但您也可以在捆绑包配置中指定错误响应提供者服务。我们将在“处理验证错误”部分回到这个问题。

定义您的请求对象

所有用户定义的请求都应扩展 Fesor\RequestObject\RequestObject。让我们为用户注册动作创建一个简单的请求对象

use Fesor\RequestObject\RequestObject;
use Symfony\Component\Validator\Constraints as Assert;

class RegisterUserRequest extends RequestObject
{
    public function rules()
    {
        return new Assert\Collection([
            'email' => new Assert\Email(['message' => 'Please fill in valid email']),
            'password' => new Assert\Length(['min' => 4, 'minMessage' => 'Password is to short']),
            'first_name' => new Assert\NotNull(['message' => 'Please provide your first name']),
            'last_name' => new Assert\NotNull(['message' => 'Please provide your last name'])
        ]);
    }
}

之后我们就可以在我们的动作中使用它了

public function registerUserAction(RegisterUserRequest $request)
{
    // Do Stuff! Data is already validated!
}

此捆绑包会将验证后的请求对象绑定到 $request 参数。请求对象具有非常简单的数据交互接口。它与 Symfony 的请求对象非常相似，但默认情况下被认为是不可变的（尽管如果您愿意，也可以添加一些设置器）

// returns value from payload by specific key or default value if provided
$request->get('key', 'default value');

// returns whole payload
$request->all();

有效载荷从何而来？

此库默认实现了 PayloadResolver 接口，其行为如下

如果请求可以有一个体（即它是 POST、PUT、PATCH 或任何具有体的请求），则它使用 $request->request->all() 和 $request->files->all() 数组的并集作为有效载荷。
如果请求不能有一个体（即 GET、HEAD 动词），则它使用 $request->query->all()。

如果您希望应用自定义的有效载荷提取逻辑，您可以在请求对象中实现 PayloadResolver 接口。

class CustomizedPayloadRequest extends RequestObject implements PayloadResolver
{
    public function resolvePayload(Request $request)
    {
        $query = $request->query->all();
        // turn string to array of relations
        if (isset($query['includes'])) {
            $query['includes'] = explode(',', $query['includes']);
        }

        return $query;
    }
}

这将允许您对请求进行一些疯狂的操作，并使许多事情保持DRY。

验证有效载荷

如前例所示，rules 方法应返回用于 symfony 验证器的验证规则。您的请求有效载荷将与此进行验证，并在您的动作中获得有效数据。

如果您有一些依赖于有效载荷数据的验证规则，则可以通过验证组来处理。

请注意：由于 Collection 约束验证器的限制，使用组不太方便。因此，建议在需要依赖于有效载荷数据的复杂情况下使用 Callback 验证器。有关问题的详细信息，请参阅示例。

您可以通过实现 validationGroup 方法来提供验证组

public function validationGroup(array $payload)
{
    return isset($payload['context']) ?
        ['Default', $payload['context']] : null;
}

处理验证错误

如果验证数据无效，库将抛出异常，该异常将包含验证错误和请求对象。

但如果您不希望通过 kernel.exception 监听器来处理它，您有几个选择。

首先，使用控制器操作来处理错误

public function registerUserAction(RegisterUserRequest $request, ConstraintViolationList $errors)
{
    if (0 !== count($errors)) {
        // handle errors
    }
}

但这并不方便，如果你只需要返回通用的错误响应，就会破坏DRY原则。这就是为什么库为你提供了ErrorResponseProvider接口。你可以在请求对象中实现它，并将此代码移动到getErrorResponse方法

public function getErrorResponse(ConstraintViolationListInterface $errors)
{
    return new JsonResponse([
        'message' => 'Please check your data',
        'errors' => array_map(function (ConstraintViolation $violation) {

            return [
                'path' => $violation->getPropertyPath(),
                'message' => $violation->getMessage()
            ];
        }, iterator_to_array($errors))
    ], 400);
}

贡献

请随时提供反馈和功能请求或发布问题。PR（Pull Request）受到欢迎！

nowiko / request-objects

维护者

详细信息