Vaadin 24如何通过ID获取Grid.Column及ID与Key的区别

问题场景 #

在Vaadin 24中使用GridContextMenuOpenedEvent时，该事件仅返回列的ID，但Grid仅提供getColumnByKey(String)方法来获取列对象。若之前通过Column#setId(String)设置的ID与Column#setKey(String)设置的Key不一致，直接用事件返回的ID调用getColumnByKey会无法获取到目标列，示例代码无法正常工作：

menu.addGridContextMenuOpenedListener(e -> {
  // 无法正常工作，因为ID≠Key
  LOG.info(e.getColumnId().map(s -> grid.getColumnByKey(s)).map(c -> c.getHeaderText()).orElse("??"));
});

Column Key与ID的核心区别 #

• Column Key：开发者自定义的业务级唯一标识，属于Vaadin公开API的一部分，专门用于程序化访问列对象，可通过Grid#getColumnByKey(String)直接获取对应列，是官方推荐的列标识方式。
• Column ID：Vaadin框架内部使用的标识符，主要用于组件渲染、事件系统等内部逻辑，不属于公开API范畴，不建议开发者直接依赖它实现业务逻辑。GridContextMenuOpenedEvent返回ID是事件系统的内部实现细节。
• Grid#getColumnByInternalId()：包私有方法，仅Vaadin框架内部使用，开发者无法直接调用，也不应通过反射等方式强行使用，避免后续版本兼容性问题。

解决方案 #

方案1：统一使用Column Key #

在创建列时直接设置Key（无需单独设置ID），同时确保ID与Key保持一致，这样事件返回的ID可直接用于调用getColumnByKey：

// 创建列时设置Key，并将ID同步为Key值
Grid.Column<User> nameColumn = grid.addColumn(User::getName)
    .setKey("name-column")
    .setId("name-column");

// 监听菜单打开事件，通过ID（即Key）获取列
menu.addGridContextMenuOpenedListener(e -> {
    e.getColumnId().map(s -> grid.getColumnByKey(s)).map(Grid.Column::getHeaderText)
      .ifPresent(header -> LOG.info("当前列标题：{}", header));
});

方案2：维护ID与Column的映射关系 #

如果必须使用独立的ID，可在创建列时手动维护一个ID到Column的映射集合，后续在事件中通过映射获取列：

// 初始化ID与列的映射集合
Map<String, Grid.Column<User>> columnIdMap = new HashMap<>();

// 创建列并加入映射
Grid.Column<User> emailColumn = grid.addColumn(User::getEmail).setId("email-column");
columnIdMap.put(emailColumn.getId(), emailColumn);

// 监听事件时通过映射获取列
menu.addGridContextMenuOpenedListener(e -> {
    e.getColumnId().map(columnIdMap::get).map(Grid.Column::getHeaderText)
      .ifPresent(header -> LOG.info("当前列标题：{}", header));
});

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