equals总结以及hashSet去重原理

equals() 方法总结

equals()

超类 Object 中有这个 equals() 方法,该方法主要用于比较两个对象是否相等。该方法的源码如下:


    public boolean equals(Object obj) {
        return (this == obj);
        }

所有的对象都拥有标识(内存地址)和状态(数据),同时“==”比较两个对象的的内存地址,所以说使用 Object 的 equals() 方法是比较两个对象的内存地址是否相等,即若 object1.equals(object2) 为 true,则表示 equals1 和 equals2 实际上是引用同一个对象。虽然有时候 Object 的 equals() 方法可以满足我们一些基本的要求,但是我们必须要清楚我们很大部分时间都是进行两个对象的比较,这个时候 Object 的 equals() 方法就不可以了,实际上 JDK 中,String、Math 等封装类都对 equals() 方法进行了重写。下面是 String 的 equals() 方法:


    public boolean equals(Object anObject) {
        if (this == anObject) {
            return true;
        }
        if (anObject instanceof String) {
            String anotherString = (String)anObject;
            int n = count;
            if (n == anotherString.count) {
            char v1[] = value;
            char v2[] = anotherString.value;
            int i = offset;
            int j = anotherString.offset;
            while (n-- != 0) {
                if (v1[i++] != v2[j++])
                return false;
            }
            return true;
            }
        }
        return false;
        }

对于这个代码段:if (v1[i++] != v2[j++])return false;我们可以非常清晰的看到 String 的 equals() 方法是进行内容比较,而不是引用比较。至于其他的封装类都差不多。

在 Java 规范中,它对 equals() 方法的使用必须要遵循如下几个规则:

equals 方法在非空对象引用上实现相等关系:

1、自反性:对于任何非空引用值 x,x.equals(x) 都应返回 true。

2、对称性:对于任何非空引用值 x 和 y,当且仅当 y.equals(x) 返回 true 时,x.equals(y) 才应返回 true。

3、传递性:对于任何非空引用值 x、y 和 z,如果 x.equals(y) 返回 true,并且 y.equals(z) 返回 true,那么 x.equals(z) 应返回 true。

4、一致性:对于任何非空引用值 x 和 y,多次调用 x.equals(y) 始终返回 true 或始终返回 false,前提是对象上 equals 比较中所用的信息没有被修改。

5、对于任何非空引用值 x,x.equals(null) 都应返回 false。

对于上面几个规则,我们在使用的过程中最好遵守,否则会出现意想不到的错误。

在 java 中进行比较,我们需要根据比较的类型来选择合适的比较方式:

1) 对象域,使用 equals 方法 。

2) 类型安全的枚举,使用 equals 或== 。

3) 可能为 null 的对象域 : 使用 == 和 equals 。

4) 数组域 : 使用 Arrays.equals 。

5)除 float 和 double 外的原始数据类型 : 使用 == 。

6) float 类型: 使用 Float.foatToIntBits 转换成 int 类型,然后使用==。

7) double 类型: 使用 Double.doubleToLongBit 转换成 long 类型,然后使用==。

至于6)、7)为什么需要进行转换,我们可以参考他们相应封装类的 equals() 方法,下面的是 Float 类的:


    public boolean equals(Object obj) {
        return (obj instanceof Float)
               && (floatToIntBits(((Float)obj).value) ==   floatToIntBits(value));
        }

原因嘛,里面提到了两点:


    However, there are two exceptions:
    If f1 and f2 both represent
    Float.NaN, then the equals method returns
    true, even though Float.NaN==Float.NaN
    has the value false.
    If <code>f1 represents +0.0f while
    f2 represents -0.0f, or vice
    versa, the equal test has the value
    false, even though 0.0f==-0.0f
    has the value true.
System.out.println(0.0f==-0.0f); 为true
System.out.println(Float.NaN == Float.NaN); 为False

在 equals() 中使用 getClass 进行类型判断

在覆写 equals() 方法时,推荐使用 getClass 来进行类型判断,不是使用 instanceof。我们都清楚 instanceof 的作用是判断其左边对象是否为其右边类的实例,返回 boolean 类型的数据。可以用来判断继承中的子类的实例是否为父类的实现。注意后面这句话:可以用来判断继承中的子类的实例是否为父类的实现,正是这句话在作怪。我们先看如下实例(摘自《高质量代码 改善 Java 程序的 151 个建议》)。

