首页 > 营销学院 > 技术知识

Shopware 6：在管理后台产品表单中添加和管理自定义字段

本教程详细介绍了如何在shopware 6管理后台的产品表单中添加、编辑和继承自定义字段。我们将利用shopware内置的自定义字段功能，通过配置xml文件来定义新的数据字段，并探讨如何在vue组件和twig模板中访问和展示这些数据，从而实现对产品信息的灵活扩展。

在Shopware 6中，为产品实体添加额外的字段以满足特定的业务需求是常见的扩展场景。例如，销售布料的商店可能需要以浮点数（如米数）来表示最小购买量。Shopware提供了一套强大的自定义字段（Custom Fields）机制来优雅地实现这一目标，而无需手动修改数据库结构或复杂地扩展核心实体。

1. 理解Shopware 6的自定义字段机制

Shopware的自定义字段功能允许开发者将额外的、可配置的数据附加到任何实体上，包括产品、客户、订单等。这些字段会自动处理数据库存储、管理后台UI的渲染、多语言支持以及最重要的——继承性。

核心原理：

EntityCustomFieldsTrait: 大多数Shopware实体（如 ProductEntity）都使用了 EntityCustomFieldsTrait。这个Trait使得实体能够自动拥有一个 customFields 属性，用于存储所有附加的自定义字段数据。
配置驱动: 自定义字段的定义完全通过插件的配置（通常是XML文件）来完成，Shopware会在插件安装或更新时自动处理数据库模式的变更。

使用自定义字段的优势在于其与Shopware核心的深度集成，能够无缝地利用其继承机制和管理后台界面。

2. 定义自定义字段集与字段

要添加自定义字段，你需要创建一个Shopware插件，并在其中定义你的自定义字段集（Custom Field Set）和具体的自定义字段。这通常在插件的 src/Resources/config/services.xml 文件中完成。

以下是一个示例，展示如何为产品实体添加一个浮点数类型的自定义字段，用于表示“自定义最小购买量（米）”：



    
        
        
            
            
            
        

        
            
            
            
            
                
                    
                        your_plugin_product_fields
                        
                            
                                
                                    
                                        Product Fabric Fields
                                        Produkt Stofffelder
                                        产品布料字段
                                    
                                
                            
                        
                        
                            
                                
                                    
                                        product
                                    
                                
                            
                        
                        
                            
                                
                                
                                    
                                        custom_min_purchase_meters
                                        number
                                        
                                            
                                                float
                                                0
                                                
                                                    
                                                        Min. Purchase (Meters)
                                                        Min. Abnahme (Meter)
                                                        最小购买量 (米)
                                                    
                                                
                                                1
                                            
                                        
                                    
                                
                                
                                
                                    
                                        custom_max_purchase_meters
                                        number
                                        
                                            
                                                float
                                                0
                                                
                                                    
                                                        Max. Purchase (Meters)
                                                        Max. Abnahme (Meter)
                                                        最大购买量 (米)
                                                    
                                                
                                                2

关键点说明：

name: 自定义字段集的唯一标识符，也是数据库中列名的前缀。
config: 包含字段集的显示标签（支持多语言）。
relations: 定义此字段集关联的实体，这里是 product。
customFields: 包含一个或多个具体的自定义字段定义。
- name: 自定义字段的唯一标识符，建议使用 custom_ 前缀。
- type: 字段类型，例如 text、number、boolean、datetime 等。对于浮点数，使用 number。
- config: 字段的详细配置，如 numberType: 'float' 指定为浮点数，min 设置最小值，label 设置显示标签（支持多语言），customFieldPosition 用于排序。

完成配置后，你需要安装或更新你的插件，并清除Shopware缓存：

bin/console plugin:install YourPluginName --activate
bin/console cache:clear

3. 在管理后台访问和配置自定义字段

一旦插件安装并激活，并清除了缓存，你定义的自定义字段会自动出现在产品详情页的管理后台界面中。它们通常会集中在一个名为“自定义字段”（Custom Fields）的新标签页下。

你可以在这里直接输入和保存这些自定义字段的值。Shopware会自动处理数据的持久化和继承逻辑。

