基于值的自定义排序TreeMap导致数据丢失问题及解决方案

在使用 TreeMap 时，如果需要根据值进行排序，通常会自定义一个 Comparator。然而，如果 Comparator 将不同的键视为相等（例如，基于值比较时，多个键对应相同的值），TreeMap 会将这些键视为重复键，从而导致数据丢失。

例如，考虑以下代码：

import java.util.*;
import java.util.Objects;

class ValueComparator implements Comparator {
    Map base;
    ValueComparator(Map base) {
        this.base = base;
    }
    @Override
    public int compare(String o1, String o2) {
        return base.get(o2).compareTo(base.get(o1));
    }
}

class Test {

    public static void main(String[] args) {
        Map map = new HashMap<>();
        map.put("a", 100);
        map.put("b", 100);
        map.put("c", 200);
        map.put("d", 300);
        map.put("e", 400);
        SortedMap sortedMap = new TreeMap<>(new ValueComparator(map));
        sortedMap.putAll(map);
        System.out.println(map);
        System.out.println(sortedMap);
    }
}

这段代码的输出结果如下：

{a=100, b=100, c=200, d=300, e=400}
{e=400, d=300, c=200, a=100}

可以看到，sortedMap 中键 "b" 丢失了。这是因为 ValueComparator 将 "a" 和 "b" 视为相等，因为它们都对应值 100。TreeMap 内部实现会将后续相同key的值覆盖掉之前的，因此导致数据丢失。

解决方案

为了解决这个问题，我们需要确保 Comparator 在比较键时，即使它们的值相等，也能区分它们。一种方法是在值相等的情况下，比较键本身。

修改后的 ValueComparator 如下：

import java.util.*;
import java.util.Objects;

class ValueComparator implements Comparator {
    Map base;
    ValueComparator(Map base) {
        this.base = base;
    }
    @Override
    public int compare(String o1, String o2) {
        int comparison = base.get(o2).compareTo(base.get(o1));
        if (comparison == 0) {
            return o1.compareTo(o2); // 如果值相等，则比较键本身
        } else {
            return comparison;
        }
    }
}

class Test {

    public static void main(String[] args) {
        Map map = new HashMap<>();
        map.put("a", 100);
        map.put("b", 100);
        map.put("c", 200);
        map.put("d", 300);
        map.put("e", 400);
        SortedMap sortedMap = new TreeMap<>(new ValueComparator(map));
        sortedMap.putAll(map);
        System.out.println(map);
        System.out.println(sortedMap);
    }
}

现在，输出结果如下：

Artflow.ai

可以使用AI生成的原始角色、场景、对话，创建动画故事。

下载

{a=100, b=100, c=200, d=300, e=400}
{e=400, d=300, c=200, b=100, a=100}

可以看到，所有键都保留了下来，并且按照值进行排序。

更安全的Comparator实现

原始的 Comparator 实现还存在一个潜在的 NullPointerException 风险，如果 o1 或 o2 不存在于 base map 中，base.get(o2).compareTo(base.get(o1)) 将抛出异常。

为了避免这种情况，可以使用 Objects.compare 方法，并结合 Comparator.nullsFirst 和 Comparator.naturalOrder 来处理 null 值：

import java.util.*;
import java.util.Objects;

class ValueComparator implements Comparator {
    Map base;
    ValueComparator(Map base) {
        this.base = base;
    }
    @Override
    public int compare(String o1, String o2) {
        int comparison = Objects.compare(
            base.get(o2), base.get(o1),
            Comparator.nullsFirst(Comparator.naturalOrder())
        );
        if (comparison == 0) {
            return o1.compareTo(o2); // 如果值相等，则比较键本身
        } else {
            return comparison;
        }
    }
}

class Test {

    public static void main(String[] args) {
        Map map = new HashMap<>();
        map.put("a", 100);
        map.put("b", 100);
        map.put("c", 200);
        map.put("d", 300);
        map.put("e", 400);
        SortedMap sortedMap = new TreeMap<>(new ValueComparator(map));
        sortedMap.putAll(map);
        System.out.println(map);
        System.out.println(sortedMap);
    }
}

这个版本的 Comparator 更加健壮，能够处理 null 值，并且在值相等时比较键本身，从而避免数据丢失。

总结

在使用自定义 Comparator 对 TreeMap 进行排序时，需要特别注意 Comparator 的实现，确保它能够区分不同的键，即使它们的值相等。同时，需要考虑 null 值的情况，并使用安全的比较方法，例如 Objects.compare，以避免 NullPointerException。通过以上方法，可以确保在使用 TreeMap 进行排序时，数据的完整性和程序的稳定性。