Vaadin Grid如何处理同一属性在多列中重复的异常情况？

本文共计1473个文字，预计阅读时间需要6分钟。

Vaadin Grid 是一个功能强大的数据表格组件，它提供了多种自定义列的方式。通过构造函数传入一个实体类（例如 `new Grid()`），可以直接创建一个表格，其中 `MyEntity` 是你定义的实体类。

然而，如果在此之后，开发者又手动调用 grid.addColumns("propertyName") 方法为同一个属性添加列，就会导致冲突。Vaadin Grid检测到同一个属性（例如 auditId）被尝试创建两次列时，就会抛出 java.lang.IllegalArgumentException: Multiple columns for the same property 异常。

在提供的代码示例中，EnterpriseView 类的构造函数中存在以下两行关键代码：

this.grid = new Grid<>(Audit.class); // 这一行会自动为Audit类的所有属性创建列，包括auditId // ... grid.addColumns( "auditId" ); // 这一行又尝试手动添加一个名为"auditId"的列

正是第二行 grid.addColumns("auditId") 导致了异常，因为它试图重复定义一个已经由 new Grid<>(Audit.class) 自动创建的列。

解决方案

解决此问题有两种主要方法，具体取决于您希望如何控制Grid的列显示。

方法一：利用Vaadin的自动列生成（推荐）

如果您希望Grid自动显示实体类的所有或大部分属性，并且只需要对某些列进行微调，那么最简单的方法是完全依赖 new Grid<>(Audit.class) 的自动生成功能，并移除任何重复的 addColumns 调用。

示例代码：

