Java：List（三）——编写equals方法

list.contains( Obj o )

List中提供了boolean contains( Object o )方法来判断一个元素是否包含在List中。此外，int indexOf( Object o )返回某个元素的索引下标，如果元素不存在，就返回-1。

        List<String> list = List.of("A", "B", "C");
        System.out.println(list.contains("C")); // true
        System.out.println(list.contains("X")); // false
        System.out.println(list.indexOf("C")); // 2
        System.out.println(list.indexOf("X")); // -1

List内部，并不是通过==判断两个元素是否相等，而是使用equals()判断的，例如contains()内部实现为：

public class ArrayList{
    Object[] elementData;
    public boolean contains(Object o){
        for (int i=0;i<elementData.length;i++){
            if(o.equals(elementData[i])){
                return true;
            }
        }
        return false;
    }
}

因此，要正确使用List的contains()、indexOf()这些方法，放入List的元素类型必须已经覆写equals()方法。我们能正常放入String、Integer等，正是因为这些类已经正确实现了equals()方法。

编写equals()

如果我们有一个Person类：

public class Person{
    public String name;
    public int age;
}

对它编写一个equals( )方法可以是：

public boolean equals(Object o){
    if ( o instanceof Person ){
        Person p = (Person) o;
        return this.name.equals( p.name ) && this.age==p.age;
    }
    return false;
}

以上可以看出，对于引用字段，我们使用equals()，对于基本类型字段，我们使用==。

如果Person有多个引用字段，上述写法未免太麻烦。要简化引用类型的比较，我们使用Objects.equals()静态方法：

public boolean equals(Object o){
    if(o instance Person){
        Person p =(Person) o;
        return Objects.equals(this.name,p.name) && this.age==p.age;
    }
    return false;
}

因此，可以总结编写equals()方法的正确过程：

1. 确定“相等”的意义——当哪些字段相等时才认为相等呢？
2. 用instanceof判断传入的Object是不是当前类型，不是就直接返回false，是的话才继续比较；
3. 引用类型用Objects.equals()比较，基本类型用==比较。

注意，上文是Objects.equals()而不是Object.equals()

使用Object.equals()比较两个引用类型的目的是省却了null的判断。两个引用类型都是null时它们也是相等的。

如果不调用List的contains()、indexOf()方法，那么放入的元素就不需要实现equals()方法。

注意

在覆写equals方法时，经常会犯一个错误——参数用E e而不是Object o：

//错误
public boolean equals(Person p){...}

//正确
public boolean equals(Object o){
    if(o instance Person){
        return Objects.equals(...);
    }
    return false;
}