
本文旨在解决Vaadin Grid中常见的“Multiple columns for the same property”异常。该问题通常源于对Grid初始化方式与列添加方法的误用。当使用new Grid(Entity.class)构造函数时,Vaadin Grid会自动为实体类的所有公共属性创建列;若随后再通过grid.addColumns(“propertyName”)显式添加同名列,便会导致重复定义,从而抛出异常。文章将详细解释这一机制,并提供正确的列配置方法,帮助开发者有效管理Grid的显示列。
Vaadin Grid列配置机制解析
Vaadin Grid是一个功能强大的数据表格组件,它提供了多种方式来定义和管理其显示的列。理解这些机制是避免常见配置错误的关键。
基于实体类的自动列生成当您使用new Grid(YourEntityClass.class)构造函数初始化Grid时,Vaadin Grid会智能地检查YourEntityClass中的所有公共getter方法(例如getAuditId()、getTrip()等),并为每个可识别的属性自动创建一列。这意味着,如果您有一个名为auditId的属性,并且有对应的getAuditId()方法,那么Grid在实例化时就已经自动创建了一列来显示auditId数据。
// 示例:Grid初始化时自动创建列Grid grid = new Grid(Audit.class);// 此时,grid已经包含了auditId、trip、user、enterprise等列
显式添加列Grid组件还提供了addColumns()方法,允许开发者显式地指定要显示的属性名,从而添加新的列。
// 示例:显式添加列grid.addColumns("propertyName1", "propertyName2");
此方法通常用于在Grid未通过实体类构造时,或者需要添加非实体类属性(如计算属性)时。
“Multiple columns for the same property”异常的根源
问题的核心在于对上述两种机制的混用。当您首先使用new Grid(Audit.class)来初始化Grid,让它自动为Audit实体创建所有列(包括auditId),然后又在构造函数中显式调用grid.addColumns(“auditId”),试图再次添加auditId列时,Vaadin就会检测到同一属性auditId被定义了两次。这违反了Grid的内部一致性,因此抛出IllegalArgumentException: Multiple columns for the same property: auditId异常。
问题代码示例:
// EnterpriseView.javapublic class EnterpriseView extends VerticalLayout implements HasUrlParameter, AfterNavigationObserver{ // ... 其他成员变量和构造函数 public EnterpriseView(EnterpriseDao enterpriseDao, AuditDao auditDao) { this.enterpriseDao = enterpriseDao; this.auditDao = auditDao; this.grid = new Grid(Audit.class); // 1. Grid自动为Audit实体创建所有列,包括auditId VerticalLayout layout = new VerticalLayout(); layout.add(grid); grid.addColumns( "auditId" ); // 2. 再次显式添加auditId列,导致重复 } // ... 其他方法}
解决方案
要解决这个异常,您需要确保每个属性只被Grid添加为一列。根据您的需求,有以下两种主要的解决方案:
依赖自动生成,并移除不需要的列(如果需要显示大部分列)如果您希望Grid自动生成大部分列,但又想对某些列进行定制或移除,可以继续使用new Grid(Audit.class),然后使用removeColumn()或setColumns()方法来调整。
// 解决方案一:依赖自动生成,并移除或定制public EnterpriseView(EnterpriseDao enterpriseDao, AuditDao auditDao) { this.enterpriseDao = enterpriseDao; this.auditDao = auditDao; this.grid = new Grid(Audit.class); // Grid自动创建所有列 // 示例:如果只需要auditId、trip、user,可以移除enterprise列 // grid.removeColumn(grid.getColumnByKey("enterprise")); // 假设enterprise列的key是"enterprise" // 或者,如果想完全控制显示的列,可以使用setColumns // grid.setColumns("auditId", "trip", "user"); // 仅显示这三列 VerticalLayout layout = new VerticalLayout(); layout.add(grid); // 不再调用 grid.addColumns("auditId");}
不使用实体类构造函数,手动添加所有所需列(如果只需要显示少数列或需要精细控制)如果您只想显示Audit实体中的特定几列,或者需要对每列进行更精细的控制(例如自定义渲染器),那么最好不要在构造函数中传入实体类,而是完全手动添加所有列。
// 解决方案二:手动添加所有所需列public EnterpriseView(EnterpriseDao enterpriseDao, AuditDao auditDao) { this.enterpriseDao = enterpriseDao; this.auditDao = auditDao; this.grid = new Grid(); // 不传入实体类,Grid初始为空 VerticalLayout layout = new VerticalLayout(); layout.add(grid); // 手动添加所有需要的列 grid.addColumns("auditId", "trip", "user", "enterprise"); // 添加所有需要的列 // 或者使用 addColumn 方法进行更复杂的配置,例如: // grid.addColumn(Audit::getAuditId).setHeader("审计ID"); // grid.addColumn(audit -> audit.getTrip().getName()).setHeader("行程名称"); // 示例:访问关联实体的属性}
在您提供的场景中,由于grid.addColumns(“auditId”)是唯一显式添加列的地方,最直接的修复就是移除这一行代码,因为new Grid(Audit.class)已经为您处理了auditId列的创建。
修正后的代码示例
基于上述分析,最简洁有效的修正方式是移除重复的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, AfterNavigationObserver{ private EnterpriseDao enterpriseDao; private AuditDao auditDao; private Grid grid; private List auditsList; private Optional enterprise; private String enterpriseId; public EnterpriseView(EnterpriseDao enterpriseDao, AuditDao auditDao) { this.enterpriseDao = enterpriseDao; this.auditDao = auditDao; this.grid = new Grid(Audit.class); // Vaadin Grid已自动创建auditId列 VerticalLayout layout = new VerticalLayout(); layout.add(grid); // 移除以下重复的行: // grid.addColumns( "auditId" ); } @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时,始终明确您希望列是如何生成的。是完全自动(new Grid(Class.class)),还是完全手动(new Grid()后跟addColumn或addColumns),抑或是自动生成后进行微调。使用addColumn进行高级定制: 对于需要自定义渲染器、设置列宽、对齐方式或访问关联对象属性的列,推荐使用addColumn(ValueProvider valueProvider)方法。例如,要显示关联Trip实体的名称:
grid.addColumn(audit -> audit.getTrip().getName()) .setHeader("行程名称") .setKey("tripName"); // 为列设置一个唯一的key
使用setColumns控制显示: 如果您希望Grid只显示实体中特定子集的属性,而不是所有自动生成的属性,可以使用setColumns(“prop1”, “prop2”, …)。这会清除所有现有列并添加指定的新列。列的顺序: addColumns()和addColumn()会按照调用顺序添加列。setColumns()则按照参数顺序设置列。
总结
Vaadin Grid的“Multiple columns for the same property”异常是一个典型的配置错误,源于对Grid自动列生成机制和显式列添加方法的混淆使用。通过理解new Grid(Class.class)的自动行为,并避免重复添加已存在的列,开发者可以轻松解决此问题。根据具体需求,选择完全依赖自动生成、完全手动配置或组合使用这些方法,能够更有效地管理Vaadin Grid的列显示。
以上就是Vaadin Grid列配置:避免“同一属性多列”异常的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/104109.html
微信扫一扫
支付宝扫一扫