引言

在Collection集合中：
contains方法是判斷一個(gè)集合里面是否包含指定元素，如果有則返回true；
remove方法是從集合中刪除指定元素的單個(gè)實(shí)例；
這兩個(gè)方法看起很簡(jiǎn)單，用起來(lái)也很簡(jiǎn)單，同樣也非常常用；但是，它們到底是怎么匹配到相應(yīng)的元素呢？

源碼剖析

以ArrayList為例，我們分析一下ArrayList中的contains和remove的源碼；

先看看contains：

這里看到比較的對(duì)象是一個(gè)Object類，變量名為 o(就是是否包含 o )，并且調(diào)用了一個(gè)indexOf方法，接下來(lái)我們進(jìn)一步看看indexOf源碼：

可以看到，indexOf又進(jìn)一步調(diào)用了indexOfRange方法，我們還需要深入看看這個(gè)方法：

這里可以發(fā)現(xiàn)，indexOfRange中 o 調(diào)用了equals方法（藍(lán)色部分）！
我們知道：equals方法是判斷兩個(gè)對(duì)象是否相等，但是默認(rèn)情況下比較的是對(duì)象的地址，如果想要比較對(duì)象的內(nèi)容就需要重寫(xiě)equals方法；
那么這個(gè)contains調(diào)用了equals方法，所以，contains判斷一個(gè)集合中是否包含某個(gè)元素其實(shí)就是通過(guò)對(duì)象地址比較的了；
這并不是我們想要的結(jié)果，所以幾乎所有放在集合中的類型，都需要重寫(xiě)equals方法！

為什么是幾乎所有？
因?yàn)檫€是有特例的：SUN公司已經(jīng)把String類和包裝類的equals方法重寫(xiě)了，所以對(duì)于這兩種我們不需要重寫(xiě)equals！

同樣看看remove方法：

同樣，remove方法也是通過(guò)equals方法比較元素然后移除的；

所以這里可以得出一個(gè)結(jié)論：
Collection集合中的remove方法和contains方法底層都會(huì)調(diào)用equals，所以只要放在集合中的類型，都要重寫(xiě)equals方法；
因?yàn)閷?duì)對(duì)象的地址的比較沒(méi)有什么意義，我們實(shí)際上需要的是對(duì)象內(nèi)容間的比較；

實(shí)例測(cè)試

知道了結(jié)論，就來(lái)寫(xiě)幾個(gè)代碼測(cè)試一下：

String類和包裝類的特殊情況

對(duì)于 String類型和包裝類，SUN公司重寫(xiě)了equals方法，所以我們先測(cè)試一下這兩種情況：

import java.util.ArrayList; import java.util.Collection;// 結(jié)論：Collection接口中的remove方法和contains方法底層都會(huì)調(diào)用equals， // 所以存放在一個(gè)集合中的類型，要重寫(xiě)它的equals方法 // （但是String和包裝類的equals方法已經(jīng)重寫(xiě)過(guò)了，不用重寫(xiě)） public class CollectionTest02 {public static void main(String[] args) {// 這里以ArrayList為例Collection array1 = new ArrayList();// String類：String s1 = "Hello";// 將s1放入array1array1.add(s1);// 定義一個(gè)s2也為 "Hello"，那么調(diào)用contains是否會(huì)包含s2？String s2 = "Hello";System.out.println("array1是否包含s2？" + array1.contains(s2)); // true// 因?yàn)閍rray1中放入的是s1，如果移除s2，s1會(huì)不會(huì)被移除呢？array1.remove(s2);System.out.println("移除s2后s1是否還在array1中？" + array1.contains(s1)); // false// 包裝類也同樣：Integer num1 = 1000;// 將num1放入array1array1.add(num1);// 定義一個(gè)num2也為1000Integer num2 = 1000;System.out.println("array1是否包含num2？" + array1.contains(num2)); // true// 移除num2觀察num1是否會(huì)被移除array1.remove(num2);System.out.println("移除num2后num1是否還在array1中？" + array1.contains(num1)); // false} }

輸出結(jié)果：

array1是否包含s2？true 移除s2后s1是否還在array1中？false array1是否包含num2？true 移除num2后num1是否還在array1中？false

