对于最新的稳定版本,请使用 Spring Framework 6.2.0! |
数据缓冲区和编解码器
Java NIO 提供ByteBuffer
但是许多库在顶部构建了自己的字节缓冲区 API,
特别是对于重用缓冲区和/或使用直接缓冲区的网络作
有利于性能。例如,Netty 的ByteBuf
层次结构,Undertow 使用
XNIO,Jetty 使用池化字节缓冲区和要释放的回调,依此类推。
这spring-core
module 提供了一组抽象来处理各种字节缓冲区
API 如下:
-
DataBufferFactory
抽象化数据缓冲区的创建。 -
DataBuffer
表示一个字节缓冲区,它可以被池化。 -
DataBufferUtils
提供数据缓冲区的实用程序方法。 -
编解码器将数据缓冲区流解码或编码为更高级别的对象。
DataBufferFactory
DataBufferFactory
用于通过以下两种方式之一创建数据缓冲区:
-
分配新的数据缓冲区,可以选择预先指定容量(如果已知),即 即使
DataBuffer
可以按需扩展和收缩。 -
将现有的
byte[]
或java.nio.ByteBuffer
,它用 一个DataBuffer
implementation 的 intent 中实现,这不涉及分配。
请注意,WebFlux 应用程序不会创建一个DataBufferFactory
直接,而是
通过ServerHttpResponse
或ClientHttpRequest
在客户端。
工厂的类型取决于底层的客户端或服务器,例如NettyDataBufferFactory
对于 Reactor Netty,DefaultDataBufferFactory
对于其他人来说。
DataBuffer
这DataBuffer
interface 提供与java.nio.ByteBuffer
而且还
带来一些额外的好处,其中一些是受到 Netty 的启发ByteBuf
.
以下是部分好处列表:
-
使用独立位置进行读写,即不需要调用
flip()
自 在 read 和 write 之间交替。 -
容量按需扩展,如
java.lang.StringBuilder
. -
池化缓冲区和引用计数
PooledDataBuffer
. -
将缓冲区视为
java.nio.ByteBuffer
,InputStream
或OutputStream
. -
确定给定字节的索引或最后一个索引。
PooledDataBuffer
如 ByteBuffer 的 Javadoc 中所述, 字节缓冲区可以是 direct 或 non-direct。直接缓冲区可能位于 Java 堆之外 这样就无需复制本机 I/O作。这使得直接缓冲区 对于通过 socket 接收和发送数据特别有用,但它们也更多 创建和发布成本高昂,这导致了池化缓冲区的想法。
PooledDataBuffer
是DataBuffer
这有助于引用计数
对于字节缓冲池至关重要。它是如何工作的?当PooledDataBuffer
是
allocated 的引用计数为 1。调用retain()
递增 count 的 count 中,而
调用release()
递减它。只要计数大于 0,缓冲区
保证不会被释放。当计数减少到 0 时,池化缓冲区可以是
released,这实际上可能意味着缓冲区的预留内存将返回到
内存池。
请注意,与其在PooledDataBuffer
直接,在大多数情况下,它更好
要使用DataBufferUtils
将 release 或 retain 应用于DataBuffer
仅当它是PooledDataBuffer
.
DataBufferUtils
DataBufferUtils
提供了许多 Utility 方法来作数据缓冲区:
-
将数据缓冲区流加入单个缓冲区中,可能具有零拷贝,例如通过 复合缓冲区,如果底层字节缓冲区 API 支持的话。
-
转
InputStream
或蔚来Channel
到Flux<DataBuffer>
,反之亦然 aPublisher<DataBuffer>
到OutputStream
或蔚来Channel
. -
释放或保留
DataBuffer
如果缓冲区是PooledDataBuffer
. -
跳过或获取字节流,直到达到特定的字节计数。
Codec
这org.springframework.core.codec
package 提供如下策略接口:
-
Encoder
编码Publisher<T>
转换为数据缓冲区流。 -
Decoder
解码Publisher<DataBuffer>
转换为更高级别的对象流。
这spring-core
module 提供byte[]
,ByteBuffer
,DataBuffer
,Resource
和String
编码器和解码器实现。这spring-web
模块添加 Jackson JSON,
Jackson Smile、JAXB2、Protocol Buffers 和其他编码器和解码器。请参阅 WebFlux 部分中的编解码器。
用DataBuffer
使用数据缓冲区时,必须特别小心以确保释放缓冲区 因为它们可能是共用的。我们将使用编解码器来说明 这是如何运作的,但概念更普遍地适用。让我们看看编解码器必须做什么 内部管理数据缓冲区。
一个Decoder
是在创建更高级别之前最后读取 input data buffers 的
对象,因此它必须按如下方式释放它们:
-
如果
Decoder
只需读取每个输入缓冲区,即可 立即释放它,它可以通过以下方式执行此作DataBufferUtils.release(dataBuffer)
. -
如果
Decoder
正在使用Flux
或Mono
运算符,例如flatMap
,reduce
和 其他的则在内部预取和缓存数据项,或者使用filter
,skip
和其他省略项的 Import,则doOnDiscard(DataBuffer.class, DataBufferUtils::release)
必须添加到 组合链来确保此类缓冲区在被丢弃之前被释放(可能 也是由于错误或取消信号的结果。 -
如果
Decoder
以任何其他方式保留一个或多个数据缓冲区,则它必须 确保在完全读取时释放它们,或者在出现错误或取消信号时释放它们 在读取和释放缓存的数据缓冲区之前进行。
请注意,DataBufferUtils#join
提供一种安全有效的数据聚合方式
buffer 流传输到单个数据缓冲区中。同样skipUntilByteCount
和takeUntilByteCount
是解码器可以使用的其他安全方法。
一Encoder
分配其他人必须读取 (和释放) 的数据缓冲区。所以一个Encoder
没什么可做的。但是,一个Encoder
必须注意在以下情况下释放数据缓冲区
使用数据填充缓冲区时发生序列化错误。例如:
-
Java
-
Kotlin
DataBuffer buffer = factory.allocateBuffer();
boolean release = true;
try {
// serialize and populate buffer..
release = false;
}
finally {
if (release) {
DataBufferUtils.release(buffer);
}
}
return buffer;
val buffer = factory.allocateBuffer()
var release = true
try {
// serialize and populate buffer..
release = false
} finally {
if (release) {
DataBufferUtils.release(buffer)
}
}
return buffer
的Encoder
负责释放它接收的数据缓冲区。
在 WebFlux 应用程序中,Encoder
用于写入 HTTP 服务器
响应或客户端 HTTP 请求,在这种情况下,释放数据缓冲区是
负责将代码写入服务器响应或客户端请求。
请注意,在 Netty 上运行时,有一些调试选项可用于排查缓冲区泄漏问题。