Shopware 6 管理后台产品表单自定义字段扩展指南

本教程旨在指导开发者如何在 shopware 6 管理后台的产品表单中添加和管理自定义字段，以扩展产品数据模型。我们将详细阐述 shopware 官方推荐的“自定义字段”功能，而非直接修改核心实体或数据库表，并解释如何利用此功能实现字段的继承、数据保存与读取，同时避免在手动扩展时可能遇到的常见错误，如 typeerror: e.getentityname is not a function。

1. 理解 Shopware 6 的产品数据扩展机制

在 Shopware 6 中，当需要向现有实体（如产品 ProductEntity）添加新的数据字段时，开发者可能会倾向于直接创建新的实体扩展或修改数据库表结构。然而，Shopware 6 提供了一种更为优雅和健壮的解决方案，即“自定义字段”（Custom Fields）。

自定义字段是 Shopware 框架内置的一项强大功能，它允许开发者为任何支持的实体（通过 EntityCustomFieldsTrait 引入）动态添加额外的数据字段，而无需修改核心代码或进行复杂的实体扩展。这些自定义字段会自动集成到管理后台的用户界面中，并支持数据继承机制，极大地简化了开发流程。

原始问题中遇到的 TypeError: e.getEntityName is not a function 错误，通常是由于尝试将一个非标准实体对象（例如，一个自定义的扩展数据结构）传递给期望 Shopware 实体对象的组件（如 sw-inherit-wrapper），导致类型不匹配。使用自定义字段功能可以避免这类问题，因为 Shopware 会在底层处理好这些细节。

2. 使用自定义字段扩展产品表单

Shopware 的自定义字段功能是扩展产品属性最推荐的方式。它不仅简化了数据模型的扩展，还确保了与管理后台的无缝集成以及对数据继承的良好支持。

2.1 定义自定义字段

自定义字段的定义通常通过插件的 Resources/config/custom_fields.xml 文件或通过 PHP 服务完成。以下是一个通过 XML 定义三个浮点型自定义字段的示例，以满足在产品中存储如“最小购买米数”等需求：

<!-- plugins/YourPluginName/src/Resources/config/custom_fields.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<custom-fields xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/shopware/platform/master/src/Core/System/CustomField/Xml/custom-field.xsd">
    <custom-field-set id="your_plugin_product_fabric_fields" name="your_plugin_product_fabric_fields" position="100">
        <name>产品布料属性</name>
        <label>产品布料属性</label>
        <relations>
            <relation entity="product" />
        </relations>
        <custom-field type="float" name="custom_fabric_min_purchase">
            <name>最小购买米数</name>
            <label>最小购买米数</label>
            <config>
                <component name="sw-field" />
                <type>number</type>
                <numberType>float</numberType>
                <min>0</min>
                <customFieldPosition>1</customFieldPosition>
            </config>
        </custom-field>
        <custom-field type="float" name="custom_fabric_width">
            <name>布料宽度</name>
            <label>布料宽度</label>
            <config>
                <component name="sw-field" />
                <type>number</type>
                <numberType>float</numberType>
                <min>0</min>
                <customFieldPosition>2</customFieldPosition>
            </config>
        </custom-field>
        <custom-field type="float" name="custom_fabric_weight">
            <name>布料克重</name>
            <label>布料克重 (g/m²)</label>
            <config>
                <component name="sw-field" />
                <type>number</type>
                <numberType>float</numberType>
                <min>0</min>
                <customFieldPosition>3</customFieldPosition>
            </config>
        </custom-field>
    </custom-field-set>
</custom-fields>

关键点说明：

• custom-field-set: 这是一个自定义字段的集合，可以包含多个字段。id 和 name 应该是唯一的。
• relations: 定义了此字段集与哪个实体关联。entity="product" 表示这些字段将添加到 ProductEntity。
• custom-field: 定义单个自定义字段。
  • type: 定义字段的数据类型，例如 float、text、boolean 等。
  • name: 这是字段的唯一标识符，将作为数据库列名的一部分（通常是 custom_your_plugin_product_fabric_fields_custom_fabric_min_purchase）。在前端访问时，它会以 custom_fabric_min_purchase 的形式存在于 product.customFields 对象中。
  • config: 配置字段在管理后台的显示方式。component 定义了使用的 Vue 组件（通常是 sw-field），type 和 numberType 指定了输入框的类型，min 可以设置最小值。

定义好 XML 文件后，需要确保你的插件被激活，并清除缓存 (bin/console cache:clear)，然后运行数据库迁移 (bin/console database:migrate) 或更新 Shopware (bin/console sw:update:finish)，Shopware 就会自动创建相应的数据库列，并在管理后台生成自定义字段的输入界面。

2.2 管理后台的用户界面集成

一旦自定义字段被定义并激活，Shopware 会自动在产品详情页的管理后台中创建一个名为“自定义字段”的独立卡片（或选项卡），并在其中显示你定义的所有字段。用户可以直接在此处输入和保存数据。

Docky AI

多合一AI浏览器助手，解答问题、绘制图片、阅读文档、强化搜索结果、辅助创作

87

查看详情

