ORO API自定义数据结构对接关联资源normalize_input处理器异常问题

架构老林

2026-10-7

问题根因

你的api_frontend.yml配置存在层级错误，actions节点当前错误嵌套在fields节点下，导致自定义动作的配置未生效，同时关联字段的类型映射也存在错误。
OroAPI默认对自定义非ORM模型关闭了复合请求的included参数解析能力，normalize_input处理器默认只会处理请求体的data和meta节点内容，未启用included节点的解析逻辑。

解决方案

步骤1：修正API配置

修正yml配置的层级错误、字段映射错误，同时开启included解析支持：

api:
  entities:
    Ardex\Bundle\OrderBundle\Api\Model\CartProducts:
      disable_meta_properties: true
      # 全局开启当前模型的included参数解析
      enable_include: true
      fields:
        lineItems:
          # 修正目标类为你实际的OrderLineItem类，不要误填Product
          target_class: Ardex\Bundle\OrderBundle\Entity\OrderLineItem
          target_type: to-many
          # 配置字段可读写，允许请求传值
          direction: input-output
      # 将actions节点移到与fields同级
      actions:
        get: false
        get_list: false
        update: false
        delete: false
        delete_list: false
        create:
          # 为create动作单独开启included处理
          enable_include: true
          # 配置允许的关联include路径
          includes:
            - lineItems
            - lineItems.product

步骤2：完善自定义模型的属性访问逻辑

要让请求参数直接放在data节点而非meta节点传递，需要给自定义模型添加对应的字段访问方法，确保OroAPI的属性访问器可以正常写入字段值：

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;

class ListModel
{
   /** @var Collection|OrderLineItem[] */
   protected $lineItems;

   public function __construct()
   {
       $this->lineItems = new ArrayCollection();
   }

   public function getLineItems(): Collection
   {
       return $this->lineItems;
   }

   public function addLineItem(OrderLineItem $item): void
   {
       if (!$this->lineItems->contains($item)) {
           $this->lineItems->add($item);
       }
   }

   public function removeLineItem(OrderLineItem $item): void
   {
       $this->lineItems->removeElement($item);
   }
   // 其他业务逻辑
}

步骤3：兼容自定义解析逻辑（可选）

如果默认的解析逻辑还是无法读取included内容，可以自定义一个前置输入处理器加入到normalize_input动作组的执行链中，手动提取included数据映射到对应字段：

注册处理器到服务配置：

services:
  Ardex\Bundle\OrderBundle\Api\Processor\CustomIncludedParser:
    tags:
      - { name: oro.api.processor, action: normalize_input, group: initialize, class: Ardex\Bundle\OrderBundle\Api\Model\CartProducts, priority: 10 }

处理器代码示例：

use Oro\Bundle\ApiBundle\Processor\NormalizeInputContext;
use Oro\Component\ChainProcessor\ContextInterface;
use Oro\Component\ChainProcessor\ProcessorInterface;

class CustomIncludedParser implements ProcessorInterface
{
    public function process(ContextInterface $context): void
    {
        /** @var NormalizeInputContext $context */
        $requestData = $context->getRequestData();
        $included = $requestData['included'] ?? [];
        if (empty($included)) {
            return;
        }
        // 筛选included中的订单项数据，写入请求data节点
        $lineItems = array_filter($included, fn($item) => $item['type'] === 'orderlineitems');
        $requestData['data']['attributes']['lineItems'] = $lineItems;
        $context->setRequestData($requestData);
    }
}

内容的提问来源于stack exchange，提问作者Artoa