Java中TreeSet的add操作失败的问题

欢迎转载，转载请在醒目处注明出处，Ron’s Blog: http://www.neilron.xyz/fail-to-add-into-a-treeset/

最近在工作中碰到一个问题，经过一行行debug最终定位到了是一个TreeSet无法add新条目的问题。

Google一番发现了TreeSet和HashSet用法有些不同，不仅不能插入Hash相同的对象，也不能插入在排序中和已有元素等价的值。

下面写了一个简单的测试例，来更形象的说明这个现象。

首先定义一个Song类，只有两个属性，歌名和评分，重写了hashCode和toString方法，Hash值只和歌名有关初始化一首歌时赋值默认分数是3分。然后按照得分高低有序地插入到一个新的TreeSet中。

class Song {

    private String name;
    private int score;

    Song(String name) {
        this.name = name;
        this.score = 3;
    }

    void setScore(int score) {
        this.score = score;
    }

    int getScore() {
        return score;
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder(17, 37)
                .append(this.name)
                .toHashCode();
    }

    @Override
    public String toString() {
        return String.format("%s\t%d", this.name, this.score);
    }
}

接下来在主函数中，初始化一个普通的HashSet和一个按分数降序排列的TreeSet，初始化两首周董的新单，注意这里初始化之后两首单曲的分数是一样的。

HashSet<Song> hashSet = new HashSet<Song>();
TreeSet<Song> treeSet = new TreeSet<Song>(new Comparator<Song>() {
    public int compare(Song o1, Song o2) {
        return o2.getScore() - o1.getScore();
    }
});

Song song1 = new Song("前世情人");
Song song2 = new Song("床边故事");

treeSet.add(song1);
treeSet.add(song2);
hashSet.add(song1);
hashSet.add(song2);

查看一下结果

System.out.println("TreeSet Result:");
for (Song song : treeSet){
    System.out.println(song);
}

System.out.println("\nHashSet Result:");
for (Song song : hashSet){
    System.out.println(song);
}

上面这段代码最后输出的结果是

TreeSet Result:
前世情人    3

HashSet Result:
前世情人    3
床边故事    3

HashSet成功地插入了两首歌，因为song1和song2的Hash值显然不同，而在TreeSet中，第二首歌《床边故事》没有被成功插入，原因就是，TreeSet不光会拒绝Hash值相同的对象，也会拒绝被自己的比较器认为是相通的对象，这里也就是两首歌的评分。

下面我们给其中一首歌重新评分，再次插入，并输出结果。

song2.setScore(4);

treeSet.add(song2);

System.out.println("\nTreeSet Result After setScore:");
for (Song song : treeSet){
    System.out.println(song);
}

TreeSet Result After setScore:
前世情人    4
床边故事    3

这一次，《床边故事》也成功插入了。

总结：

初始化对象时经常会赋予一些相同的属性值，再插入TreeSet前请保证它们在TreeSet的比较器中都是不等的，否则插入会失败。虽然是小问题，但这种问题有时候要靠调试来发现还是很麻烦的。

以上全部源码请查看：
https://github.com/NeilRon/FreeTest/blob/master/src/main/java/xyz/neilron/freetest/TreeSetTest.java