Shopware 6：如何基于shipper自定义字段限制商品加入购物车

需求说明 #

针对自定义字段键shipper_实现以下购物车商品添加限制：

• 若购物车中存在带shipper_字段的商品，但待加入商品无此字段 → 拒绝加入并记录日志
• 若购物车中无带shipper_字段的商品，但待加入商品有此字段 → 拒绝加入并记录日志
• 两者同时存在或同时不存在时，允许加入

关键实现说明 #

核心逻辑必须在BeforeLineItemAddedEvent中处理（AfterLineItemAddedEvent是商品已加入后触发，无法阻止添加操作）。通过两个辅助判断：购物车现有商品是否包含目标字段、待加入商品是否包含目标字段，再对比两者状态执行限制。

完整代码实现 #

use Shopware\Core\Checkout\Cart\LineItem\LineItem;
use Shopware\Core\Checkout\Cart\Event\BeforeLineItemAddedEvent;
use Shopware\Core\Checkout\Cart\Event\AfterLineItemAddedEvent;
use Psr\Log\LoggerInterface;
use Shopware\Core\Framework\Validation\Exception\ValidationException;
use Symfony\Component\Validator\ConstraintViolation;

class YourCartSubscriber
{
    private LoggerInterface $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public static function getSubscribedEvents(): array
    {
        return [
            BeforeLineItemAddedEvent::class => 'validateLineItemBeforeAdd',
            AfterLineItemAddedEvent::class => 'logLineItemAddition',
        ];
    }

    /**
     * 核心验证逻辑：商品加入前检查自定义字段匹配规则
     */
    public function validateLineItemBeforeAdd(BeforeLineItemAddedEvent $event): void
    {
        $cart = $event->getCart();
        $newLineItem = $event->getLineItem();

        // 判断购物车现有商品是否存在shipper_字段
        $cartHasShipper = $this->cartContainsShipperField($cart->getLineItems());
        // 判断待加入商品是否存在shipper_字段
        $newItemHasShipper = $this->lineItemHasShipperField($newLineItem);

        // 规则校验：两者状态不一致则拒绝加入
        if ($cartHasShipper !== $newItemHasShipper) {
            // 阻止事件传播，中断商品添加流程
            $event->stopPropagation();
            
            // 添加购物车错误，前端会展示该提示
            $cart->getErrors()->add(new ValidationException([
                'lineItem' => new ConstraintViolation(
                    '无法加入该商品：购物车商品与待加入商品的发货方字段不匹配',
                    '无法加入该商品：购物车商品与待加入商品的发货方字段不匹配',
                    [],
                    null,
                    null,
                    null
                )
            ]));

            // 记录日志
            $this->logger->warning(
                '商品加入被拒绝：发货方字段不匹配',
                [
                    'cartId' => $cart->getId(),
                    'newItemId' => $newLineItem->getId(),
                    'cartHasShipper' => $cartHasShipper,
                    'newItemHasShipper' => $newItemHasShipper
                ]
            );
        }
    }

    /**
     * 辅助方法：检查购物车是否存在带shipper_字段的商品
     */
    private function cartContainsShipperField(iterable $lineItems): bool
    {
        foreach ($lineItems as $item) {
            if ($this->lineItemHasShipperField($item)) {
                return true;
            }
        }
        return false;
    }

    /**
     * 辅助方法：检查单个商品是否包含shipper_字段
     */
    private function lineItemHasShipperField(LineItem $lineItem): bool
    {
        $customFields = $lineItem->getPayload()['customFields'] ?? [];
        return isset($customFields['shipper_']);
    }

    /**
     * 可选：商品加入后记录日志
     */
    public function logLineItemAddition(AfterLineItemAddedEvent $event): void
    {
        foreach ($event->getLineItems() as $lineItem) {
            $hasShipper = $this->lineItemHasShipperField($lineItem);
            $this->logger->info(
                '商品已加入购物车',
                [
                    'lineItemId' => $lineItem->getId(),
                    'hasShipperField' => $hasShipper
                ]
            );
        }
    }
}

代码关键点解释 #

1. 事件选择：利用BeforeLineItemAddedEvent的stopPropagation()和购物车错误机制，实现商品添加拦截，这是Shopware阻止购物车操作的标准方式。
2. 逻辑复用：通过两个辅助方法统一字段判断逻辑，避免代码冗余。
3. 用户提示：添加的ValidationException会在前端展示给用户，明确拒绝原因。
4. 日志完整性：记录购物车ID、商品ID和字段状态，便于后续问题排查。

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