JavaFX TableView结合FilteredList时，筛选文本变更致选中项先变为null

问题描述 #

使用JavaFX的TableView展示Person对象，通过FilteredList实现实时搜索功能。筛选前选中符合筛选条件的行，视觉上选中状态保持不变，但通过tableView.getSelectionModel().getSelectedItem()检测到选中项会先变为null，随后再恢复为原选中项。

复现步骤：

• 在TableView中选中“John”，控制台输出选中项从null变为Person对象
• 在文本框中输入“J”，仅“John”显示且行保持选中状态
• 控制台出现两条日志：选中项从John变为null，再从null变回John

原因分析 #

这是FilteredList的内部更新机制导致的：当调用filteredList.setPredicate()时，FilteredList会先清空当前的过滤结果集，再根据新的Predicate重新计算并添加符合条件的元素。在这个短暂的清空-重建过程中，原选中项会暂时从TableView的数据源中消失，SelectionModel因此将选中项设为null；当符合条件的元素重新加入列表后，TableView会自动恢复之前的选中状态，于是又触发一次选中项变更事件。

解决方案 #

方案1：过滤选中项监听中的无效null变更 #

修改selectedItemProperty的监听器，识别并跳过因过滤导致的临时null中间态：

tableView.getSelectionModel().selectedItemProperty().addListener((observable, oldValue, newValue) -> {
    // 处理过滤导致的临时null情况
    if (newValue == null && oldValue != null) {
        Person tempSelected = oldValue;
        // 延迟检查，确保FilteredList完成更新
        Platform.runLater(() -> {
            if (tableView.getSelectionModel().getSelectedItem() == tempSelected) {
                // 确认是临时null，不处理
                return;
            }
            // 真·取消选中的情况，再输出日志
            System.out.println();
            System.out.println(tempSelected + " vs null");
        });
        return;
    }
    // 处理正常的选中变更
    System.out.println();
    System.out.println(oldValue + " vs " + newValue);
});

方案2：过滤操作时临时移除监听器 #

在设置Predicate前后，先移除选中项监听器，待过滤完成后再重新添加：

// 提前定义监听器变量
ChangeListener<Person> selectionListener = (observable, oldValue, newValue) -> {
    System.out.println();
    System.out.println(oldValue + " vs " + newValue);
};

// 初始添加监听器
tableView.getSelectionModel().selectedItemProperty().addListener(selectionListener);

filterTextField.textProperty().addListener((observable, oldValue, newValue) -> {
    // 移除监听器，避免触发临时null事件
    tableView.getSelectionModel().selectedItemProperty().removeListener(selectionListener);
    
    String filterText = newValue.toLowerCase().trim();
    filteredList.setPredicate(person -> person.getName().toLowerCase().contains(filterText));
    
    // 延迟恢复监听器，确保TableView完成刷新
    Platform.runLater(() -> {
        tableView.getSelectionModel().selectedItemProperty().addListener(selectionListener);
    });
});

完整示例代码（方案1实现） #

package com.example;

import javafx.application.Application;
import javafx.application.Platform;
import javafx.beans.property.SimpleStringProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.collections.transformation.FilteredList;
import javafx.geometry.Insets;
import javafx.scene.Scene;
import javafx.scene.control.TableColumn;
import javafx.scene.control.TableView;
import javafx.scene.control.TextField;
import javafx.scene.layout.VBox;
import javafx.stage.Stage;

public class App extends Application {

    private final ObservableList<Person> personList = FXCollections.observableArrayList();
    private final FilteredList<Person> filteredList = new FilteredList<>(personList);

    public static void main(String[] args) {
        App.launch(args);
    }

    @Override
    public void start(Stage primaryStage) {
        TableView<Person> tableView = new TableView<>();
        TableColumn<Person, String> nameColumn = new TableColumn<>("Name");

        nameColumn.setCellValueFactory(cellData -> cellData.getValue().nameProperty());

        tableView.getColumns().add(nameColumn);
        tableView.setItems(filteredList);

        TextField filterTextField = new TextField();
        filterTextField.setPromptText("Enter filter text");

        filterTextField.textProperty().addListener((observable, oldValue, newValue) -> {
            String filterText = newValue.toLowerCase().trim();
            filteredList.setPredicate(person -> person.getName().toLowerCase().contains(filterText));
        });

        VBox root = new VBox(10);
        root.setPadding(new Insets(10));
        root.getChildren().addAll(filterTextField, tableView);

        Scene scene = new Scene(root, 400, 300);
        primaryStage.setScene(scene);
        primaryStage.setTitle("TableView Filter Example");
        primaryStage.show();

        // 填充测试数据
        personList.addAll(
                new Person("John"),
                new Person("Mary"),
                new Person("Adam"),
                new Person("Emma"));

        tableView.getSelectionModel().selectedItemProperty().addListener((observable, oldValue, newValue) -> {
            if (newValue == null && oldValue != null) {
                Person tempSelected = oldValue;
                Platform.runLater(() -> {
                    if (tableView.getSelectionModel().getSelectedItem() == tempSelected) {
                        return;
                    }
                    System.out.println();
                    System.out.println(tempSelected + " vs null");
                });
                return;
            }
            System.out.println();
            System.out.println(oldValue + " vs " + newValue);
        });
    }

    public static class Person {
        private final SimpleStringProperty name;

        public Person(String name) {
            this.name = new SimpleStringProperty(name);
        }

        public String getName() {
            return name.get();
        }

        public SimpleStringProperty nameProperty() {
            return name;
        }

        @Override
        public String toString() {
            return "Person{name='" + getName() + "'}";
        }
    }
}

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