Java利用異常中斷當前任務的技巧分享

更新時間：2023年08月28日 14:05:26 作者：樂征skyline

在日常開發(fā)中,我們經(jīng)常遇到調(diào)用別人的代碼來完成某個任務,但是當代碼比較耗時的時候,沒法從外部終止該任務,所以本文為大家介紹了如何利用異常中斷當前任務,需要的可以參考下

Java小技巧：利用異常中斷當前任務

在日常開發(fā)中，我們經(jīng)常遇到調(diào)用別人的代碼來完成某個任務，但是當代碼比較耗時的時候，沒法從外部終止該任務。有些程序從開始就考慮到了這個場景，就會提供對應的cancel或stop之類的方法用于終止任務，但還是會有很多三方庫并沒有提供響應接口。比如，下面這個下載示例：

class DownloadTask {
    public void download(Listener listener) {
        try {
            for (int i = 0; i < 100; i++) {//模擬下載過程
                Thread.sleep(1000);
                listener.onProgressUpdated(i + 1);
            }
            listener.onCompleted();
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
    }
    public interface Listener {
        void onProgressUpdated(int progress);
        void onCompleted();
    }
}
public class Main {
    public static void main(String[] args) throws InterruptedException {
        DownloadTask task = new DownloadTask();
        task.download(new DownloadTask.Listener() {
            @Override
            public void onProgressUpdated(int progress) {
                System.out.println("onProgressUpdated: " + progress);
                if (isInterrupted.get()) {
                    throw new EndException();
                }
            }
            @Override
            public void onCompleted() {
            }
        });
    }
}

這里的DownloadTask開始運行后，就無法直接停止。如果DownloadTask是第三方庫的代碼時，我們可能不方便改它的代碼使其支持中斷。本文介紹一種利用異常來終止這樣的任務的方法。

（注：本文介紹的方法僅限于單線程或單個子線程的情況，并且需要有在任務運行的線程執(zhí)行代碼的能力，比如回調(diào)）

場景1：任務沒有另起線程的情況

這個就是上面展示的那個下載示例，我們可以通過回調(diào)，直接利用異常中斷該任務：

//DownloadTask 同上
public class Main {
    private static volatile boolean isInterrupted;
    public static void main(String[] args) throws InterruptedException {
        new Thread(() -> {//模擬外部調(diào)用，5秒后通過設置isInterrupted來取消任務，也可以把這段代碼放到一個新的cancel方法中
            sleep(5000);
            isInterrupted = true;
        }).start();
        try {
            DownloadTask task = new DownloadTask();
            task.download(new DownloadTask.Listener() {
                @Override
                public void onProgressUpdated(int progress) {
                    System.out.println("onProgressUpdated: " + progress);
                    if (isInterrupted) {
                        throw new EndException();
                    }
                }
                @Override
                public void onCompleted() {
                    System.out.println("onCompleted...");
                }
            });
        }catch (EndException e){
            System.out.println("end...");
            //is interrupted, ignore
        }
        Thread.currentThread().join();
    }
    static class EndException extends RuntimeException {
    }
    public static void sleep(long time) {
        try {
            Thread.sleep(time);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
    }
}

場景2：任務另起子線程的情況

如果任務另起子線程來執(zhí)行，那么就沒法直接用try-catch來捕獲異常，那么就得通過線程的UncaughtExceptionHandler來完成。假如下載的代碼是這樣的：

public class DownloadTask {
    public void download(Listener listener) {
        new Thread(() -> {
            try {
                for (int i = 0; i < 100; i++) {//模擬下載過程
                    Thread.sleep(1000);
                    listener.onProgressUpdated(i + 1);
                }
                listener.onCompleted();
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
        }).start();
    }
    public interface Listener {
        void onProgressUpdated(int progress);
        void onCompleted();
    }
}

那么外部調(diào)用并終止的代碼就是：

public class Main {
    private static volatile boolean isInterrupted;
    public static void main(String[] args) throws InterruptedException {
        Thread.UncaughtExceptionHandler handler = (t, e) -> {
            if(e instanceof EndException){
                System.out.println("end...");
                //is interrupted, ignore
            }
        };
        DownloadTask task = new DownloadTask();
        task.download(new DownloadTask.Listener() {
            @Override
            public void onProgressUpdated(int progress) {
                System.out.println("onProgressUpdated: " + progress);
                if(Thread.currentThread().getUncaughtExceptionHandler() != handler){//注意這里
                    Thread.currentThread().setUncaughtExceptionHandler(handler);
                }
                if (isInterrupted) {
                    throw new EndException();
                }
            }
            @Override
            public void onCompleted() {
                System.out.println("onCompleted...");
            }
        });
        sleep(5000);
        isInterrupted = true;
        Thread.currentThread().join();
    }
    public static class EndException extends RuntimeException {
    }
    public static void sleep(long time) {
        try {
            Thread.sleep(time);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
    }
}