使用spring boot的程序主线程中异步访问外部接口

本文主要是介绍使用spring boot的程序主线程中异步访问外部接口，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

如题。之所以要采用异步方式，是因为外部接口不可控，无法预测。如果对方不在线，因而无法访问，只有靠超时抛出异常，容易造成堵塞。

比如下面的代码，有2个定时器，其中刷新设备数据每2秒1次，检查外部接口每10秒1次。可是由于外部接口访问超时，导致刷新设备数据受到影响，不能按时触发。

1、原来容易堵塞的代码

@Component
public class RefreshData {@AutowiredEquipDataService equipDataService;@Scheduled(fixedRate = 2000)  // 刷新设备数据，每 2 秒执行一次public void printMessage() {System.out.println("每 2 秒读取最新数据.");equipDataService.freshData();}@Scheduled(fixedRate = 10000)  // 检查外部接口等连接情况，每 10 秒执行一次public void printMessage2() {System.out.println("每 10 秒检查各部件连接情况.");equipDataService.freshCheckLink();}
}

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

@Service
public class EquipDataServiceImpl implements EquipDataService {。。。@Overridepublic void freshCheckLink() {。。。getOuterApi();}private void getOuterApi() {String url = String.format("%s/test", outerApiUrl);String content = HttpUtils.callGet(url);//采用get方式访问url。自定义函数。return content != null && content.compareTo("ok") == 0;}
}

2、采用异步模式的代码

很容易想到采用多线程方案。但如果不想大动干戈，修改太多代码，也可以采用异步模式访问外部接口。

import java.util.concurrent.CompletableFuture;@Service
public class EquipDataServiceImpl implements EquipDataService {。。。@Overridepublic void freshCheckLink() {getOuterApi();}private void getOuterApi() {CompletableFuture.supplyAsync(() -> {try {String url = String.format("%s/test", outerApiUrl);String content = HttpUtils.callGet(url);//采用get方式访问url。自定义函数。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、小结

CompletableFuture.supplyAsync 是 Java 并发编程中 CompletableFuture 类的一个静态工厂方法，用于创建一个异步执行的 CompletableFuture 对象，它会在后台线程中执行指定的操作，并返回一个结果。这个方法的签名如下：

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

其中：

<U> 是结果的类型。
Supplier<U> 是一个函数式接口，它没有参数并返回一个值。在 supplyAsync 中，这个接口表示一个计算任务，它会异步执行，计算并返回一个结果。
使用 CompletableFuture.supplyAsync 可以在并发环境中执行某些操作，然后使用 CompletableFuture 对象来处理结果或执行后续操作。这是 Java 并发编程中一种方便的异步编程方式。

下面是一个简单的示例，演示了如何使用 CompletableFuture.supplyAsync 来异步执行一个任务：

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;public class CompletableFutureExample {public static void main(String[] args) {CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {// 这里是异步计算的任务return 42;});try {// 获取异步任务的结果int result = future.get();System.out.println("异步任务的结果: " + result);} catch (InterruptedException | ExecutionException e) {e.printStackTrace();}}
}

在上面的示例中，supplyAsync 异步执行了一个计算任务，返回结果 42。通过 future.get() 获取异步任务的结果。需要注意，get 方法会阻塞直到任务完成并返回结果或抛出异常。在实际应用中，通常会结合其他 CompletableFuture 方法来构建更复杂的异步处理流程。

CompletableFuture.supplyAsync 具有许多好处，使其在 Java 并发编程中非常有用：

异步执行：supplyAsync 创建的 CompletableFuture 对象会在后台线程中异步执行指定的任务。这允许您在不阻塞主线程的情况下执行耗时的操作，从而提高程序的并发性和响应性。
可组合性：CompletableFuture 支持各种方法，允许您对异步操作进行组合、串行化、并行化等操作。您可以轻松地构建复杂的异步处理流程。
错误处理：您可以通过 exceptionally、handle 等方法来处理异步操作中可能发生的异常，使代码更健壮。
超时处理：CompletableFuture 允许您设置超时操作，以防异步任务耗时过长。
并行处理：您可以使用 thenCombine, thenCompose 等方法将多个 CompletableFuture 组合在一起，以实现并行处理多个异步操作。
非阻塞获取结果：通过 join() 或 getNow() 方法，可以非阻塞地获取异步操作的结果。这使得在需要结果时可以等待，而不必一直阻塞主线程。
适用于网络请求和IO操作：CompletableFuture 是处理网络请求、数据库查询和其他需要等待外部资源的任务的理想选择，因为它可以在等待资源返回时不阻塞主线程。
可读性和维护性：CompletableFuture 的使用可以使代码更具可读性和维护性，特别是在处理复杂的异步操作流程时。