如果你希望将自定义字段放置在产品表单的特定现有部分（例如，在“交付能力”部分），则需要通过 Twig 模板覆盖来实现。

示例：将自定义字段插入到“交付能力”部分

假设我们想将 custom_fabric_min_purchase 字段替换或添加到“交付能力”部分，并且让它看起来像一个核心字段。我们可以通过覆盖相应的 Twig 块来实现。

{# plugins/YourPluginName/src/Resources/views/administration/src/module/sw-product/view/sw-product-detail-base/sw-product-detail-base.html.twig #}
{% sw_extends '@SwProduct/administration/src/module/sw-product/view/sw-product-detail-base/sw-product-detail-base.html.twig' %}

{% block sw_product_deliverability_form_min_purchase_field %}
    {# 
        注意：此处我们不直接使用 sw-inherit-wrapper 包裹自定义字段，
        因为自定义字段的继承逻辑由 Shopware 内部自动处理，
        通过 product.customFields 对象访问即可。
        sw-inherit-wrapper 主要用于核心字段或自定义实体扩展。
    #}
    <sw-field
        type="number"
        number-type="float"
        :min="0"
        :label="$tc('sw-product.settingsForm.labelMinPurchase')" {# 可以使用现有标签或自定义标签 #}
        :placeholder="$tc('sw-product.settingsForm.placeholderMinPurchase')"
        v-model="product.customFields.custom_fabric_min_purchase" {# 绑定到自定义字段 #}
        :error="productMinPurchaseError" {# 如果需要，可以添加自定义错误处理 #}
        :disabled="!allowEdit" {# 继承状态通常由 Shopware 自动处理，这里只考虑编辑权限 #}
    />
{% endblock %}

重要提示：

• 当使用自定义字段时，数据会存储在 product.customFields 对象中。因此，在 Vue 模板中，你应该通过 v-model="product.customFields.your_custom_field_name" 来绑定数据。
• 自定义字段的继承机制由 Shopware 自动处理。如果父产品设置了自定义字段的值，而子产品没有，子产品将继承父产品的值。当你在子产品中修改该自定义字段时，它会覆盖父产品的值。因此，通常不需要为自定义字段手动配置 sw-inherit-wrapper。

2.3 访问自定义字段数据

• 在管理后台 Vue 组件中： 如上所示，可以直接通过 this.product.customFields.your_custom_field_name 访问和修改数据。
• 在 Storefront Twig 模板中： 在前端模板中，同样可以通过 product.customFields.your_custom_field_name 来访问自定义字段的值。

  {% if product.customFields.custom_fabric_min_purchase is not empty %}
      <p>最小购买米数: {{ product.customFields.custom_fabric_min_purchase }} 米</p>
  {% endif %}

  登录后复制
• 通过 API 或 PHP 服务： 当通过 Storefront API 或 Admin API 获取产品数据时，自定义字段将作为 customFields 属性的一部分返回。在 PHP 中，你可以通过 ProductEntity::getCustomFields() 方法获取一个数组，其中包含所有自定义字段及其值。

3. 注意事项与最佳实践

• 选择合适的字段类型： 根据你的数据需求选择正确的 type (text, float, int, boolean, datetime, select, json等)，这会影响管理后台的输入组件和数据存储方式。
• 命名规范： 自定义字段的 name 应该具有描述性且唯一。建议使用插件前缀，例如 your_plugin_custom_field_name。
• 避免直接修改核心表： 除非有非常特殊的需求，否则应始终优先使用自定义字段功能，而不是直接修改 Shopware 的核心数据库表或实体。直接修改会增加升级和维护的复杂性。
• 自定义字段与实体扩展：
  • 自定义字段适用于为现有实体添加简单的数据字段，这些字段通常不需要复杂的业务逻辑或独立的数据模型。它们自动处理UI集成和继承。
  • 实体扩展适用于需要创建与核心实体有复杂关系的新实体，或者需要完全自定义数据模型和业务逻辑的场景。这通常涉及创建新的数据抽象层（DAL）实体、存储库和服务。原始问题中尝试的 extension.customMinPurchase 更接近于自定义实体扩展的用法，但对于简单的字段添加，自定义字段更为合适。
• 缓存清除： 每次添加、修改或删除自定义字段定义后，务必清除 Shopware 缓存，以确保更改生效。
• 错误处理： 虽然自定义字段简化了开发，但在前端模板覆盖时，仍需注意处理可能的错误或空值，以提供良好的用户体验。

4. 总结

Shopware 6 的自定义字段功能是扩展产品数据模型和管理后台表单的强大且推荐的方式。通过定义清晰的 XML 配置，开发者可以轻松地为产品添加浮点数等各种类型的新字段，并利用 Shopware 自动提供的 UI 集成和数据继承机制。这种方法不仅避免了手动实体扩展可能带来的复杂性和错误（如 TypeError: e.getEntityName is not a function），还确保了插件的兼容性和系统的可维护性。在需要向产品添加额外属性时，始终优先考虑使用自定义字段。

以上就是Shopware 6 管理后台产品表单自定义字段扩展指南的详细内容，更多请关注php中文网其它相关文章！