我最近建立了一个项目，根据 https://api-platform.com/docs/core/identifiers/ 使用 api-platform 与 ramsey/uuid-doctrine 相关联.
所有基本的 CRUD 东西都可以工作，但我在 ApiFilter 上遇到了意外行为。
基本设置是这样的，我有平台对象，这些对象又包含组织，都依赖抽象类。
摘要
class AbstaractEntity
{
/**
* @var \Ramsey\Uuid\UuidInterface
*
* @ORM\Id
* @ORM\Column(type="uuid_binary_ordered_time", unique=true)
* @ORM\GeneratedValue(strategy="CUSTOM")
* @ORM\CustomIdGenerator(class="Ramsey\Uuid\Doctrine\UuidOrderedTimeGenerator")
*
* @Groups({"read", "write"})
* @ApiProperty(iri="https://schema.org/identifier")
*/
protected $id;
* The Platform to which this object belongs.
*
* @ORM\ManyToOne(targetEntity="App\Conduction\PlatformBundle\Entity\Platform")
* @ORM\JoinColumn(name="platform_id", referencedColumnName="id")
* @Groups({"read", "write"})
* @MaxDepth(1)
* @ApiProperty()
*/
protected $platform;
...
}
组织
/**
* Organisation entity
*
* @ORM\Table(
* "organisation__organisation"
* )
* @ORM\Entity
* @ORM\HasLifecycleCallbacks
* @ORM\EntityListeners({"App\Conduction\OrganisationBundle\EventListener\OrganisationListener","App\Conduction\AppBundle\EventListener\EntityListener"})
* @ApiResource(attributes={
* "normalization_context"={"groups"={"read"}, "enable_max_depth"="true"},
* "denormalization_context"={"groups"={"write"}}
* })
* @ApiFilter(SearchFilter::class, properties={"id": "exact", "description": "partial", "name": "partial","organisation": "exact","platform": "exact"})
* @ApiFilter(DateFilter::class, properties={"dateCreated","datePublished","dateModified","dateDeleted"})
* @ApiFilter(OrderFilter::class, properties={"id", "name","dateCreated","datePublished","dateModified","dateDeleted"}, arguments={"orderParameterName"="order"})
* @Gedmo\SoftDeleteable(
* fieldName = "dateDeleted",
* timeAware = true
* )
*/
class Organisation extends \App\Conduction\AppBundle\Entity\AbstaractEntity
{
....
}
所以所有的基础都是有序的，并且 api/organisations 满足以下条件
{
"@context": "/api/contexts/Organisation",
"@id": "/api/organisations",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/organisations/ba8dc018-d8d5-11e8-bcb6-5254007d3b24",
"@type": "Organisation",
"slug": null,
"organisation": "/api/organisations/ba8dc018-d8d5-11e8-bcb6-5254007d3b24",
"children": [
"/api/organisations/ba8dc018-d8d5-11e8-bcb6-5254007d3b24"
],
"id": "ba8dc018-d8d5-11e8-bcb6-5254007d3b24",
"name": "Conduction",
"description": "This is the defeault platform",
"platform": {
"@id": "/api/platforms/ba8d9958-d8d5-11e8-a9a5-5254007d3b24",
"@type": "Platform",
"approveUsers": true,
"validateUsers": true,
"organisation": "/api/organisations/ba8dc018-d8d5-11e8-bcb6-5254007d3b24",
"id": "ba8d9958-d8d5-11e8-a9a5-5254007d3b24",
"name": "Conduction",
"description": "This is the defeault platform",
"platform": "/api/platforms/ba8d9958-d8d5-11e8-a9a5-5254007d3b24",
"dateCreated": "2018-10-26T06:15:09+02:00",
"datePublished": "2018-10-26T06:15:09+02:00",
"dateModified": "2018-10-26T06:15:10+02:00"
},
"dateCreated": "2018-10-26T06:15:09+02:00",
"datePublished": "2018-10-26T06:15:09+02:00",
"dateModified": "2018-10-26T06:15:10+02:00"
},
{
"@id": "/api/organisations/5f87e080-d8d6-11e8-9809-5254007d3b24",
"@type": "Organisation",
"slug": null,
"organisation": "/api/organisations/5f87e080-d8d6-11e8-9809-5254007d3b24",
"children": [
"/api/organisations/5f87e080-d8d6-11e8-9809-5254007d3b24"
],
"id": "5f87e080-d8d6-11e8-9809-5254007d3b24",
"name": "test 1",
"description": "<p>test 1 </p>",
"platform": null,
"dateCreated": "2018-10-26T06:19:47+02:00",
"datePublished": "2018-10-26T06:19:47+02:00",
"dateModified": "2018-10-26T06:19:47+02:00"
},
{
"@id": "/api/organisations/f2079af4-d8d6-11e8-ba9a-5254007d3b24",
"@type": "Organisation",
"slug": null,
"organisation": "/api/organisations/f2079af4-d8d6-11e8-ba9a-5254007d3b24",
"children": [
"/api/organisations/f2079af4-d8d6-11e8-ba9a-5254007d3b24"
],
"id": "f2079af4-d8d6-11e8-ba9a-5254007d3b24",
"name": "test 1",
"description": "<p>test 1</p>",
"platform": {
"@id": "/api/platforms/f20723bc-d8d6-11e8-8ffb-5254007d3b24",
"@type": "Platform",
"approveUsers": true,
"validateUsers": true,
"organisation": "/api/organisations/f2079af4-d8d6-11e8-ba9a-5254007d3b24",
"id": "f20723bc-d8d6-11e8-8ffb-5254007d3b24",
"name": "test 1",
"description": "<p>test 1</p>",
"platform": "/api/platforms/f20723bc-d8d6-11e8-8ffb-5254007d3b24",
"dateCreated": "2018-10-26T06:23:52+02:00",
"datePublished": "2018-10-26T06:23:52+02:00",
"dateModified": "2018-10-26T06:23:52+02:00"
},
"dateCreated": "2018-10-26T06:23:52+02:00",
"datePublished": "2018-10-26T06:23:52+02:00",
"dateModified": "2018-10-26T06:23:52+02:00"
}
],
"hydra:totalItems": 3,
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/organisations{?id,id[],description,name,organisation,organisation[],platform,platform[],dateCreated[before],dateCreated[strictly_before],dateCreated[after],dateCreated[strictly_after],datePublished[before],datePublished[strictly_before],datePublished[after],datePublished[strictly_after],dateModified[before],dateModified[strictly_before],dateModified[after],dateModified[strictly_after],dateDeleted[before],dateDeleted[strictly_before],dateDeleted[after],dateDeleted[strictly_after],order[id],order[name],order[dateCreated],order[datePublished],order[dateModified],order[dateDeleted]}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "id",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "description",
"property": "description",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "name",
"property": "name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "organisation",
"property": "organisation",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "organisation[]",
"property": "organisation",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "platform",
"property": "platform",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "platform[]",
"property": "platform",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[before]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[strictly_before]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[after]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[strictly_after]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[before]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[strictly_before]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[after]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[strictly_after]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[before]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[strictly_before]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[after]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[strictly_after]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[before]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[strictly_before]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[after]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[strictly_after]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[name]",
"property": "name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[dateCreated]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[datePublished]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[dateModified]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[dateDeleted]",
"property": "dateDeleted",
"required": false
}
]
}
}
然后有人会假设 api/organisations?platform=ba8d9958-d8d5-11e8-a9a5-5254007d3b24 给出属于该平台的所有组织，但没有。它给出了
{
"@context": "/api/contexts/Organisation",
"@id": "/api/organisations",
"@type": "hydra:Collection",
"hydra:member": [],
"hydra:totalItems": 0,
"hydra:view": {
"@id": "/api/organisations?platform=ba8d9958-d8d5-11e8-a9a5-5254007d3b24",
"@type": "hydra:PartialCollectionView"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/organisations{?id,id[],description,name,organisation,organisation[],platform,platform[],dateCreated[before],dateCreated[strictly_before],dateCreated[after],dateCreated[strictly_after],datePublished[before],datePublished[strictly_before],datePublished[after],datePublished[strictly_after],dateModified[before],dateModified[strictly_before],dateModified[after],dateModified[strictly_after],dateDeleted[before],dateDeleted[strictly_before],dateDeleted[after],dateDeleted[strictly_after],order[id],order[name],order[dateCreated],order[datePublished],order[dateModified],order[dateDeleted]}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "id",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "description",
"property": "description",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "name",
"property": "name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "organisation",
"property": "organisation",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "organisation[]",
"property": "organisation",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "platform",
"property": "platform",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "platform[]",
"property": "platform",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[before]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[strictly_before]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[after]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateCreated[strictly_after]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[before]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[strictly_before]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[after]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "datePublished[strictly_after]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[before]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[strictly_before]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[after]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateModified[strictly_after]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[before]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[strictly_before]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[after]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dateDeleted[strictly_after]",
"property": "dateDeleted",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[name]",
"property": "name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[dateCreated]",
"property": "dateCreated",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[datePublished]",
"property": "datePublished",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[dateModified]",
"property": "dateModified",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[dateDeleted]",
"property": "dateDeleted",
"required": false
}
]
}
或者干脆放零组织。现在出于寻找错误的目的，我再次构建了整个东西，但现在使用增量 ID，然后它就像一个魅力。所以问题似乎出在 ApiFilter 的工作方式上。这表明 ApiFilter 在搜索中使用它之前实际上并没有规范化 UUID ...
-- 更新--
好的，所以我尝试使用自定义过滤器绕过它
namespace App\Conduction\AppBundle\Filter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use Doctrine\ORM\QueryBuilder;
use Ramsey\Uuid\Uuid;
final class UuidFilter extends AbstractContextAwareFilter
{
protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
{
// otherwise filter is applied to order and page as well
if (
!$this->isPropertyEnabled($property, $resourceClass) ||
!$this->isPropertyMapped($property, $resourceClass)
) {
return;
}
$value =pack("h*", str_replace('-', '', $value));
$parameterName = $queryNameGenerator->generateParameterName($property); // Generate a unique parameter name to avoid collisions with other filters
$queryBuilder
->andWhere("$property =:$parameterName")
->setParameter($parameterName, $value);
}
// This function is only used to hook in documentation generators (supported by Swagger and Hydra)
public function getDescription(string $resourceClass): array
{
if (!$this->properties) {
return [];
}
$description = [];
foreach ($this->properties as $property => $strategy) {
$description["uuid"] = [
'property' => $property,
'type' => 'string',
'required' => false,
'swagger' => [
'description' => 'This filter allows to search the api based on object uuids',
'name' => 'UUID',
'type' => 'Primary identifier',
],
];
}
return $description;
}
}
但后来我遇到了一个 Doctrine 错误“[语义错误] 第 0 行，‘平台 =:platform_p1’ 附近的第 76 列:错误:‘平台’未定义。”
这当然表明平台没有定义，但据我所知是这样。
--- 更新:解决了! ---
Interesting thought, but unfortunately that also returns zero results. But interesting stuff is happening. So using the IRI doctrine does get the proper intel -> as seen in the logs as:
[2018-10-30 10:00:50] doctrine.DEBUG: SELECT o0_.slug AS slug_0, o0_.id AS id_1, o0_.name AS name_2, o0_.description AS description_3, o0_.date_created AS date_created_4, o0_.date_published AS date_published_5, o0_.date_modified AS date_modified_6, o0_.date_deleted AS date_deleted_7, o0_.date_checkout AS date_checkout_8, o0_.version AS version_9, o0_.address_id AS address_id_10, o0_.organisation_id AS organisation_id_11, o0_.default_tax_id AS default_tax_id_12, o0_.member_group_id AS member_group_id_13, o0_.admin_group_id AS admin_group_id_14, o0_.image_id AS image_id_15, o0_.platform_id AS platform_id_16, o0_.user_owned AS user_owned_17, o0_.user_created AS user_created_18, o0_.user_updated AS user_updated_19, o0_.user_checkout AS user_checkout_20 FROM organisation__organisation o0_ WHERE o0_.platform_id = ? AND o0_.date_deleted IS NULL AND o0_.date_published < ? ORDER BY o0_.id ASC ["[object] (Ramsey\\Uuid\\Uuid: \"13be1406-d9c3-11e8-9d84-5254007d3b24\")","2018-10-30 10:00:50"] []
所以这里的 doctrine 显然知道它正在搜索 Ramsy\Uuid 而不是直接搜索“13be1406-d9c3-11e8-9d84-5254007d3b2”。好吧，如果我们在没有平台 IRI 的情况下进行搜索怎么办？ 这给出了 1 个对象的良好响应，以及以下 Doctrine 日志
[2018-10-30 10:09:46] doctrine.DEBUG: SELECT o0_.slug AS slug_0, o0_.id AS id_1, o0_.name AS name_2, o0_.description AS description_3, o0_.date_created AS date_created_4, o0_.date_published AS date_published_5, o0_.date_modified AS date_modified_6, o0_.date_deleted AS date_deleted_7, o0_.date_checkout AS date_checkout_8, o0_.version AS version_9, o0_.address_id AS address_id_10, o0_.organisation_id AS organisation_id_11, o0_.default_tax_id AS default_tax_id_12, o0_.member_group_id AS member_group_id_13, o0_.admin_group_id AS admin_group_id_14, o0_.image_id AS image_id_15, o0_.platform_id AS platform_id_16, o0_.user_owned AS user_owned_17, o0_.user_created AS user_created_18, o0_.user_updated AS user_updated_19, o0_.user_checkout AS user_checkout_20 FROM organisation__organisation o0_ WHERE o0_.date_deleted IS NULL AND o0_.date_published < ? ORDER BY o0_.id ASC ["2018-10-30 10:09:46"] []
所以差异确实在 Ramsy\Uuid 中，这里的特殊之处在于，如果我们得到 ../api/platforms/13be1406-d9c3-11e8-9d84-5254007d3b24，我们会得到该平台对象的良好响应。因此，对 Ramsy\Uuid 的解析似乎在起作用，呃，好吧……。那么那个 id 字段呢？如果我们只是抓取数据库并进行简单的连接。我们能够加入组织和 ID，因此 platform.id 和 organization__organistation.platform_id 字段包含相同的值。然后是真正的踢球者……
.../api/organisations?platform.id=13be1406-d9c3-11e8-9d84-5254007d3b24
有效!所以这"is"地解决了我们的问题，只是以一种意想不到的方式。它向我们展示了一个 Doctrine 日志:
[2018-10-30 10:19:15] doctrine.DEBUG: SELECT t0.editable AS editable_1, t0.memberGroup AS memberGroup_2, t0.id AS id_3, t0.name AS name_4, t0.description AS description_5, t0.date_created AS date_created_6, t0.date_published AS date_published_7, t0.date_modified AS date_modified_8, t0.date_deleted AS date_deleted_9, t0.date_checkout AS date_checkout_10, t0.version AS version_11, t0.organisation_id AS organisation_id_12, t13.slug AS slug_14, t13.id AS id_15, t13.name AS name_16, t13.description AS description_17, t13.date_created AS date_created_18, t13.date_published AS date_published_19, t13.date_modified AS date_modified_20, t13.date_deleted AS date_deleted_21, t13.date_checkout AS date_checkout_22, t13.version AS version_23, t13.address_id AS address_id_24, t13.organisation_id AS organisation_id_25, t13.default_tax_id AS default_tax_id_26, t13.member_group_id AS member_group_id_27, t13.admin_group_id AS admin_group_id_28, t13.image_id AS image_id_29, t13.platform_id AS platform_id_30, t13.user_owned AS user_owned_31, t13.user_created AS user_created_32, t13.user_updated AS user_updated_33, t13.user_checkout AS user_checkout_34, t0.parent_id AS parent_id_35, t0.image_id AS image_id_36, t0.platform_id AS platform_id_37, t0.user_owned AS user_owned_38, t0.user_created AS user_created_39, t0.user_updated AS user_updated_40, t0.user_checkout AS user_checkout_41 FROM organisation__organisation_group t0 LEFT JOIN organisation__organisation t13 ON t0.organisation_id = t13.id INNER JOIN organisation__organisation_group_member ON t0.id = organisation__organisation_group_member.group_id WHERE organisation__organisation_group_member.user_id = ? ["[object] (Ramsey\\Uuid\\Uuid: \"154f07d0-d9c3-11e8-bf04-5254007d3b24\")"] []
等等？是的。如果我们执行 api/organisations?platform=/api/platforms/ba8d9958-d8d5-11e8-a9a5-5254007d3b24。 Doctrine 不执行内部连接，也不能正确解码 UUID，但是当我们执行 api/organisations?platform.id=ba8d9958-d8d5-11e8-a9a5-5254007d3b24 时。 API 平台强制内部连接然后它突然工作...
好的，我们的问题现在已经解决了，但我仍然认为这是 API 平台(支持 Ramsy\Uuid)或 Ramsy\Uuid 可能想要研究的东西
最佳答案
我遇到了这个问题并且遇到了类似的问题但是没有自定义过滤器就解决了。您只需要更新您的 @ApiFilter() 定义。
我在您的组织模型中更改了这一行:
* @ApiFilter(SearchFilter::class, properties={"id": "exact", "description": "partial", "name": "partial","organisation": "exact","platform": "exact"})
到
* @ApiFilter(SearchFilter::class, properties={"id": "exact", "description": "partial", "name": "partial","organisation": "exact","platform.uuid": "exact"})
请注意平台定义的变化。这就是我修复用例所需的全部内容。
我看到另一条评论说要使用 .id，但这对我不起作用，因为它只会搜索 id 列而不是 uuid。
关于filter - 带有 uuid 的 API 平台过滤器，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/53001906/