HashMap内存内存溢出问题

内存溢出

内存溢出就是内存超出了JVM虚拟机的内存容量，导致出现了java.lang.OutOfMemoryError异常，如下图所示：

image.png

示例演示

演示代码如下：

/**
 * 演示内存泄露
 */
public class HashMapOverTest {
    public static void main(String[] args) {
        Map<HashKey2, Integer> map = new HashMap<HashKey2, Integer>(1000);
        int counter = 0;
        while (true) {
            //循环插入新对象
            HashKey2 p = new HashKey2("zhangsan", "12333-suu-1232");
            map.put(p, 1);
            counter++;
            if (counter % 1000 == 0) {
                System.out.println("map size: " + map.size());
                System.out.println("运行" + counter
                        + "次后，可用内存剩余" + Runtime.getRuntime().freeMemory() / (1024*1024) + "MB");
            }
        }
    }
}
​
/**
 * 用于测试的key 类
 */
class HashKey2 {
    private final String id;
    private String name;
    public HashKey2(String name, String id) {
        this.name = name;
        this.id = id;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Override
    public int hashCode() {
        return id.hashCode();
    }
}

为了加速内存泄露现象的出现，在运行上述代码前，可以将JVM虚拟机的内存设置为3M。

-Xmx3M -Xms3M

image.png

问题分析

下面的代码我们原本期望是更新map中的值，而不是插入新值，但代码在运行时，每次都作为新对象插入到了map中，最终导致map中存放的对象太多，超过了JVM虚拟机的内存限制，出现内存溢出。

HashKey2 p = new HashKey2("zhangsan", "12333-suu-1232");
map.put(p, 1);

那么为什么HashMap每次都插入了新对象，而不是修改原对象呢？

这就是我们HashKey2这个类导致的，这个类重写了hashCode方法，但并没有重写equals方法，而HashMap中判断key是否相同是根据e.hash == hash && ((k = e.key) == key || key.equals(k))判断的，首先hash相等，这个我们的HashKey2满足，然后判断key是否是同一个对象或者key相等。我们每次都是new的新对象，所以和HashMap中存在key肯定不是同一个对象，而equals方法我们并没有实现，那么默认使用的父类也就是Object的equals方法：

    public boolean equals(Object obj) {
        return (this == obj);//还是判断是否同一个对象
    }

而我们真实场景下的判断依据可能是根据HashKey2中的name和id是否相等，来决定两个对象是否相等，所以需要们重写equals方法。

解决方案

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof HashKey2)
            return name.equals(((HashKey2) obj).name)&&id.equals(((HashKey2)obj).id);
        else
            return false;

    }

修改后再次运行代码，已经不会出现内存溢出的情况：

运行231775000次后，可用内存剩余1MB
map size: 1
运行231776000次后，可用内存剩余1MB
map size: 1
运行231777000次后，可用内存剩余1MB
map size: 1
运行231778000次后，可用内存剩余1MB
map size: 1
运行231779000次后，可用内存剩余1MB
map size: 1
运行231780000次后，可用内存剩余1MB
map size: 1
运行231781000次后，可用内存剩余1MB
。。。。。。。

自定义Key的最佳实践

内存泄露和内存溢出都是因为我们使用了自定义的Key对象引起的，所以在实践中如果需要使用自定义的类来作为HashMap的键值，一定要注意一下原则：

1. 自定义类要实现hashCode、equals方法

   这两个方法需要在自定义的类中实现，其中equals方法要根据具体场景来编写判等的依据。

2. 实现hashCode时要注意使用不可变的字段来生成hash

   不要使用会在运行期间修改的字段来生成hash，这样会造成内存泄露。