4. 在Vue组件中获取和使用自定义字段数据

如果你需要将自定义字段显示在产品详情页的特定位置（例如，“可交付性”部分），或者需要自定义其渲染逻辑，你就需要通过Vue组件来访问和绑定这些数据。

在Shopware的Vue组件中，产品实体数据通常通过 product 或 currentProduct 属性可用。自定义字段的数据存储在 product.customFields 对象中，你可以通过自定义字段的 name 来访问它。

以下是一个示例，展示如何在 sw-product-deliverability-form 组件中，使用 sw-inherit-wrapper 将我们定义的 custom_min_purchase_meters 字段绑定到一个 sw-field：




{% block sw_product_deliverability_form_min_purchase_field %}
    
        
    
{% endblock %}

代码说明：

v-model="product.customFields.custom_min_purchase_meters": 这是关键。它将 sw-inherit-wrapper 的值绑定到产品实体上的自定义字段。当用户在输入框中修改值时，这个值会直接更新到 product.customFields.custom_min_purchase_meters。
:inherited-value="parentProduct.customFields.custom_min_purchase_meters": 为了支持继承，你需要提供父产品对应的自定义字段值。
sw-field 的 number-type="float" 和 min="0" 配置应与你在 services.xml 中定义的自定义字段类型相匹配。
$tc('your-plugin.product.settingsForm.labelMinPurchaseMeters'): 建议使用插件的翻译键来定义字段标签，以支持多语言。

通过这种方式，sw-inherit-wrapper 会自动处理值的读取、保存以及继承逻辑，大大简化了开发工作。之前遇到的 TypeError: e.getEntityName is not a function 错误很可能是因为尝试将非Shopware实体属性或未正确集成的扩展属性直接绑定到期望Shopware实体属性的 sw-inherit-wrapper 上。使用 product.customFields.your_field_name 这种Shopware推荐的方式可以避免此类问题。

5. 在Twig模板中渲染自定义字段

如果你需要在店面或邮件模板等前端部分显示自定义字段的值，可以直接通过 product.customFields 访问：

{% if product.customFields.custom_min_purchase_meters is not empty %}
    最小购买量 (米): {{ product.customFields.custom_min_purchase_meters }}
{% endif %}

6. 注意事项与最佳实践

清空缓存: 每次添加、修改或删除自定义字段配置后，务必运行 bin/console cache:clear。否则，Shopware可能无法识别新的字段或配置。
避免手动表扩展: 强烈建议使用Shopware的自定义字段功能来扩展实体，而不是手动创建新的数据库表或在现有表上添加列。自定义字段机制已经为你处理了数据库迁移、ORM映射、管理后台UI和继承逻辑。
数据类型匹配: 确保你在 services.xml 中定义的自定义字段类型（如 number 和 numberType: 'float'）与你在Vue组件中使用的 sw-field 的 type 和 number-type 属性相匹配。
UI位置定制: 虽然自定义字段默认会出现在“自定义字段”标签页中，但如果你需要将它们集成到其他现有表单部分（如“可交付性”），则需要通过覆盖Shopware的Vue组件来实现。这通常涉及创建新的Vue组件来扩展或替换Shopware的现有组件，并在其中渲染你的自定义字段。
翻译: 为自定义字段的标签和占位符提供多语言翻译，以提供更好的用户体验。

总结

Shopware 6的自定义字段功能是扩展产品或其他实体属性的强大且推荐的方式。通过配置XML文件定义字段，并利用 product.customFields 在Vue组件和Twig模板中访问数据，你可以轻松地为管理后台添加新的、可继承的字段。这种方法不仅简化了开发，还确保了与Shopware核心的兼容性和未来可维护性，避免了手动扩展可能带来的复杂问题。

# vue # js # 前端 # app # v-if # ai # 多语言 # vue组件 # 数据类型 # Float # Boolean # xml # 标识符 # 继承 # console # number # function # 对象 # 数据库 # ui # 自定义 # 你可以 # 如果你 # 绑定 # 你在 # 浮点数 # 是一个 # 出现在 # 并在