避免低级错误：深入解析Java的ConcurrentModificationException异常

在软件开发中，我们常常会遇到各种错误和异常。其中有一类比较低级但又常见的错误就是ConcurrentModificationException异常。最近了我就写了个这种异常，这个异常通常发生在使用迭代器遍历集合时，同时对集合进行修改，从而导致迭代器检测到集合结构发生变化而抛出异常。在测试环境中可能因为数据量较小或者测试场景不充分未能显现问题，但一旦部署到生产环境，场景增多，并发操作增多，这个低级错误就会爆发。

有问题的代码

在使用entrySet()遍历Map时，返回的是Map的EntrySet视图，它与原始的Map是关联的。在迭代的过程中，如果我们直接通过params.remove(entry.getKey())去修改Map，会导致EntrySet视图与原始Map的结构不一致，从而抛出ConcurrentModificationException（并发修改异常）。

        for (Map.Entry<String, Set<String>> entry : params.entrySet()) {
            if(KEY_SET.contains(entry.getKey())){
                executor.execute(()-> this.doFlush(entry.getKey(),entry.getValue()) );
                params.remove(entry.getKey());
            }
        }

产生的异常

Caused by: java.util.ConcurrentModificationException: null
        at java.util.LinkedHashMap$LinkedHashIterator.nextNode(LinkedHashMap.java:719)
        at java.util.LinkedHashMap$LinkedEntryIterator.next(LinkedHashMap.java:752)
        at java.util.LinkedHashMap$LinkedEntryIterator.next(LinkedHashMap.java:750)
        at cn.xj.common.utils.http.cache.CacheConsumer.flushCache(CacheConsumer.java:100)
        at cn.xj.common.utils.http.cache.CacheConsumer.msgConsumer(CacheConsumer.java:83)
        at cn.xj.framework.task.JobTask.cacheFlushJob(JobTask.java:1829)
        ... 10 common frames omitted

修改后的代码

解决这个问题的方法是，使用迭代器来进行安全的删除操作。具体代码如下：

Iterator<Map.Entry<String, Set<String>>> iterator = params.entrySet().iterator();
while (iterator.hasNext()) {
    Map.Entry<String, Set<String>> entry = iterator.next();
    if (KEY_SET.contains(entry.getKey())) {
        executor.execute(() -> this.doFlush(entry.getKey(), entry.getValue()));
        iterator.remove(); // 使用迭代器的remove方法来安全地删除元素
    }
}

这样就能避免ConcurrentModificationException异常。

避免类似问题的方法

• 使用迭代器：在遍历集合时，如果需要对集合进行修改操作，请使用迭代器的remove()方法来进行安全的删除操作。

• 使用CopyOnWrite容器：如果可能，在多线程环境下，可以考虑使用Java提供的线程安全容器，比如CopyOnWriteArrayList或ConcurrentHashMap，它们内部实现了并发安全，可以避免ConcurrentModificationException。

• 合理规划数据操作：在处理数据时，尽量避免在遍历过程中进行删除操作，可以先标记要删除的元素，然后在遍历结束后，再进行删除操作。

• 使用同步块：在多线程环境下，如果无法使用线程安全容器，可以使用同步块（synchronized）来保护对集合的修改操作，确保在修改时不会被其他线程干扰。

• 测试覆盖：在测试环境中尽量模拟真实的生产环境数据，测试各种可能的情况，以确保代码在生产环境能够正常运行。

总结：

作为开发者，避免低级错误同样重要。希望本文能帮助读者更好地理解并解决ConcurrentModificationException异常，以及在开发中提高代码质量，减少不必要的问题发生。同时，重视测试工作，让我们的项目在实际应用中更加稳定和可靠。