从ArrayList的contains说开来

从ArrayList的contains说开来

一、 问题的发现
最近一个小弟在使用ArrayList的contais方法的时候出现了意想不到的结果，遂跑过来问我是怎么回事。他的代码大致是这样的：有一个自定义的User类，有一个ArrayList型的User列表，调用该列表的contains方法判断是否包含某User。具体代码为：

import java.util.ArrayList;
import java.util.List;


public class ArrayListContainsTest {
 public static void main(String[] args){
  List users =  new ArrayList();
  User user1 = new User("001");
  User user2 = new User("002");
  users.add(user1);
  users.add(user2);
  System.out.println(users.contains(new User("001")));
 }
}

class User{
 private String userID;
 private String userName;
 
 public User(String userID){
  this.userID = userID;
 }
 
 public String getUserID(){
  return this.userID;
 }
 public void setUserID(String userID){
  this.userID = userID;
 }
 public String getUserName(){
  return this.userName;
 }
 public void setUserName(String userName){
  this.userName = userName;
 }
 
 public boolean equals(User user){
  if(user == null) return false;
  if(this == user) return true;
  if(userID == null){
   if(user.userID != null)
    return false;
  } else if(!userID.equals(user.userID))
   return false;
   
  return true;
 }
}

 
意想中的结果应该为打印true，因为JDK Doument中对ArrayList.contains(Object o)的说明是这样的：
如果此列表中包含指定的元素，则返回 true。更确切地讲，当且仅当此列表包含至少一个满足 (o==null ? e==null : o.equals(e)) 的元素 e 时，则返回 true。
也就是说contains(Object o)方法的返回值分两种情况得出：
1. 如果参数o为null，并且ArrayList中存在null元素，则返回真；
2. 如果参数o非null，则结果根据o的equals方法遍历ArrayList确定，具体来说，就是判断ArrayList中是否contains元素o，就是判断ArrayList中是否存在这样的元素e使得o.equals(e)。
在上边的代码中，当调用user.contains(new User(“001”))时，参数并不为null，因此根据第二种情况，就是要users 中是否存在一个user满足(new User(“001”)).equals(user)，从这个层面上讲，上面的代码确实应该返回true才对。但是仔细想来，里边却存在着问题。那么问题到底出在哪里呢？
我们首先在User类的equals方法中加入这样一行代码：

System.out.println("User.equals(User) has been called.");

 这行代码的作用是在该方法被调用时有“User.equals(User) has been called.”输出。
再次运行测试代码，发现控制台依然只输出了“false”，而没有我们上面加入的语句的输出，这就说明了我们写的equals方法并没有被调用。看到这里，我们似乎发现了问题的所在。再回过头去看JDK Document中对contains方法的说明，遍历ArrayList时调用的是Object的equals方法，而User是Object的子类（Object类是所有类的父类），因此应该调用User的equals方法，而该equals方法应该是重写（override）Object的equals方法，Object的equal方法的定义为：

public boolean equals(Object obj)

 而测试代码中的equals方法定义为：

public boolean equals(User user)

 表面上看似乎确实重写了Object的equals方法，但实质上却不然。因为子类重写父类的方法必须保证方法的申明与父类完全相同，即参数的类型也应该相同，但测试方法中的参数却为User类型，而不是期望的Object 类型，因此测试方法中的equals方法只是User类中定义的一个新方法而已。

二、 问题修改
既然发现了问题，我们就从问题入手。在User类中override Object类的equals方法：

@Override
 public int hashCode() {
  final int prime = 31;
  int result = 1;
  result = prime * result + ((userID == null) ? 0 : userID.hashCode());
  return result;
 }

 @Override
 public boolean equals(Object obj) {
  System.out.println("User.equals(Object) has been called.");
  if (this == obj)
   return true;
  if (obj == null)
   return false;
  if (getClass() != obj.getClass())
   return false;
  final User other = (User) obj;
  if (userID == null) {
   if (other.userID != null)
    return false;
  } else if (!userID.equals(other.userID))
   return false;
  return true;
 }

 

再次运行测试程序，有如下输出：

User.equals(Object) has been called.
true

 
终于达到了我们想要的效果。写到这里需要提醒的是，equals方法被重写时，通常有必要重写 hashCode 方法，以维护 hashCode 方法的常规协定，该协定声明相等对象必须具有相等的哈希码。

三、 源码剖析
为了验证我们的推理过程，我们查看了ArrayList的contains方法的源码：

public boolean contains(Object elem) {
 return indexOf(elem) >= 0;
    }

 
ArrayList的index 方法的源码：

public int indexOf(Object elem) {
 if (elem == null) {
     for (int i = 0; i < size; i++)
  if (elementData[i]==null)
      return i;
 } else {
     for (int i = 0; i < size; i++)
  if (elem.equals(elementData[i]))
      return i;
 }
 return -1;
    }

 
四、 总结
通过上述微小的错误暴露了编程中经常被忽略的细节，需要注意的是：
1. List的contains方法调用的是重写(override)Object的equals方法；
2. 子类重写(override)Object方法的equals方法时必须保证参数为Object；
3. 子类子类重写(override)Object方法的equals方法的同时通常也应重写hashCode方法。