从Spring REST控制器返回流

Question

如果可以从SpringRestController返回Stream，我很好奇

@RestController
public class X {
  @RequestMapping(...)
  public Stream<?> getAll() { ... }
}

这样做可以吗？我试过了，Spring返回的不是流的值。

我应该继续返回列表吗




Answer 1

匿名用户

您可以在Spring 5.0 / WebFlux 中流式传输实体。

看一下这个示例反应式Rest控制器(< code > spring . main . web-application-type:" REACTIVE " ):

@RestController
public class XService {

    class XDto{
        final int x;
        public XDto(int x) {this.x = x;}
    }

    Stream<XDto> produceX(){
        return IntStream.range(1,10).mapToObj(i -> {
            System.out.println("produce "+i);
            try {Thread.sleep(1000);} catch (InterruptedException e) {e.printStackTrace();}
            return new XDto(i);
        });
    }

    // stream of Server-Sent Events (SSE)
    @GetMapping(value = "/api/x/sse", 
    produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public Flux<XDto> getXSse() {
        return Flux.fromStream(produceX());
    }

    // stream of JSON lines
    @GetMapping(value = "/api/x/json-stream", 
    produces = MediaType.APPLICATION_STREAM_JSON_VALUE)
    public Flux<XDto> getAllJsonStream() {
        return Flux.fromStream(produceX());
    }

    // same as List<XDto> - blocking JSON list
    @GetMapping(value = "/api/x/json-list", 
    produces = MediaType.APPLICATION_JSON_VALUE)
    public Flux<XDto> getAll() {
        return Flux.fromStream(produceX());
    }
}

Spring Framework 5.0-WebFlux：

Spring的反应式堆栈Web框架是5.0中新增的，是完全反应式和非阻塞的。它适用于具有少量线程的事件循环样式处理。

服务器发送的事件(SSE):

服务器发送事件是描述一旦建立了初始客户端连接，服务器如何向客户端发起数据传输的标准。

WebSocket与服务器发送事件/事件源

Answer 2

匿名用户

这也可以用Spring MVC控制器来完成，但是有一些问题:Spring数据JPA存储库的限制，数据库是否支持可保持游标(ResultSet Holdability)以及Jackson的版本。

我很难理解的关键概念是，Java 8 Stream返回一系列在终端操作中执行的函数，因此数据库必须在执行终端操作的上下文中可访问。

Spring数据 JPA 限制

我发现Spring数据JPA文档没有为Java 8流提供足够的细节。看起来你可以简单地声明流

@Query("select mo from MyObject mo where mo.foo.id in :fooIds")
Stream<MyObject> readAllByFooIn(@Param("fooIds") Long[] fooIds);

可保持光标

如果您有一个支持可持有游标的数据库，则在提交事务后可以访问结果集。这很重要，因为我们通常用< code>@Transactional来注释我们的< code>@Service类方法，所以如果您的数据库支持可保持游标，则可以在服务方法返回后(即在< code>@Controller方法中)访问< code>ResultSet。如果数据库不支持可持有游标，例如MySQL，您需要将< code>@Transaction注释添加到控制器的< code>@RequestMapping方法中。

所以现在ResultSet可以在@Service方法之外访问，对吗？这同样取决于可保留性。对于MySQL，它只能在@Transactional方法中访问，因此以下方法将起作用（尽管违背了使用Java8 Streams的全部目的）：

@Transaction @RequestMapping(...)
public List<MyObject> getAll() {
   try(Stream<MyObject> stream = service.streamAll) {
        return stream.collect(Collectors.toList())
    };
}

但不是

@Transaction @RequestMapping
public Stream<MyObject> getAll() {
    return service.streamAll;
}

因为终端操作符不在您的@Controller中，它在控制器方法返回后发生在Spring中。

在不支持可保留游标的情况下将流序列化为JSON

要将流序列化为JSON而不使用可保留游标，请将＜code＞HttpServletResponse，但在2.8.x中，您必须使用流的迭代器：

@RequestMapping(...)
@Transactional
public void getAll(HttpServletResponse response) throws IOException {
    try(final Stream<MyObject> stream = service.streamAll()) {
        final Writer writer = new BufferedWriter(new OutputStreamWriter(response.getOutputStream()));
        new ObjectMapper().writerFor(Iterator.class).writeValue(writer, stream.iterator());
    }
}

下一步

我的下一步是尝试在可调用的WebAsyncTask中重构它，并将JSON序列化移到服务中。

引用

• 请务必阅读Marko Topolnik的博客文章https://www.airpair.com/java/posts/spring-streams-memory-efficiency没有它，我就不知道从哪里开始
• MySQL