自定義類型

這是equals重寫(xiě)的情況，接下來(lái)我自定義一個(gè)類型，看看沒(méi)有重寫(xiě)會(huì)發(fā)生什么；

import java.util.ArrayList; import java.util.Collection;public class CollectionTest03 {public static void main(String[] args) {// 還是以ArrayList為例Collection array = new ArrayList();// 創(chuàng)建一個(gè)User對(duì)象u1User u1 = new User("張三");// 將u1對(duì)象放入array中array.add(u1);// 再創(chuàng)建一個(gè)User對(duì)象,使其內(nèi)容和u1相同都為"張三"，那么調(diào)用contains是否會(huì)包含該對(duì)象呢？System.out.println("array中是否包含新創(chuàng)建的對(duì)象？" + array.contains(new User("張三"))); // false// 移除一個(gè)內(nèi)容為"張三"的新的對(duì)象，u1是否會(huì)被移除？array.remove(new User("張三"));System.out.println("移除后u1是否存在？" + array.contains(u1)); // true} }// 自己定義一個(gè)User類 class User {// 成員變量：姓名private String name;// 默認(rèn)構(gòu)造User() {}// 有參構(gòu)造：初始化姓名User(String name) {this.name = name;} }

輸出結(jié)果：

array中是否包含新創(chuàng)建的對(duì)象？false 移除后u1是否存在？true

可以看到，我自定義的User方法里沒(méi)有重寫(xiě)equals方法，所以當(dāng)調(diào)用contains和remove時(shí)，雖然傳入的對(duì)象內(nèi)容和u1的對(duì)象內(nèi)容相同都為“張三”，但是實(shí)際上比較的卻是對(duì)象的地址；

接下來(lái)我重寫(xiě)User的equals方法，看看結(jié)果如何；

import java.util.ArrayList; import java.util.Collection;public class CollectionTest03 {public static void main(String[] args) {// 還是以ArrayList為例Collection array = new ArrayList();// 創(chuàng)建一個(gè)User對(duì)象u1User u1 = new User("張三");// 將u1對(duì)象放入array中array.add(u1);// 再創(chuàng)建一個(gè)User對(duì)象,使其內(nèi)容和u1相同都為"張三"，那么調(diào)用contains是否會(huì)包含該對(duì)象呢？System.out.println("array中是否包含新創(chuàng)建的對(duì)象？" + array.contains(new User("張三"))); // true// 移除一個(gè)內(nèi)容為"張三"的新的對(duì)象，u1是否會(huì)被移除？array.remove(new User("張三"));System.out.println("移除后u1是否存在？" + array.contains(u1)); // false} }// 自己定義一個(gè)User類 class User {// 成員變量：姓名private String name;// 默認(rèn)構(gòu)造User() {}// 有參構(gòu)造：初始化姓名User(String name) {this.name = name;}// 重寫(xiě)equals方法 ，通過(guò)name進(jìn)行比較public boolean equals(Object o) {if (this == o) return true;if (!(o instanceof User)) return false;User user = (User) o;return name.equals(user.name);} }

輸出結(jié)果：

array中是否包含新創(chuàng)建的對(duì)象？true 移除后u1是否存在？false

我只是重寫(xiě)了一個(gè)equals方法，其他地方都沒(méi)變，結(jié)果完全不同；

所以這就驗(yàn)證了之前的結(jié)論：contains 和 remove 底層實(shí)現(xiàn)都調(diào)用了equals方法；

總結(jié)

其實(shí)這篇文章就是分析一下contains 和 remove 底層實(shí)現(xiàn)，主要想說(shuō)的還是那一句話：
Collection集合中的remove方法和contains方法底層都會(huì)調(diào)用equals，所以只要放在集合中的類型，都要重寫(xiě)equals方法；（String和包裝類除外）

希望各位在Java學(xué)習(xí)中養(yǎng)成好習(xí)慣，要時(shí)刻惦記著equals的重寫(xiě)，不然如果做了一個(gè)項(xiàng)目你連錯(cuò)在哪里都不好找到；

總結(jié)

以上是生活随笔為你收集整理的Collection集合中的 contains 和 remove 使用深入——为什么要重写equals() ?的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。