Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename InputStreamSubscriber to SubscriberInputStream

Browse Source 
It is both, but InputStream is what's exposed for public use,
in effect an InputStream backed by a Subscriber source.

See gh-31677
This commit is contained in:
rstoyanchev
2024-10-25 17:39:55 +01:00
parent 86a42db002
commit dfaf7a0c6a
5 changed files with 34 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
spring-core/src/main/java/org/springframework/core/io/buffer/DataBufferUtils.java
View File

@@ -472,16 +472,16 @@ public abstract class DataBufferUtils {
* Note: {@link Subscription#request(long)} happens eagerly for the first time upon subscription
* and then repeats every time {@code bufferSize - (bufferSize >> 2)} consumed.
* @param publisher the source of {@link DataBuffer} which should be represented as an {@link InputStream}
* @param bufferSize the maximum amount of {@link DataBuffer} prefetched in advance and stored inside {@link InputStream}
* @param demand the maximum number of buffers to request from the Publisher and buffer on an ongoing basis
* @return an {@link InputStream} instance representing given {@link Publisher} messages
*/
public static <T extends DataBuffer> InputStream subscribeAsInputStream(Publisher<T> publisher, int bufferSize) {
public static <T extends DataBuffer> InputStream subscriberInputStream(Publisher<T> publisher, int demand) {
Assert.notNull(publisher, "Publisher must not be null");
Assert.isTrue(bufferSize > 0, "Buffer size must be > 0");
Assert.isTrue(demand > 0, "maxBufferCount must be > 0");
InputStreamSubscriber inputStreamSubscriber = new InputStreamSubscriber(bufferSize);
publisher.subscribe(inputStreamSubscriber);
return inputStreamSubscriber;
SubscriberInputStream subscriber = new SubscriberInputStream(demand);
publisher.subscribe(subscriber);
return subscriber;
}

12
spring-core/src/main/java/org/springframework/core/io/buffer/InputStreamSubscriber.java → spring-core/src/main/java/org/springframework/core/io/buffer/SubscriberInputStream.java
View File

@@ -39,13 +39,13 @@ import org.springframework.util.Assert;
* Bridges between {@link Publisher Publisher&lt;DataBuffer&gt;} and {@link InputStream}.
*
* <p>Note that this class has a near duplicate in
* {@link org.springframework.http.client.InputStreamSubscriber}.
* {@link org.springframework.http.client.SubscriberInputStream}.
*
* @author Oleh Dokuka
* @author Rossen Stoyanchev
* @since 6.2
*/
final class InputStreamSubscriber extends InputStream implements Subscriber<DataBuffer> {
final class SubscriberInputStream extends InputStream implements Subscriber<DataBuffer> {
private static final Object READY = new Object();
@@ -82,10 +82,10 @@ final class InputStreamSubscriber extends InputStream implements Subscriber<Data
private Throwable error;
InputStreamSubscriber(int prefetch) {
this.prefetch = prefetch;
this.limit = (prefetch == Integer.MAX_VALUE ? Integer.MAX_VALUE : prefetch - (prefetch >> 2));
this.queue = new ArrayBlockingQueue<>(prefetch);
SubscriberInputStream(int demand) {
this.prefetch = demand;
this.limit = (demand == Integer.MAX_VALUE ? Integer.MAX_VALUE : demand - (demand >> 2));
this.queue = new ArrayBlockingQueue<>(demand);
this.lock = new ReentrantLock(false);
}

8
spring-core/src/test/java/org/springframework/core/io/buffer/DataBufferUtilsTests.java
View File

@@ -754,7 +754,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[readChunkSize];
List<String> words = new ArrayList<>();
try (InputStream in = DataBufferUtils.subscribeAsInputStream(publisher, bufferSize)) {
try (InputStream in = DataBufferUtils.subscriberInputStream(publisher, bufferSize)) {
int read;
while ((read = in.read(chunk)) > -1) {
words.add(new String(chunk, 0, read, StandardCharsets.UTF_8));
@@ -791,7 +791,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[4];
List<String> words = new ArrayList<>();
try (InputStream in = DataBufferUtils.subscribeAsInputStream(publisher, 1)) {
try (InputStream in = DataBufferUtils.subscriberInputStream(publisher, 1)) {
int read;
while ((read = in.read(chunk)) > -1) {
words.add(new String(chunk, 0, read, StandardCharsets.UTF_8));
@@ -830,7 +830,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[3];
ArrayList<String> words = new ArrayList<>();
try (InputStream inputStream = DataBufferUtils.subscribeAsInputStream(publisher, 1)) {
try (InputStream inputStream = DataBufferUtils.subscriberInputStream(publisher, 1)) {
words.add(new String(chunk,0, inputStream.read(chunk), StandardCharsets.UTF_8));
assertThat(inputStream.read()).isEqualTo(' ' & 0xFF);
words.add(new String(chunk,0, inputStream.read(chunk), StandardCharsets.UTF_8));
@@ -874,7 +874,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[3];
ArrayList<String> words = new ArrayList<>();
try (InputStream in = DataBufferUtils.subscribeAsInputStream(publisher, ThreadLocalRandom.current().nextInt(1, 4))) {
try (InputStream in = DataBufferUtils.subscriberInputStream(publisher, ThreadLocalRandom.current().nextInt(1, 4))) {
in.read(chunk);
String word = new String(chunk, StandardCharsets.UTF_8);
words.add(word);

23
spring-web/src/main/java/org/springframework/http/client/InputStreamSubscriber.java → spring-web/src/main/java/org/springframework/http/client/SubscriberInputStream.java
View File

@@ -42,16 +42,16 @@ import org.springframework.util.Assert;
* Bridges between {@link Flow.Publisher Flow.Publisher&lt;T&gt;} and {@link InputStream}.
*
* <p>Note that this class has a near duplicate in
* {@link org.springframework.core.io.buffer.InputStreamSubscriber}.
* {@link org.springframework.core.io.buffer.SubscriberInputStream}.
*
* @author Oleh Dokuka
* @author Rossen Stoyanchev
* @since 6.2
* @param <T> the publisher byte buffer type
*/
final class InputStreamSubscriber<T> extends InputStream implements Flow.Subscriber<T> {
final class SubscriberInputStream<T> extends InputStream implements Flow.Subscriber<T> {
private static final Log logger = LogFactory.getLog(InputStreamSubscriber.class);
private static final Log logger = LogFactory.getLog(SubscriberInputStream.class);
private static final Object READY = new Object();
@@ -94,12 +94,12 @@ final class InputStreamSubscriber<T> extends InputStream implements Flow.Subscri
private Throwable error;
private InputStreamSubscriber(Function<T, byte[]> mapper, Consumer<T> onDiscardHandler, int prefetch) {
private SubscriberInputStream(Function<T, byte[]> mapper, Consumer<T> onDiscardHandler, int demand) {
this.mapper = mapper;
this.onDiscardHandler = onDiscardHandler;
this.prefetch = prefetch;
this.limit = (prefetch == Integer.MAX_VALUE ? Integer.MAX_VALUE : prefetch - (prefetch >> 2));
this.queue = new ArrayBlockingQueue<>(prefetch);
this.prefetch = demand;
this.limit = (demand == Integer.MAX_VALUE ? Integer.MAX_VALUE : demand - (demand >> 2));
this.queue = new ArrayBlockingQueue<>(demand);
this.lock = new ReentrantLock(false);
}
@@ -122,17 +122,16 @@ final class InputStreamSubscriber<T> extends InputStream implements Flow.Subscri
* @param publisher the source of {@link DataBuffer} which should be represented as an {@link InputStream}
* @param mapper function to transform &lt;T&gt; element to {@code byte[]}. Note, &lt;T&gt; should be released during the mapping if needed.
* @param onDiscardHandler &lt;T&gt; element consumer if returned {@link InputStream} is closed prematurely.
* @param bufferSize the maximum amount of &lt;T&gt; elements prefetched in advance and stored inside {@link InputStream}
* @param demand the maximum number of buffers to request from the Publisher and buffer on an ongoing basis
* @return an {@link InputStream} instance representing given {@link Flow.Publisher} messages
*/
public static <T> InputStream subscribeTo(Flow.Publisher<T> publisher, Function<T, byte[]> mapper, Consumer<T> onDiscardHandler, int bufferSize) {
public static <T> InputStream subscribeTo(Flow.Publisher<T> publisher, Function<T, byte[]> mapper, Consumer<T> onDiscardHandler, int demand) {
Assert.notNull(publisher, "Flow.Publisher must not be null");
Assert.notNull(mapper, "mapper must not be null");
Assert.notNull(onDiscardHandler, "onDiscardHandler must not be null");
Assert.isTrue(bufferSize > 0, "bufferSize must be greater than 0");
Assert.isTrue(demand > 0, "demand must be greater than 0");
InputStreamSubscriber<T> iss = new InputStreamSubscriber<>(mapper, onDiscardHandler, bufferSize);
SubscriberInputStream<T> iss = new SubscriberInputStream<>(mapper, onDiscardHandler, demand);
publisher.subscribe(iss);
return iss;
}

14
spring-web/src/test/java/org/springframework/http/client/InputStreamSubscriberTests.java → spring-web/src/test/java/org/springframework/http/client/SubscriberInputStreamTests.java
View File

@@ -36,12 +36,12 @@ import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIOException;
/**
* Unit tests for {@link InputStreamSubscriber}.
* Unit tests for {@link SubscriberInputStream}.
*
* @author Arjen Poutsma
* @author Oleh Dokuka
*/
class InputStreamSubscriberTests {
class SubscriberInputStreamTests {
private static final byte[] FOO = "foo".getBytes(UTF_8);
@@ -98,7 +98,7 @@ class InputStreamSubscriberTests {
this.byteMapper, this.executor, null);
try (InputStream is = InputStreamSubscriber.subscribeTo(
try (InputStream is = SubscriberInputStream.subscribeTo(
toStringPublisher(publisher), s -> s.getBytes(UTF_8), s -> {}, 1)) {
byte[] chunk = new byte[3];
@@ -123,7 +123,7 @@ class InputStreamSubscriberTests {
},
this.byteMapper, this.executor, 2);
try (InputStream is = InputStreamSubscriber.subscribeTo(
try (InputStream is = SubscriberInputStream.subscribeTo(
toStringPublisher(publisher), s -> s.getBytes(UTF_8), s -> {}, 1)) {
StringBuilder stringBuilder = new StringBuilder();
@@ -167,7 +167,7 @@ class InputStreamSubscriberTests {
List<String> discarded = new ArrayList<>();
try (InputStream is = InputStreamSubscriber.subscribeTo(
try (InputStream is = SubscriberInputStream.subscribeTo(
toStringPublisher(publisher), s -> s.getBytes(UTF_8), discarded::add, 1)) {
byte[] chunk = new byte[3];
@@ -198,7 +198,7 @@ class InputStreamSubscriberTests {
},
this.byteMapper, this.executor, null);
try (InputStream is = InputStreamSubscriber.subscribeTo(
try (InputStream is = SubscriberInputStream.subscribeTo(
toStringPublisher(publisher), s -> s.getBytes(UTF_8), s -> {}, 1)) {
byte[] chunk = new byte[3];
@@ -234,7 +234,7 @@ class InputStreamSubscriberTests {
Throwable savedEx = null;
StringBuilder sb = new StringBuilder();
try (InputStream is = InputStreamSubscriber.subscribeTo(
try (InputStream is = SubscriberInputStream.subscribeTo(
publisher, s -> { throw new NullPointerException("boom"); }, s -> {}, 1)) {
byte[] chunk = new byte[3];