【Java】关于equals方法踩过的坑

发现问题

  这个坑是在写资源发现时候遇见的，具体问题可以简化成下面这个问题。

首先是默认网络节点

public class DefaultNetNode {

	private String ip;
	private int port;
	
	public DefaultNetNode(String ip, int port) {
		this.ip = ip;
		this.port = port;
	}

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

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		DefaultNetNode other = (DefaultNetNode) obj;
		if (ip == null) {
			if (other.ip != null)
				return false;
		} else if (!ip.equals(other.ip))
			return false;
		if (port != other.port)
			return false;
		return true;
	}

	
	
	@Override
	public String toString() {
		return "DefaultNetNode [ip=" + ip + ", port=" + port + "]";
	}
	
}

然后是资源持有者节点，其实有很多代码，这里为了简化所关注的问题

public class ResourceHolderNode extends DefaultNetNode {

	public ResourceHolderNode(String ip, int port) {
		super(ip, port);
	}

	
}

测试类

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

public class Demo {

	public static void main(String[] args) {
		List<DefaultNetNode> list = new ArrayList<>();
		list.add(new DefaultNetNode("127.0.0.1", 54120));
		list.add(new DefaultNetNode("127.0.0.1", 54121));
		list.add(new DefaultNetNode("127.0.0.1", 54122));
		list.add(new DefaultNetNode("127.0.0.1", 54123));
		
		System.out.println(list.contains(new ResourceHolderNode("127.0.0.1", 54122)));
	}

}

/*输出结果
false
*/

当时在这里就很疑惑？欸，怎么会没有呢（输出false）呢？在JavaSE我们学习到关于容器的contains和remove()等一些操作都会在容器中进行查询，查询的根据是相等原则（即equals方法），若没设置equals方法则是地址比较，设置了就按照相等原则比较。我不是设置了它们的比较规则是根据ip和port是否一样的equals方法了吗？为什么这里会没有呢？

其实，这里就是equals方法的大坑。

我们运用Eclipse的功能键快速生成的equals方法。

问题出现在这里是必须是比较的值和被比较的值两个类型相同！是啊，我们的DefaultNetNode和ResourceHolderNode这两者类型不同，所以不认为他俩相同，因此会出错。

所以应该修改这里为instanceof就好了。要自己手写吗？为了记忆深刻你可以这样，但是你如果继续用Eclipse的功能键，打开窗口仔细看！有一个使用instanceof来设置比较原则。

产生的新的比较原则

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (!(obj instanceof DefaultNetNode))		//这里变了，就应该是这样
			return false;
		DefaultNetNode other = (DefaultNetNode) obj;
		if (ip == null) {
			if (other.ip != null)
				return false;
		} else if (!ip.equals(other.ip))
			return false;
		if (port != other.port)
			return false;
		return true;
	}

这下我们在运行测试类就正确了。

总结

  进行一下总结。进行一个类的两个实例进行比较时，或者对于以后放在容器（Map、List）中需要进行contain、remove操作时。如果没有设置相关equals方法或者没有重写equals，那么就是按内存地址值比较。如果设置了equals方法，equals方法就是该类的实例的比较原则，这里要特别注意第三个if语句，如果你这个类会成为其他类的基类，那么要考虑是否要严格的类型必须相等或者子类也适用于比较原则！

  虽然这都是JavaSE中学过的知识，但是面对具体问题总是，“不识庐山真面目，只缘身在此山中”，这个错误我整整进行了30多分钟的代码跟踪才发现，还是要说明Java基础太重要了！有时候错误往往就出现在这种基础并且细小的地方。