快捷導(dǎo)航

如何使用spring?boot的程序主線程中異步訪問外部接口

更新時間：2023年10月28日 10:13:02 作者：左直拳

CompletableFuture.supplyAsync提供了一種強大的工具，使您能夠以異步方式執(zhí)行操作，充分利用多核處理器和提高程序性能，同時保持代碼的清晰性和可維護(hù)性，本文給大家介紹使用spring?boot的程序主線程中異步訪問外部接口，感興趣的朋友一起看看吧

1、原來容易堵塞的代碼

@Component
public class RefreshData {
    @Autowired
    EquipDataService equipDataService;
    @Scheduled(fixedRate = 2000)  // 刷新設(shè)備數(shù)據(jù)，每 2 秒執(zhí)行一次
    public void printMessage() {
        System.out.println("每 2 秒讀取最新數(shù)據(jù).");
        equipDataService.freshData();
    }
    @Scheduled(fixedRate = 10000)  // 檢查外部接口等連接情況，每 10 秒執(zhí)行一次
    public void printMessage2() {
        System.out.println("每 10 秒檢查各部件連接情況.");
        equipDataService.freshCheckLink();
    }
}

public interface EquipDataService {
    void freshData();
    void freshCheckLink();
}

@Service
public class EquipDataServiceImpl implements EquipDataService {
	。。。
    @Override
    public void freshCheckLink() {
        。。。
        getOuterApi();
    }
    private void getOuterApi() {
        String url = String.format("%s/test", outerApiUrl);
        String content = HttpUtils.callGet(url);//采用get方式訪問url。自定義函數(shù)。
        return content != null && content.compareTo("ok") == 0;
    }
}

2、采用異步模式的代碼

很容易想到采用多線程方案。但如果不想大動干戈，修改太多代碼，也可以采用異步模式訪問外部接口。

import java.util.concurrent.CompletableFuture;
@Service
public class EquipDataServiceImpl implements EquipDataService {
	。。。
    @Override
    public void freshCheckLink() {
        getOuterApi();
    }
    private void getOuterApi() {
        CompletableFuture.supplyAsync(() -> {
            try {
                String url = String.format("%s/test", outerApiUrl);
                String content = HttpUtils.callGet(url);//采用get方式訪問url。自定義函數(shù)。
                return content != null && content.compareTo("ok") == 0;
            } catch (Fault fault) {
                System.out.println(fault.getCause());
                return null;
            } catch (Exception e) {
                System.out.println(e.getCause());
                return null;
            }
        }).thenAccept(ok -> {
            if (ok != null) {
                。。。
            } else {
                System.out.println("Error occurred while retrieving outerApiUrl"));
            }
        }).exceptionally(ex -> {
            System.out.println(String.format("visit outerApiUrl Error occurred: %s", ex.getCause()));
        });
    }
}

3、小結(jié)

CompletableFuture.supplyAsync 是 Java 并發(fā)編程中 CompletableFuture 類的一個靜態(tài)工廠方法，用于創(chuàng)建一個異步執(zhí)行的 CompletableFuture 對象，它會在后臺線程中執(zhí)行指定的操作，并返回一個結(jié)果。這個方法的簽名如下：

public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier)

其中：

<U> 是結(jié)果的類型。
Supplier<U> 是一個函數(shù)式接口，它沒有參數(shù)并返回一個值。在 supplyAsync 中，這個接口表示一個計算任務(wù)，它會異步執(zhí)行，計算并返回一個結(jié)果。
使用 CompletableFuture.supplyAsync 可以在并發(fā)環(huán)境中執(zhí)行某些操作，然后使用 CompletableFuture 對象來處理結(jié)果或執(zhí)行后續(xù)操作。這是 Java 并發(fā)編程中一種方便的異步編程方式。

下面是一個簡單的示例，演示了如何使用 CompletableFuture.supplyAsync 來異步執(zhí)行一個任務(wù)：

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
public class CompletableFutureExample {
    public static void main(String[] args) {
        CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
            // 這里是異步計算的任務(wù)
            return 42;
        });
        try {
            // 獲取異步任務(wù)的結(jié)果
            int result = future.get();
            System.out.println("異步任務(wù)的結(jié)果: " + result);
        } catch (InterruptedException | ExecutionException e) {
            e.printStackTrace();
        }
    }
}

在上面的示例中，supplyAsync 異步執(zhí)行了一個計算任務(wù)，返回結(jié)果 42。通過 future.get() 獲取異步任務(wù)的結(jié)果。需要注意，get 方法會阻塞直到任務(wù)完成并返回結(jié)果或拋出異常。在實際應(yīng)用中，通常會結(jié)合其他 CompletableFuture 方法來構(gòu)建更復(fù)雜的異步處理流程。

CompletableFuture.supplyAsync 具有許多好處，使其在 Java 并發(fā)編程中非常有用：

異步執(zhí)行：supplyAsync 創(chuàng)建的 CompletableFuture 對象會在后臺線程中異步執(zhí)行指定的任務(wù)。這允許您在不阻塞主線程的情況下執(zhí)行耗時的操作，從而提高程序的并發(fā)性和響應(yīng)性。
可組合性：CompletableFuture 支持各種方法，允許您對異步操作進(jìn)行組合、串行化、并行化等操作。您可以輕松地構(gòu)建復(fù)雜的異步處理流程。
錯誤處理：您可以通過 exceptionally、handle 等方法來處理異步操作中可能發(fā)生的異常，使代碼更健壯。
超時處理：CompletableFuture 允許您設(shè)置超時操作，以防異步任務(wù)耗時過長。
并行處理：您可以使用 thenCombine, thenCompose 等方法將多個 CompletableFuture 組合在一起，以實現(xiàn)并行處理多個異步操作。
非阻塞獲取結(jié)果：通過 join() 或 getNow() 方法，可以非阻塞地獲取異步操作的結(jié)果。這使得在需要結(jié)果時可以等待，而不必一直阻塞主線程。
適用于網(wǎng)絡(luò)請求和IO操作：CompletableFuture 是處理網(wǎng)絡(luò)請求、數(shù)據(jù)庫查詢和其他需要等待外部資源的任務(wù)的理想選擇，因為它可以在等待資源返回時不阻塞主線程。
可讀性和維護(hù)性：CompletableFuture 的使用可以使代碼更具可讀性和維護(hù)性，特別是在處理復(fù)雜的異步操作流程時。