深入理解DeferredResult

小蓝 • 2024-12-13 17:33 • 编程

一、DeferredResult概述

DeferredResult是一个Spring MVC的技术，它允许把请求处理的结果异步的发送到客户端。当一个请求被接收时，处理器通常会立即返回一个代表结果的DeferredResult对象。在这个处理器方法中，DeferredResult对象相当于一个Promise（承诺）：它之后会被填充结果，而这个结果在另外一个线程中进行。这种方法允许处理器方法的执行在结果可以被填充之前就立即结束。

@Controller
@RequestMapping("/deferredresult")
public class DeferredResultController {

    private final Queue<DeferredResult> deferredResults = new ConcurrentLinkedQueue();

    @GetMapping("/")
    public DeferredResult handleRequest() {
        final DeferredResult deferredResult = new DeferredResult();
        deferredResults.add(deferredResult);
        return deferredResult;
    }

    @PostMapping("/")
    public String processRequest(@RequestBody String message) {
        deferredResults.forEach(deferredResult -> deferredResult.setResult(message));
        deferredResults.clear();
        return "processed";
    }
}

二、DeferredResult的优势

DeferredResult最大的优势在于它可以解决长时间运行的请求超时问题。例如，假设你有一个在后台执行的任务，这个任务需要一段时间才能完成。如果浏览器与服务器之间的连接时间太长，浏览器可能会将连接关闭，从而导致服务器在任务完成之前就终止。

另一个优势是，通过使用DeferredResult，你可以将请求发送到一个处理器方法，然后你可以在请求返回到该方法之前立即返回响应。这样可以极大地提高应用程序的吞吐量，并允许处理器方法在发送请求之后进行其他的工作。

三、使用DeferredResult的注意事项

1、DeferredResult需要在不同的线程中填充结果，否则会阻塞请求线程，导致不可预测的结果。要确保DeferredResult被填充到另一个线程中，可以使用Spring的异步调用机制，或者开启一个新的线程。

2、如果处理程序可能会永远无法填充DeferredResult，则应该设置一个空结果，以便防止客户端永远等待。

3、对于每个请求，都应该创建一个新的DeferredResult对象，而不是在多个请求之间共享它们。

四、DeferredResult使用示例

下面是一个使用DeferredResult的示例，它将打印出deferredResult对象的状态，并返回一个字符串到客户端：

@GetMapping("/longRunningRequest")
public DeferredResult handleLongRunningRequest() {
    // 创建一个新的DeferredResult
    final DeferredResult deferredResult = new DeferredResult();

    // 将DeferredResult的结果放到一个新的线程中，以避免阻塞请求线程
    new Thread(() -> {
        try {
            // 模拟长时间运行的任务
            Thread.sleep(5000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        // 将结果填充到DeferredResult
        deferredResult.setResult("Long running request completed");
    }).start();

    // 返回DeferredResult对象
    return deferredResult;
}

五、结语

DeferredResult是一个非常有用的技术，特别是在处理需要长时间运行的请求或需要等待外部资源的请求时。当使用它时，请确保遵循最佳实践并遵循你的应用程序的特定需求。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/251941.html