如何处理Future#get()的InterruptedException并解决SonarLint警告？

问题原因 #

SonarLint的java:S2142警告触发逻辑很明确：你捕获了InterruptedException但未做正确处理。这个异常是线程中断的信号，捕获后线程的中断状态会被清除，上层代码无法感知到中断事件，因此要求你要么恢复线程的中断状态，要么重新抛出该异常。

解决方案 #

方案1：恢复线程中断状态（推荐，无需修改方法签名） #

在捕获InterruptedException后，调用Thread.currentThread().interrupt()恢复中断状态，让上层代码可以检测到线程被中断。修改后的代码：

public void produceMessage(String dataPushNotif) {
    PushNotif msg = PushNotif.newBuilder()
            .setDatapushnotif(dataPushNotif)
            .build();

    ListenableFuture<SendResult<String, PushNotif>> future =
            kafkaTemplate.send(destTopic, msg);

    try {
        var result = future.get(TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
        log.debug(buildSuccesLogMessage(result));
    } catch (InterruptedException e) {
        // 恢复线程中断状态
        Thread.currentThread().interrupt();
        log.debug("线程被中断: {}", e);
    } catch (ExecutionException | TimeoutException e) {
        log.debug("发送失败: {}", e);
    }
}

方案2：重新抛出InterruptedException #

如果你的方法允许抛出中断异常，可以修改方法签名，把InterruptedException重新抛出，交给上层调用者处理：

public void produceMessage(String dataPushNotif) throws InterruptedException {
    PushNotif msg = PushNotif.newBuilder()
            .setDatapushnotif(dataPushNotif)
            .build();

    ListenableFuture<SendResult<String, PushNotif>> future =
            kafkaTemplate.send(destTopic, msg);

    try {
        var result = future.get(TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
        log.debug(buildSuccesLogMessage(result));
    } catch (ExecutionException | TimeoutException e) {
        log.debug("发送失败: {}", e);
    } catch (InterruptedException e) {
        // 重新抛出中断异常
        throw e;
    }
}

方案3：兼顾回调与超时的优雅处理 #

如果你想使用addCallback()的异步回调风格，同时又要设置超时，可以将ListenableFuture转换为CompletableFuture，利用其orTimeout()方法实现超时控制，同时正确处理中断：

public void produceMessage(String dataPushNotif) {
    PushNotif msg = PushNotif.newBuilder()
            .setDatapushnotif(dataPushNotif)
            .build();

    ListenableFuture<SendResult<String, PushNotif>> listenableFuture =
            kafkaTemplate.send(destTopic, msg);

    // 将ListenableFuture转换为CompletableFuture
    CompletableFuture<SendResult<String, PushNotif>> completableFuture = new CompletableFuture<>();
    listenableFuture.addCallback(
            completableFuture::complete,
            completableFuture::completeExceptionally
    );

    // 设置超时并处理结果/异常
    completableFuture.orTimeout(TIMEOUT_MILLIS, TimeUnit.MILLISECONDS)
            .thenAccept(result -> log.debug(buildSuccesLogMessage(result)))
            .exceptionally(ex -> {
                Throwable cause = ex.getCause();
                if (cause instanceof InterruptedException) {
                    Thread.currentThread().interrupt();
                    log.debug("线程被中断: {}", cause);
                } else if (cause instanceof ExecutionException) {
                    log.debug("发送失败: {}", cause.getCause());
                } else if (ex instanceof TimeoutException) {
                    log.debug("发送超时: {}", ex);
                } else {
                    log.debug("未知错误: {}", ex);
                }
                return null;
            });
}

这种方式既保留了异步回调的优雅性，又实现了超时控制，同时正确处理了中断状态，满足SonarLint的要求。

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