父类:Person


    public class Person {
        protected String name;

        public String getName() {
            return name;
        }

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

        public Person(String name){
            this.name = name;
        }

        public boolean equals(Object object){
            if(object instanceof Person){
                Person p = (Person) object;
                if(p.getName() == null || name == null){
                    return false;
                }
                else{
                    return name.equalsIgnoreCase(p.getName ());
                }
            }
            return false;
       }
    }

子类:Employee


    public class Employee extends Person{
        private int id;

        public int getId() {
            return id;
        }

        public void setId(int id) {
            this.id = id;
        }

        public Employee(String name,int id){
            super(name);
            this.id = id;
        }

        /**
         * 重写equals()方法
         */
        public boolean equals(Object object){
            if(object instanceof Employee){
                Employee e = (Employee) object;
                return super.equals(object) && e.getId() == id;
            }
            return false;
        }
    }

上面父类 Person 和子类 Employee 都重写了 equals(),不过 Employee 比父类多了一个id属性。测试程序如下:


    public class Test {
        public static void main(String[] args) {
            Employee e1 = new Employee("chenssy", 23);
            Employee e2 = new Employee("chenssy", 24);
            Person p1 = new Person("chenssy");

            System.out.println(p1.equals(e1));
            System.out.println(p1.equals(e2));
            System.out.println(e1.equals(e2));
        }
    }

上面定义了两个员工和一个普通人,虽然他们同名,但是他们肯定不是同一人,所以按理来说输出结果应该全部都是 false,但是事与愿违,结果是:true、true、false。

对于那 e1!=e2 我们非常容易理解,因为他们不仅需要比较 name,还需要比较 ID。但是 p1 即等于 e1 也等于 e2,这是非常奇怪的,因为 e1、e2 明明是两个不同的类,但为什么会出现这个情况?首先 p1.equals(e1),是调用 p1 的 equals 方法,该方法使用 instanceof 关键字来检查 e1 是否为 Person 类,这里我们再看看 instanceof:判断其左边对象是否为其右边类的实例,也可以用来判断继承中的子类的实例是否为父类的实现。他们两者存在继承关系,肯定会返回 true 了,而两者 name 又相同,所以结果肯定是 true。

所以出现上面的情况就是使用了关键字 instanceof,这是非常容易“专空子”的。故在覆写 equals 时推荐使用 getClass 进行类型判断。而不是使用 instanceof。

hashSet去重原理

Java中的set是一个不包含重复元素的集合,确切地说,是不包含e1.equals(e2)的元素对。Set中允许添加null。Set不能保证集合里元素的顺序。

在往set中添加元素时,如果指定元素不存在,则添加成功。也就是说,如果set中不存在(e==null ? e1==null : e.queals(e1))的元素e1,则e1能添加到set中。


下面以set的一个实现类HashSet为例,简单介绍一下set不重复实现的原理:

[java]  view plain  copy
  1. package com.darren.test.overide;  
  2.   
  3. public class CustomString {  
  4.     private String value;  
  5.   
  6.     public CustomString() {  
  7.         this("");  
  8.     }  
  9.   
  10.     public CustomString(String value) {  
  11.         this.value = value;  
  12.     }  
  13. }  

[java]  view plain  copy
  1. package com.darren.test.overide;  
  2.   
  3. import java.util.HashSet;  
  4. import java.util.Set;  
  5.   
  6. public class HashSetTest {  
  7.     public static void main(String[] args) {  
  8.         String a = new String("A");  
  9.         String b = new String("A");  
  10.           
  11.         CustomString c = new CustomString("B");  
  12.         CustomString d = new CustomString("B");  
  13.           
  14.         System.out.println("a.equals(b) == " + a.equals(b));  
  15.         System.out.println("c.equals(d) == " + c.equals(d));  
  16.           
  17.         Set<Object> set = new HashSet<Object>();  
  18.         set.add(a);  
  19.         set.add(b);  
  20.         set.add(c);  
  21.         set.add(d);  
  22.           
  23.         System.out.println("set.size() == " + set.size());  
  24.           
  25.         for (Object object : set) {  
  26.             System.out.println(object);  
  27.         }  
  28.     }  
  29. }  

