-
Notifications
You must be signed in to change notification settings - Fork 258
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(java): add blocked stream utils (#1617)
## What does this PR do? Native stream is not feasible for every cases, this PR add blocked stream utils to adapt to streaming API. This is s serialization helper as the fallback of streaming serialization/deserialization in FuryInputStream/FuryReadableChannel. FuryInputStream/FuryReadableChannel will buffer and read more data, which makes the original passed stream when constructing FuryInputStream not usable. If this is not possible, use this BlockedStreamUtils instead for streaming serialization and deserialization. Note that this mode will disable streaming in essence. It's just a helper for make the usage in streaming interface more easily. The deserialization will read whole bytes before do the actual deserialization, which don't have any streaming behaviour under the hood. ## Related issues #1451 ## Does this PR introduce any user-facing change? <!-- If any user-facing interface changes, please [open an issue](https://github.com/apache/incubator-fury/issues/new/choose) describing the need to do so and update the document if necessary. --> - [ ] Does this PR introduce any public API change? - [ ] Does this PR introduce any binary protocol compatibility change? ## Benchmark <!-- When the PR has an impact on performance (if you don't know whether the PR will have an impact on performance, you can submit the PR first, and if it will have impact on performance, the code reviewer will explain it), be sure to attach a benchmark data here. -->
- Loading branch information
1 parent
06a74a1
commit 58bdf3e
Showing
5 changed files
with
291 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 188 additions & 0 deletions
188
java/fury-core/src/main/java/org/apache/fury/io/BlockedStreamUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.apache.fury.io; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.OutputStream; | ||
| import java.nio.ByteBuffer; | ||
| import java.nio.ByteOrder; | ||
| import java.nio.channels.ReadableByteChannel; | ||
| import java.util.function.Consumer; | ||
| import java.util.function.Function; | ||
| import org.apache.fury.Fury; | ||
| import org.apache.fury.exception.DeserializationException; | ||
| import org.apache.fury.memory.MemoryBuffer; | ||
| import org.apache.fury.serializer.BufferCallback; | ||
| import org.apache.fury.util.ExceptionUtils; | ||
| import org.apache.fury.util.Preconditions; | ||
|
|
||
| /** | ||
| * A serialization helper as the fallback of streaming serialization/deserialization in {@link | ||
| * FuryInputStream}/{@link FuryReadableChannel}. {@link FuryInputStream}/{@link FuryReadableChannel} | ||
| * will buffer and read more data, which makes the original passed stream when constructing {@link | ||
| * FuryInputStream} not usable. If this is not possible, use this {@link BlockedStreamUtils} instead | ||
| * for streaming serialization and deserialization. | ||
| * | ||
| * <p>Note that this mode will disable streaming in essence. It's just a helper for make the usage | ||
| * in streaming interface more easily. The deserialization will read whole bytes before do the | ||
| * actual deserialization, which don't have any streaming behaviour under the hood. | ||
| */ | ||
| public class BlockedStreamUtils { | ||
| public static void serialize(Fury fury, OutputStream outputStream, Object obj) { | ||
| serializeToStream(fury, outputStream, buf -> fury.serialize(buf, obj, null)); | ||
| } | ||
|
|
||
| public static void serialize( | ||
| Fury fury, OutputStream outputStream, Object obj, BufferCallback callback) { | ||
| serializeToStream(fury, outputStream, buf -> fury.serialize(buf, obj, callback)); | ||
| } | ||
|
|
||
| /** | ||
| * Serialize java object without class info, deserialization should use {@link | ||
| * #deserializeJavaObject}. | ||
| */ | ||
| public static void serializeJavaObject(Fury fury, OutputStream outputStream, Object obj) { | ||
| serializeToStream(fury, outputStream, buf -> fury.serializeJavaObject(buf, obj)); | ||
| } | ||
|
|
||
| public static Object deserialize(Fury fury, InputStream inputStream) { | ||
| return deserialize(fury, inputStream, null); | ||
| } | ||
|
|
||
| public static Object deserialize( | ||
| Fury fury, InputStream inputStream, Iterable<MemoryBuffer> outOfBandBuffers) { | ||
| return deserializeFromStream(fury, inputStream, buf -> fury.deserialize(buf, outOfBandBuffers)); | ||
| } | ||
|
|
||
| public static Object deserialize(Fury fury, ReadableByteChannel channel) { | ||
| return readFromChannel(fury, channel, b -> fury.deserialize(b, null)); | ||
| } | ||
|
|
||
| public static Object deserialize( | ||
| Fury fury, ReadableByteChannel channel, Iterable<MemoryBuffer> outOfBandBuffers) { | ||
| return readFromChannel(fury, channel, b -> fury.deserialize(b, outOfBandBuffers)); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| public static <T> T deserializeJavaObject(Fury fury, InputStream inputStream, Class<T> type) { | ||
| return (T) | ||
| deserializeFromStream(fury, inputStream, buf -> fury.deserializeJavaObject(buf, type)); | ||
| } | ||
|
|
||
| public static Object deserializeJavaObject( | ||
| Fury fury, ReadableByteChannel channel, Class<?> type) { | ||
| return readFromChannel(fury, channel, b -> fury.deserializeJavaObject(b, type)); | ||
| } | ||
|
|
||
| private static Object readFromChannel( | ||
| Fury fury, ReadableByteChannel channel, Function<MemoryBuffer, Object> action) { | ||
| try { | ||
| MemoryBuffer buf = fury.getBuffer(); | ||
| ByteBuffer byteBuffer = ByteBuffer.allocate(4); | ||
| byteBuffer.order(ByteOrder.LITTLE_ENDIAN); | ||
| readByteBuffer(channel, byteBuffer, 4); | ||
| int size = byteBuffer.getInt(); | ||
| buf.ensure(size); | ||
| readByteBuffer(channel, buf.sliceAsByteBuffer(), size); | ||
| return action.apply(buf); | ||
| } finally { | ||
| fury.resetBuffer(); | ||
| } | ||
| } | ||
|
|
||
| private static void readByteBuffer(ReadableByteChannel channel, ByteBuffer buffer, int size) { | ||
| int read; | ||
| buffer.limit(buffer.position() + size); | ||
| try { | ||
| read = channel.read(buffer); | ||
| while (read < size) { | ||
| int len = channel.read(buffer); | ||
| if (len == -1) { | ||
| throw new DeserializationException( | ||
| String.format("Channel only have %s, but need %s", read, size)); | ||
| } | ||
| read += channel.read(buffer); | ||
| } | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| buffer.rewind(); | ||
| } | ||
|
|
||
| private static void serializeToStream( | ||
| Fury fury, OutputStream outputStream, Consumer<MemoryBuffer> function) { | ||
| MemoryBuffer buf = fury.getBuffer(); | ||
| buf.writerIndex(0); | ||
| try { | ||
| buf.writeInt32(-1); | ||
| function.accept(buf); | ||
| buf.putInt32(0, buf.writerIndex() - 4); | ||
| byte[] bytes = buf.getHeapMemory(); | ||
| if (bytes != null) { | ||
| outputStream.write(bytes, 0, buf.writerIndex()); | ||
| } else { | ||
| outputStream.write(buf.getBytes(0, buf.writerIndex())); | ||
| } | ||
| outputStream.flush(); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } finally { | ||
| fury.resetBuffer(); | ||
| } | ||
| } | ||
|
|
||
| private static Object deserializeFromStream( | ||
| Fury fury, InputStream inputStream, Function<MemoryBuffer, Object> function) { | ||
| MemoryBuffer buf = fury.getBuffer(); | ||
| try { | ||
| readToBufferFromStream(inputStream, buf); | ||
| return function.apply(buf); | ||
| } catch (Throwable t) { | ||
| throw ExceptionUtils.handleReadFailed(fury, t); | ||
| } finally { | ||
| fury.resetBuffer(); | ||
| } | ||
| } | ||
|
|
||
| private static void readToBufferFromStream(InputStream inputStream, MemoryBuffer buffer) | ||
| throws IOException { | ||
| buffer.readerIndex(0); | ||
| int read = readBytes(inputStream, buffer.getHeapMemory(), 0, 4); | ||
| Preconditions.checkArgument(read == 4); | ||
| int size = buffer.readInt32(); | ||
| buffer.ensure(4 + size); | ||
| read = readBytes(inputStream, buffer.getHeapMemory(), 4, size); | ||
| Preconditions.checkArgument(read == size); | ||
| } | ||
|
|
||
| private static int readBytes(InputStream inputStream, byte[] buffer, int offset, int size) | ||
| throws IOException { | ||
| int read = 0; | ||
| int count = 0; | ||
| while (read < size) { | ||
| if ((count = inputStream.read(buffer, offset + read, size - read)) == -1) { | ||
| break; | ||
| } | ||
| read += count; | ||
| } | ||
| return (read == 0 && count == -1) ? -1 : read; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.