equalsignorecase方法_覆写equals方法时不要识别不出自己

点击上方蓝色关注我们！

我们在写一个JavaBean时，经常会覆写equals方法，其目的是根据业务规则判断两个对象是否相等，比如我们写一个Person类，然后根据姓名判断两个实例对象是否相同，这在DAO(Data Access Objects)层是经常用到的。具体操作是先从数据库中获得两个DTO(Data Transfer Object，数据传输对象)，然后判断它们是否是相等的，代码如下：

class Person{
  private String name;
  
  public Person(String _name){
    name = _name;
  }
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  @Override
  public boolean equals(Object obj) {
    if(obj instanceof Person){
      Person p = (Person) obj;
      return name.equalsIgnoreCase(p.getName().trim());
    }
    return false;
  }
}

覆写的equals做了多个校验，考虑到从Web上传递过来的对象有可能输入了前后空格，所以用trim方法剪切一下，看看代码有没有问题，我们写一个main：

public class Client {
  public static void main(String[] args) {
    Person p1 = new Person("张三");
    Person p2 = new Person("张三 ");
    
    List l =new ArrayList();
    l.add(p1);
    l.add(p2);
    System.out.println("列表中是否包含张三："+l.contains(p1));
    System.out.println("列表中是否包含张三 ："+l.contains(p2));
  }
}

上面的代码产生了两个Person对象(注意p2变量中的那个张三后面有一个空格)，然后放到List中，最后判断List是否包含了这两个对象。看上去没有问题，应该打印出两个true才是，但是结果却是：

列表中是否包含张三：true

列表中是否包含张三：false

刚刚放到list中的对象竟然说没有，这太让人失望了，原因何在呢？List类检查是否包含元素时是通过调用对象的equals方法来判断的，也就是说constains(p2)传递进去，会依次执行p2.equals(p1)、p2.equals(p2)，只要有一个返回true，结果就是true，可惜的是比较结果都是false，那问题就出来了：难道p2.equals(p2)也为false不成？还真说对了，p2.equals(p2)确实是false，看看我们的equals方法，它把第二个参数进行了剪切！也就是说比较的是如下等式：

“张三 ”.equalsIgnoreCase("张三")

注意前面的“张三”是有空格的，那这个结果肯定是false了，错误也就此产生了。这是一个想做好事却办成了“坏事”的典型案例，它违背了equals方法的自反性原则：对于任何非空引用x，x.equals(x)应该返回true。

问题知道了，解决也非常容易，只要把trim()去掉即可，注意解决的只是当前问题，该equals方法还存在其他问题。

本文转载自：《编写高质量代码：改善java程序的151个建议》

作者：秦小波

声明：本文只供学习使用，未涉及任何商业利益，如有侵权，立删。