理解Callable 和 Spring DeferredResult(翻译)

本文内容纲要:

- 1-介绍

- 2-阻塞的Controller

- 3-返回Callable

- 4-返回DeferredResult

- 5-结论

1-介绍

Servlet 3中的异步支持为在另一个线程中处理HTTP请求提供了可能性。当有一个长时间运行的任务时,这是特别有趣的,因为当另一个线程处理这个请求时,容器线程被释放,并且可以继续为其他请求服务。

这个主题已经解释了很多次,Spring框架提供的关于这个功能的类似乎有一点混乱——在一个Controller中返回Callable 和 DeferredResult。

在这篇文章中,我将实施这两个例子,以显示其差异。

这里所显示的所有示例都包括执行一个控制器,该控制器将执行一个长期运行的任务,然后将结果返回给客户机。长时间运行的任务由taskservice处理:

@Service

public class TaskServiceImpl implements TaskService {

private final Logger logger = LoggerFactory.getLogger(this.getClass());

@Override

public String execute() {

try {

Thread.sleep(5000);

logger.info("Slow task executed");

return "Task finished";

} catch (InterruptedException e) {

throw new RuntimeException();

}

}

}

这个web应用是用Spring Boot创建的,我们将执行下面的类来运行我们的例子:

@SpringBootApplication

public class MainApp {

public static void main(String[] args) {

SpringApplication.run(MainApp.class, args);

}

}

2-阻塞的Controller

在这个例子中,一个请求到达控制器。servlet线程不会被释放,直到长时间运行的方法被执行,我们退出@requestmapping注释的方法。

@RestController

public class BlockingController {

private final Logger logger = LoggerFactory.getLogger(this.getClass());

private final TaskService taskService;

@Autowired

public BlockingController(TaskService taskService) {

this.taskService = taskService;

}

@RequestMapping(value = "/block", method = RequestMethod.GET, produces = "text/html")

public String executeSlowTask() {

logger.info("Request received");

String result = taskService.execute();

logger.info("Servlet thread released");

return result;

}

}

如果我们运行这个例子http://localhost:8080/block,在日志里我们会发现servlet request不会被释放,直到长时间的任务执行完(5秒后)。

2015-07-12 12:41:11.849  [nio-8080-exec-6] x.s.web.controller.BlockingController    : Request received

2015-07-12 12:41:16.851 [nio-8080-exec-6] x.spring.web.service.TaskServiceImpl : Slow task executed

2015-07-12 12:41:16.851 [nio-8080-exec-6] x.s.web.controller.BlockingController : Servlet thread released

3-返回Callable

在这个例子中,不是直接返回的结果,我们将返回一个Callable:

@RestController

public class AsyncCallableController {

private final Logger logger = LoggerFactory.getLogger(this.getClass());

private final TaskService taskService;

@Autowired

public AsyncCallableController(TaskService taskService) {

this.taskService = taskService;

}

@RequestMapping(value = "/callable", method = RequestMethod.GET, produces = "text/html")

public Callable<String> executeSlowTask() {

logger.info("Request received");

Callable<String> callable = taskService::execute;

logger.info("Servlet thread released");

return callable;

}

}

返回Callable意味着Spring MVC将调用在不同的线程中执行定义的任务。Spring将使用TaskExecutor来管理线程。在等待完成的长期任务之前,servlet线程将被释放。

2015-07-12 13:07:07.012  [nio-8080-exec-5] x.s.w.c.AsyncCallableController          : Request received

2015-07-12 13:07:07.013 [nio-8080-exec-5] x.s.w.c.AsyncCallableController : Servlet thread released

2015-07-12 13:07:12.014 [ MvcAsync2] x.spring.web.service.TaskServiceImpl : Slow task executed

你可以看到我们在长时间运行的任务执行完毕之前就已经从servlet返回了。这并不意味着客户端收到了一个响应。与客户端的通信仍然是开放的等待结果,但接收到的请求的线程已被释放,并可以服务于另一个客户的请求。

4-返回DeferredResult

首先,我们需要创建一个deferredresult对象。此对象将由控制器返回。我们将完成和Callable相同的事,当我们在另一个线程处理长时间运行的任务的时候释放servlet线程。

@RestController

public class AsyncDeferredController {

private final Logger logger = LoggerFactory.getLogger(this.getClass());

private final TaskService taskService;

@Autowired

public AsyncDeferredController(TaskService taskService) {

this.taskService = taskService;

}

@RequestMapping(value = "/deferred", method = RequestMethod.GET, produces = "text/html")

public DeferredResult<String> executeSlowTask() {

logger.info("Request received");

DeferredResult<String> deferredResult = new DeferredResult<>();

CompletableFuture.supplyAsync(taskService::execute)

.whenCompleteAsync((result, throwable) -> deferredResult.setResult(result));

logger.info("Servlet thread released");

return deferredResult;

}

}

所以,返回DeferredResult和返回Callable有什么区别?不同的是这一次线程是由我们管理。创建一个线程并将结果set到DeferredResult是由我们自己来做的。

用completablefuture创建一个异步任务。这将创建一个新的线程,在那里我们的长时间运行的任务将被执行。也就是在这个线程中,我们将set结果到DeferredResult并返回。

是在哪个线程池中我们取回这个新的线程?默认情况下,在completablefuture的supplyasync方法将在forkjoin池运行任务。如果你想使用一个不同的线程池,你可以通过传一个executor到supplyasync方法:

public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier, Executor executor)

如果我们运行这个例子,我们将得到如下结果:

2015-07-12 13:28:08.433  [io-8080-exec-10] x.s.w.c.AsyncDeferredController          : Request received

2015-07-12 13:28:08.475 [io-8080-exec-10] x.s.w.c.AsyncDeferredController : Servlet thread released

2015-07-12 13:28:13.469 [onPool-worker-1] x.spring.web.service.TaskServiceImpl : Slow task executed

5-结论

站在一定高度来看这问题,Callable和Deferredresult做的是同样的事情——释放容器线程,在另一个线程上异步运行长时间的任务。不同的是谁管理执行任务的线程。

文中涉及的代码spring-rest

翻译自Xavier Padró's Blog

本文内容总结:1-介绍,2-阻塞的Controller,3-返回Callable,4-返回DeferredResult,5-结论,

原文链接:https://www.cnblogs.com/aheizi/p/5659030.html

以上是 理解Callable 和 Spring DeferredResult(翻译) 的全部内容, 来源链接: utcz.com/z/296319.html

回到顶部