运行结果如下:

[plain]  view plain  copy
  1. a.equals(b) == true  
  2. c.equals(d) == false  
  3. set.size() == 3  
  4. com.darren.test.overide.CustomString@2c39d2  
  5. A  
  6. com.darren.test.overide.CustomString@5795ce  


也许你已经看出关键来了,没错就是equals方法。这么说还是不恰当,准确的说应该是equals和hashcode方法。为什么这么说呢,让我们改一改CustomString类在进行测试:

[java]  view plain  copy
  1. package com.darren.test.overide;  
  2.   
  3. public class CustomString {  
  4.     private String value;  
  5.   
  6.     public CustomString() {  
  7.         this("");  
  8.     }  
  9.   
  10.     public CustomString(String value) {  
  11.         this.value = value;  
  12.     }  
  13.   
  14.     @Override  
  15.     public boolean equals(Object obj) {  
  16.         if (this == obj) {  
  17.               
  18.             return true;  
  19.         } else if (obj instanceof CustomString) {  
  20.             CustomString customString = (CustomString) obj;  
  21.               
  22.             return customString.value.equals(value);  
  23.         } else {  
  24.               
  25.             return false;  
  26.         }  
  27.     }  
  28. }  

测试结果:

[html]  view plain  copy
  1. a.equals(b) == true  
  2. c.equals(d) == true  
  3. set.size() == 3  
  4. com.darren.test.overide.CustomString@12504e0  
  5. A  
  6. com.darren.test.overide.CustomString@1630eb6  

这次的equals返回值都为true,但是set的size还是3

让我们继续改

[java]  view plain  copy
  1. package com.darren.test.overide;  
  2.   
  3. public class CustomString {  
  4.     private String value;  
  5.   
  6.     public CustomString() {  
  7.         this("");  
  8.     }  
  9.   
  10.     public CustomString(String value) {  
  11.         this.value = value;  
  12.     }  
  13.   
  14.     @Override  
  15.     public int hashCode() {  
  16.         // return super.hashCode();  
  17.         return 1;  
  18.     }  
  19. }  

再看结果:

[plain]  view plain  copy
  1. a.equals(b) == true  
  2. c.equals(d) == false  
  3. set.size() == 3  
  4. com.darren.test.overide.CustomString@1  
  5. com.darren.test.overide.CustomString@1  
  6. A  


只重写hashCode方法,不重写equals方法也不行

最后再改一改

[java]  view plain  copy
  1. package com.darren.test.overide;  
  2.   
  3. public class CustomString {  
  4.     private String value;  
  5.   
  6.     public CustomString() {  
  7.         this("");  
  8.     }  
  9.   
  10.     public CustomString(String value) {  
  11.         this.value = value;  
  12.     }  
  13.   
  14.     @Override  
  15.     public boolean equals(Object obj) {  
  16.         if (this == obj) {  
  17.   
  18.             return true;  
  19.         } else if (obj instanceof CustomString) {  
  20.             CustomString customString = (CustomString) obj;  
  21.   
  22.             return customString.value.equals(value);  
  23.         } else {  
  24.   
  25.             return false;  
  26.         }  
  27.     }  
  28.   
  29.     @Override  
  30.     public int hashCode() {  
  31.         // return super.hashCode();  
  32.         return 1;  
  33.     }  
  34. }  

最后结果:

[plain]  view plain  copy
  1. a.equals(b) == true  
  2. c.equals(d) == true  
  3. set.size() == 2  
  4. com.darren.test.overide.CustomString@1  
  5. A  


可以了,证明需要重写equals方法和hashCode方法,来看原理:

java.lnag.Object中对hashCode的约定:

1. 在一个应用程序执行期间,如果一个对象的equals方法做比较所用到的信息没有被修改的话,则对该对象调用hashCode方法多次,它必须始终如一地返回同一个整数。

2. 如果两个对象根据equals(Object o)方法是相等的,则调用这两个对象中任一对象的hashCode方法必须产生相同的整数结果。

