为何Java迭代器会引发资源泄漏？如何消除Eclipse相关警告？

问题描述 #

以下Java代码在Eclipse中触发警告：

@Override
public Iterator<String> getErrorUlrs(int pCrawlId) {
    String collectionName = "collectionName";
    // mongoDB is of type com.mongodb.client.MongoDatabase
    MongoCollection<Document> c = mongoDB.getCollection(collectionName);

    Bson filter = Filters.not(eq("exploreStatus", "OK"));
    Bson projection = fields(include("url"), excludeId());
    FindIterable<Document> docs = c.find(filter).projection(projection).batchSize(1000);
    Iterator<Document> it = docs.iterator();

    return new Iterator<String>() {

        @Override
        public boolean hasNext() {
            return it.hasNext();
        }

        @Override
        public String next() {
            Document doc = it.next();
            return doc.getString("url");
        }
    };
}

警告信息：Potential resource leak: 'it' may not be closed at this location

注：代码目的是封装MongoDB API避免直接暴露，已知it实际为MongoCursor类型，该类实现了Closeable接口。

一、警告触发原因 #

Eclipse的静态代码分析会自动检测实现Closeable/AutoCloseable接口的对象，这类对象持有需要主动释放的资源（如数据库连接、网络句柄）。此处的MongoCursor（即代码中的it）属于这类对象，但当前代码将封装后的迭代器返回给调用方后，原MongoCursor的生命周期完全脱离当前方法的控制，Eclipse无法确认后续代码会关闭该资源，因此判定存在潜在资源泄漏，触发警告。

二、消除警告的方法 #

方法1：让封装的迭代器支持关闭（推荐） #

修改自定义迭代器，使其同时实现Closeable接口，在close方法中关闭原MongoCursor，从根源解决资源泄漏问题，同时让调用方可以主动释放资源：

@Override
public Iterator<String> getErrorUlrs(int pCrawlId) {
    String collectionName = "collectionName";
    MongoCollection<Document> c = mongoDB.getCollection(collectionName);

    Bson filter = Filters.not(eq("exploreStatus", "OK"));
    Bson projection = fields(include("url"), excludeId());
    FindIterable<Document> docs = c.find(filter).projection(projection).batchSize(1000);
    MongoCursor<Document> it = docs.iterator();

    // 实现Iterator和Closeable接口的匿名类
    return new Iterator<String>() {
        @Override
        public boolean hasNext() {
            return it.hasNext();
        }

        @Override
        public String next() {
            Document doc = it.next();
            return doc.getString("url");
        }

        @Override
        public void close() throws IOException {
            it.close();
        }
    };
}

为了让调用方更清晰地知道迭代器支持关闭，建议自定义一个继承Iterator和Closeable的接口：

// 自定义可关闭迭代器接口
public interface CloseableIterator<T> extends Iterator<T>, Closeable {}

// 修改方法返回类型
@Override
public CloseableIterator<String> getErrorUlrs(int pCrawlId) {
    // ... 原有查询逻辑 ...
    return new CloseableIterator<String>() {
        @Override
        public boolean hasNext() {
            return it.hasNext();
        }

        @Override
        public String next() {
            return it.next().getString("url");
        }

        @Override
        public void close() throws IOException {
            it.close();
        }
    };
}

调用方可以直接使用try-with-resources语法自动关闭资源：

try (CloseableIterator<String> iterator = getErrorUlrs(crawlId)) {
    while (iterator.hasNext()) {
        String url = iterator.next();
        // 业务处理逻辑
    }
} catch (IOException e) {
    // 处理关闭异常
}

方法2：抑制Eclipse警告（不推荐） #

如果暂时无法修改代码结构，或确认调用方会妥善处理资源，可以在方法上添加Eclipse专属的抑制警告注解，仅隐藏警告但不解决泄漏问题：

@SuppressWarnings("resource")
@Override
public Iterator<String> getErrorUlrs(int pCrawlId) {
    // ... 原有代码 ...
}

内容的提问来源于stack exchange，提问作者mvera