import com.vaadin.flow.component.grid.Grid; import com.vaadin.flow.component.orderedlayout.VerticalLayout; import com.vaadin.flow.router.*; import com.wtd.assistant.frontend.dao.AuditDao; import com.wtd.assistant.frontend.dao.EnterpriseDao; import com.wtd.assistant.frontend.domain.Audit; import com.wtd.assistant.frontend.domain.Enterprise; import java.util.List; import java.util.Optional; @Route("EnterpriseView") public class EnterpriseView extends VerticalLayout implements HasUrlParameter<String>, AfterNavigationObserver{ private EnterpriseDao enterpriseDao; private AuditDao auditDao; private Grid<Audit> grid; private List<Audit> auditsList; private Optional<Enterprise> enterprise; private String enterpriseId; public EnterpriseView(EnterpriseDao enterpriseDao, AuditDao auditDao) { this.enterpriseDao = enterpriseDao; this.auditDao = auditDao; // 仅通过类初始化Grid，Vaadin会自动生成列 this.grid = new Grid<>(Audit.class); // 此时auditId列已经存在 VerticalLayout layout = new VerticalLayout(); layout.add(grid); // 移除重复的 grid.addColumns("auditId"); // 如果需要自定义列的顺序或可见性，可以在这里进行操作，例如： // grid.setColumns("auditId", "trip", "user", "enterprise"); // 指定显示的列及其顺序 // grid.getColumnByKey("auditId").setHeader("审计ID"); // 修改列头 } @Override public void setParameter(BeforeEvent event, String parameter) { enterpriseId = parameter; System.out.println("setParameter(), enterpriseId: " + enterpriseId); } @Override public void afterNavigation(AfterNavigationEvent event) { enterprise = enterpriseDao.findById(Integer.valueOf(enterpriseId)); System.out.println("EnterpriseId: " + enterprise.get().getEnterpriseId()); auditsList = enterprise.get().getAudits(); grid.setItems(auditsList); } }

注意事项：

• 使用 grid.setColumns("property1", "property2", ...) 方法可以指定Grid显示的列以及它们的顺序。未列出的属性将不会显示。
• 可以通过 grid.getColumnByKey("propertyName").setHeader("New Header") 来修改自动生成列的标题。
• 对于关联实体（如 Trip, User, Enterprise），Vaadin Grid默认会显示它们的 toString() 方法结果。如果需要显示关联实体的特定属性（例如 enterprise.name），需要使用 addColumn 配合 ValueProvider 或 Renderer。

方法二：完全手动控制列的创建

如果您不希望Grid自动生成任何列，而是希望完全手动地添加和配置每一列，那么可以在初始化Grid时不传入实体类，然后逐个添加所需的列。

示例代码：

import com.vaadin.flow.component.grid.Grid; import com.vaadin.flow.component.orderedlayout.VerticalLayout; import com.vaadin.flow.router.*; import com.wtd.assistant.frontend.dao.AuditDao; import com.wtd.assistant.frontend.dao.EnterpriseDao; import com.wtd.assistant.frontend.domain.Audit; import com.wtd.assistant.frontend.domain.Enterprise; import java.util.List; import java.util.Optional; @Route("EnterpriseView") public class EnterpriseView extends VerticalLayout implements HasUrlParameter<String>, AfterNavigationObserver{ private EnterpriseDao enterpriseDao; private AuditDao auditDao; private Grid<Audit> grid; private List<Audit> auditsList; private Optional<Enterprise> enterprise; private String enterpriseId; public EnterpriseView(EnterpriseDao enterpriseDao, AuditDao auditDao) { this.enterpriseDao = enterpriseDao; this.auditDao = auditDao; // 不传入实体类，Grid初始化时不会自动生成任何列 this.grid = new Grid<>(); VerticalLayout layout = new VerticalLayout(); layout.add(grid); // 手动添加所有需要的列 grid.addColumn(Audit::getAuditId).setHeader("审计ID"); // 对于关联实体，需要指定如何显示其属性 grid.addColumn(audit -> audit.getTrip() != null ? audit.getTrip().getTripName() : "").setHeader("行程名称"); grid.addColumn(audit -> audit.getUser() != null ? audit.getUser().getUserName() : "").setHeader("用户名称"); grid.addColumn(audit -> audit.getEnterprise() != null ? audit.getEnterprise().getEnterpriseName() : "").setHeader("企业名称"); // 如果需要显示所有自动生成的列，但又想手动控制，可以这样： // grid.addColumns("auditId", "trip", "user", "enterprise"); // 此时不会报错，因为Grid最初是空Grid } @Override public void setParameter(BeforeEvent event, String parameter) { enterpriseId = parameter; System.out.println("setParameter(), enterpriseId: " + enterpriseId); } @Override public void afterNavigation(AfterNavigationEvent event) { enterprise = enterpriseDao.findById(Integer.valueOf(enterpriseId)); System.out.println("EnterpriseId: " + enterprise.get().getEnterpriseId()); auditsList = enterprise.get().getAudits(); grid.setItems(auditsList); } }

注意事项：

• 当使用 new Grid<>() 初始化时，Grid是空的，不会有任何默认列。
• 您需要使用 grid.addColumn(ValueProvider<ITEM, VALUE>) 或 grid.addColumn(String propertyName) 等方法逐个添加列。
• 对于复杂属性（如关联实体），使用 ValueProvider（例如 Audit::getAuditId 或 Lambda表达式 audit -> audit.getTrip().getTripName()）可以精确控制列中显示的内容。
• 这种方法提供了最大的灵活性，可以完全控制列的显示名称、值格式、排序、过滤等。

总结

“Multiple columns for the same property”异常是Vaadin Grid中常见的配置错误，它提醒开发者注意Grid的列生成机制。核心在于避免对同一个实体属性进行重复的列定义。通过选择适合您需求的列管理策略——无论是依赖Vaadin的智能自动生成，还是进行精细的手动控制——都可以有效地解决此问题并构建出清晰、功能完善的数据表格。在实际开发中，推荐根据项目需求和团队习惯选择最合适的方案，并始终保持对Vaadin Grid列配置的清晰理解。