3. 如果两个对象根据equals(Object o)方法是不相等的,则调用这两个对象中任一个对象的hashCode方法,不要求产生不同的整数结果。但如果能不同,则可能提高散列表的性能。


在HashSet中,基本的操作都是有HashMap底层实现的,因为HashSet底层是用HashMap存储数据的。当向HashSet中添加元素的时候,首先计算元素的hashcode值,然后用这个(元素的hashcode)%(HashMap集合的大小)+1计算出这个元素的存储位置,如果这个位置位空,就将元素添加进去;如果不为空,则用equals方法比较元素是否相等,相等就不添加,否则找一个空位添加。

如下是HashSet的部分源码:

[java]  view plain  copy
  1. package java.util;  
  2.   
  3. public class HashSet<E> extends AbstractSet<E>   
  4.     implements Set<E>, Cloneable, java.io.Serializable  
  5. {  
  6.     static final long serialVersionUID = -5024744406713321676L;     
  7.   
  8.     // 底层使用HashMap来保存HashSet中所有元素。     
  9.     private transient HashMap<E,Object> map;     
  10.      
  11.     // 定义一个虚拟的Object对象作为HashMap的value,将此对象定义为static final。     
  12.     private static final Object PRESENT = new Object();     
  13.   
  14.     /**  
  15.      * 默认的无参构造器,构造一个空的HashSet。  
  16.      *   
  17.      * 实际底层会初始化一个空的HashMap,并使用默认初始容量为16和加载因子0.75。  
  18.      */     
  19.     public HashSet() {  
  20.         map = new HashMap<E,Object>();  
  21.     }  
  22.   
  23.     /**  
  24.      * 构造一个包含指定collection中的元素的新set。  
  25.      *  
  26.      * 实际底层使用默认的加载因子0.75和足以包含指定  
  27.      * collection中所有元素的初始容量来创建一个HashMap。  
  28.      * @param c 其中的元素将存放在此set中的collection。  
  29.      */     
  30.     public HashSet(Collection< extends E> c) {  
  31.         map = new HashMap<E,Object>(Math.max((int) (c.size()/.75f) + 116));  
  32.         addAll(c);  
  33.     }  
  34.   
  35.     /**  
  36.      * 以指定的initialCapacity和loadFactor构造一个空的HashSet。  
  37.      *  
  38.      * 实际底层以相应的参数构造一个空的HashMap。  
  39.      * @param initialCapacity 初始容量。  
  40.      * @param loadFactor 加载因子。  
  41.      */     
  42.     public HashSet(int initialCapacity, float loadFactor) {  
  43.         map = new HashMap<E,Object>(initialCapacity, loadFactor);  
  44.     }  
  45.   
  46.     /**  
  47.      * 以指定的initialCapacity构造一个空的HashSet。  
  48.      *  
  49.      * 实际底层以相应的参数及加载因子loadFactor为0.75构造一个空的HashMap。  
  50.      * @param initialCapacity 初始容量。  
  51.      */     
  52.     public HashSet(int initialCapacity) {  
  53.         map = new HashMap<E,Object>(initialCapacity);  
  54.     }  
  55.   
  56.     /**  
  57.      * 以指定的initialCapacity和loadFactor构造一个新的空链接哈希集合。  
  58.      * 此构造函数为包访问权限,不对外公开,实际只是是对LinkedHashSet的支持。  
  59.      *  
  60.      * 实际底层会以指定的参数构造一个空LinkedHashMap实例来实现。  
  61.      * @param initialCapacity 初始容量。  
  62.      * @param loadFactor 加载因子。  
  63.      * @param dummy 标记。  
  64.      */     
  65.     HashSet(int initialCapacity, float loadFactor, boolean dummy) {  
  66.         map = new LinkedHashMap<E,Object>(initialCapacity, loadFactor);  
  67.     }  
  68.   
  69.     /**  
  70.      * 返回对此set中元素进行迭代的迭代器。返回元素的顺序并不是特定的。  
  71.      *   
  72.      * 底层实际调用底层HashMap的keySet来返回所有的key。  
  73.      * 可见HashSet中的元素,只是存放在了底层HashMap的key上,  
  74.      * value使用一个static final的Object对象标识。  
  75.      * @return 对此set中元素进行迭代的Iterator。  
  76.      */     
  77.     @Override  
  78.     public Iterator<E> iterator() {  
  79.         return map.keySet().iterator();  
  80.     }  
  81.   
  82.     /**  
  83.      * 返回此set中的元素的数量(set的容量)。  
  84.      *  
  85.      * 底层实际调用HashMap的size()方法返回Entry的数量,就得到该Set中元素的个数。  
  86.      * @return 此set中的元素的数量(set的容量)。  
  87.      */     
  88.     @Override  
  89.     public int size() {  
  90.         return map.size();  
  91.     }  
  92.   
  93.     /**  
  94.      * 如果此set不包含任何元素,则返回true。  
  95.      *  
  96.      * 底层实际调用HashMap的isEmpty()判断该HashSet是否为空。  
  97.      * @return 如果此set不包含任何元素,则返回true。  
  98.      */     
  99.     @Override  
  100.     public boolean isEmpty() {  
  101.         return map.isEmpty();  
  102.     }  
  103.   
  104.     /**  
  105.      * 如果此set包含指定元素,则返回true。  
  106.      * 更确切地讲,当且仅当此set包含一个满足(o==null ? e==null : o.equals(e))  
  107.      * 的e元素时,返回true。  
  108.      *  
  109.      * 底层实际调用HashMap的containsKey判断是否包含指定key。  
  110.      * @param o 在此set中的存在已得到测试的元素。  
  111.      * @return 如果此set包含指定元素,则返回true。  
  112.      */     
  113.     @Override  
  114.     public boolean contains(Object o) {  
  115.         return map.containsKey(o);  
  116.     }  
  117.   
  118.     /**  
  119.      * 如果此set中尚未包含指定元素,则添加指定元素。  
  120.      * 更确切地讲,如果此 set 没有包含满足(e==null ? e2==null : e.equals(e2))  
  121.      * 的元素e2,则向此set 添加指定的元素e。  
  122.      * 如果此set已包含该元素,则该调用不更改set并返回false。  
  123.      *  
  124.      * 底层实际将将该元素作为key放入HashMap。  
  125.      * 由于HashMap的put()方法添加key-value对时,当新放入HashMap的Entry中key  
  126.      * 与集合中原有Entry的key相同(hashCode()返回值相等,通过equals比较也返回true),  
  127.      * 新添加的Entry的value会将覆盖原来Entry的value,但key不会有任何改变,  
  128.      * 因此如果向HashSet中添加一个已经存在的元素时,新添加的集合元素将不会被放入HashMap中,  
  129.      * 原来的元素也不会有任何改变,这也就满足了Set中元素不重复的特性。  
  130.      * @param e 将添加到此set中的元素。  
  131.      * @return 如果此set尚未包含指定元素,则返回true。  
  132.      */     
  133.     @Override  
  134.     public boolean add(E e) {  
  135.         return map.put(e, PRESENT)==null;  
  136.     }  
  137.   
  138.     /**  
  139.      * 如果指定元素存在于此set中,则将其移除。  
  140.      * 更确切地讲,如果此set包含一个满足(o==null ? e==null : o.equals(e))的元素e,  
  141.      * 则将其移除。如果此set已包含该元素,则返回true  
  142.      * (或者:如果此set因调用而发生更改,则返回true)。(一旦调用返回,则此set不再包含该元素)。  
  143.      *  
  144.      * 底层实际调用HashMap的remove方法删除指定Entry。  
  145.      * @param o 如果存在于此set中则需要将其移除的对象。  
  146.      * @return 如果set包含指定元素,则返回true。  
  147.      */     
  148.     @Override  
  149.     public boolean remove(Object o) {  
  150.         return map.remove(o)==PRESENT;  
  151.     }  
  152.   
  153.     /**  
  154.      * 从此set中移除所有元素。此调用返回后,该set将为空。  
  155.      *  
  156.      * 底层实际调用HashMap的clear方法清空Entry中所有元素。  
  157.      */     
  158.     @Override  
  159.     public void clear() {  
  160.         map.clear();  
  161.     }  
  162. }  

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值