本文详细探讨了在Shopware中从订单对象获取产品自定义字段的有效方法。针对常见的语言依赖问题，我们揭示了通过调整数据关联（将`'lineItems.product.translations'`替换为`'lineItems.product.default'`）来正确访问自定义字段的关键。教程提供了具体的代码示例，帮助开发者高效地在Shopware订单处理中集成产品自定义数据，避免因语言设置导致的获取失败。
在Shopware开发中，经常需要从订单对象中获取与其关联的产品详细信息，包括可能存储在产品上的自定义字段（Custom Fields）。这些自定义字段可以包含重要的业务数据，例如仓库名称、内部SKU或特定产品属性。然而，在实际操作中，开发者可能会遇到无法正确获取这些自定义字段的问题，尤其是在涉及到Shopware的语言和数据关联机制时。
理解Shopware的数据关联与自定义字段
Shopware的数据模型设计允许产品拥有多种属性，其中一些是语言独立的（如ID、产品编号），另一些则是语言相关的（如产品名称、描述）。自定义字段可以配置为语言独立的，也可以是语言相关的。当从订单对象中查询产品数据时，选择正确的关联方式至关重要。
最初，开发者可能会尝试通过'lineItems.product.translations'关联来获取产品数据，并期望通过getProduct()->getCustomFields()方法直接访问自定义字段。然而，如果自定义字段被设置为语言独立，或者在当前上下文中需要获取默认语言的自定义字段，这种关联方式可能无法奏效，导致getCustomFields()返回空值，甚至在尝试访问非预期的翻译实体时引发错误。
解决自定义字段获取问题：语言依赖性
问题的核心在于对Shopware数据模型中语言依赖性的理解。当自定义字段不是特定于某种语言时，或者当我们需要获取产品的“默认”自定义字段集时，不应该通过translations关联。正确的做法是直接关联到产品的默认数据，这通常包含了非语言相关的属性以及默认语言的自定义字段。
Avactis是一个强大的PHP在线购物系统拥有多个版本包括开源版本。它具备一个在线购物系统所需要的所有功能从产品到会员管理，订单和营销。可以无限分类和为产品指定任务数量的图片（支持自动生成缩略图）。使用自定义字段功能，让你可以更好地定义一个产品。该系统提供以非常灵活的方式来创建任意类型的促销活动如设置折扣代码，基于价格的折扣或基于数量的折扣等。
Shopware提供了一种更直接的关联方式来解决这个问题：'lineItems.product.default'。通过将Criteria中的产品关联从'lineItems.product.translations'更改为'lineItems.product.default'，我们可以确保系统加载的是产品实体的核心数据，其中包括了可以直接访问的自定义字段。
实施步骤与代码示例
以下是获取Shopware订单中产品自定义字段的正确实现步骤和相应的代码示例：
-
构建Criteria对象并添加正确的关联 在查询订单时，我们需要在addAssociations方法中明确指定'lineItems.product.default'。
use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria; use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter; use Shopware\Core\System\SalesChannel\Context\SalesChannelContext; use Shopware\Core\Framework\Context; use Shopware\Core\Checkout\Order\OrderEntity; use Shopware\Core\Checkout\Order\OrderRepository; // 假设注入了OrderRepository // 假设 orderRepository 已经通过依赖注入获得 private OrderRepository $orderRepository; public function getOrderProductCustomFields(string $orderId, Context $context): ?OrderEntity { $criteria = new Criteria(); $criteria->addFilter(new EqualsFilter('id', $orderId)); $criteria->addAssociations([ 'deliveries.shippingOrderAddress.salutation', 'deliveries.shippingOrderAddress.country', 'orderCustomer.customer.group', // 关键更改：使用 'lineItems.product.default' 而非 'lineItems.product.translations' 'lineItems.product.default', ]); /** @var OrderEntity|null $orderObject */ $orderObject = $this->orderRepository->search($criteria, $context)->first(); return $orderObject; } -
访问自定义字段 在获取到OrderEntity之后，遍历订单项（Line Items），然后从每个产品的实体中直接调用getCustomFields()方法。
// 假设 $orderObject 已经通过上面的方法获取 if ($orderObject && $orderObject->getLineItems()) { foreach ($orderObject->getLineItems() as $lineItem) { if ($lineItem->getProduct()) { $product = $lineItem->getProduct(); $customFields = $product->getCustomFields(); if (!empty($customFields)) { // 假设自定义字段名为 'emakers_custom_field_warehouse_name' $warehouseName = $customFields['emakers_custom_field_warehouse_name'] ?? null; echo "Product: " . $product->getName() . ", Warehouse Name: " . $warehouseName . "\n"; } else { echo "Product: " . $product->getName() . ", No custom fields found.\n"; } } } }
注意事项与最佳实践
- 自定义字段的配置： 在Shopware后台配置自定义字段时，请注意其“可翻译”选项。如果自定义字段被标记为不可翻译，那么它将是语言独立的，通过'lineItems.product.default'关联即可直接获取。如果自定义字段是可翻译的，那么'lineItems.product.default'将获取当前上下文语言（或默认语言）的翻译值。
- 上下文的重要性： 在执行数据库查询时，传入的Context对象至关重要。它决定了Shopware在查询过程中使用的语言、货币等信息。确保使用正确的Context，例如Context::createDefaultContext()或从SalesChannelContext中获取的上下文。
- 错误处理： 在访问自定义字段时，始终进行空值检查，因为产品或自定义字段可能不存在。
- 性能考量： 避免在循环中执行不必要的数据库查询。通过在初始Criteria中一次性加载所有必要的关联数据，可以显著提高性能。
总结
在Shopware中获取订单产品的自定义字段，关键在于理解其数据模型中语言依赖性的处理方式。通过将Criteria中的产品关联从'lineItems.product.translations'调整为'lineItems.product.default'，开发者可以有效地解决因语言设置导致的自定义字段获取问题，从而顺利地访问和利用这些重要的业务数据。遵循本文提供的代码示例和注意事项，将有助于构建更健壮和高效的Shopware应用程序。
