从零手写实现 nginx-07-大文件传输分块传输（chunked transfer）/ 分页传 ...

写过一篇 · 2024-6-6 17:40:35

前言

大家好，我是老马。很高兴遇到你。
我们希望实现最简单的 http 服务信息，可以处理静态文件。
如果你想知道 servlet 如何处理的，可以参考我的另一个项目：

手写从零实现简易版 tomcat minicat

RandomAccessFile randomAccessFile = new RandomAccessFile(file, "r"); // 以只读的方式打开文件
long fileLength = randomAccessFile.length();
// 创建一个默认的HTTP响应
HttpResponse response = new DefaultHttpResponse(HTTP_1_1, OK);
// 设置Content Length
HttpUtil.setContentLength(response, fileLength);
// 读取文件内容到字节数组
byte[] fileContent = new byte[(int) fileLength];
int bytesRead = randomAccessFile.read(fileContent);
if (bytesRead != fileLength) {
sendError(ctx, INTERNAL_SERVER_ERROR);
return;
}
// 将文件内容转换为FullHttpResponse
FullHttpResponse fullHttpResponse = new DefaultFullHttpResponse(HTTP_1_1, OK);
fullHttpResponse.content().writeBytes(fileContent);
fullHttpResponse.headers().set(HttpHeaderNames.CONTENT_LENGTH, fileLength);
// 写入HTTP响应并关闭连接
ctx.writeAndFlush(fullHttpResponse).addListener(ChannelFutureListener.CLOSE);

复制代码

这段代码的主要变化如下：

读取文件内容：使用randomAccessFile.read(fileContent)一次性读取整个文件到字节数组fileContent中。
创建FullHttpResponse：使用DefaultFullHttpResponse创建一个完整的HTTP相应对象，并将文件内容写入到相应的content()中。
设置Content-Length：在FullHttpResponse的headers中设置Content-Length。
发送相应并关闭毗连：使用ctx.writeAndFlush(fullHttpResponse)一次性发送整个相应，并通过.addListener(ChannelFutureListener.CLOSE)确保在发送完成后关闭毗连。

请注意，这种方式适用于文件大小不是很大的环境，因为整个文件内容被加载到了内存中。
如果文件非常大，这种方式可能会导致内存溢出。
对于大文件，推荐使用分块传输（chunked transfer）大概分页传输（paging）的方式。
分块传输（chunked transfer）

分块传输（Chunked Transfer）是一种HTTP协议中用于传输数据的方法，允许服务器在知道整个相应内容大小之前就开始发送数据。
这在发送大文件或动态天生的内容时非常有用。
以下是使用Netty实现分块传输的一个示例：

RandomAccessFile randomAccessFile = new RandomAccessFile(file, "r"); // 以只读的方式打开文件
long fileLength = randomAccessFile.length();
// 创建一个默认的HTTP响应
HttpResponse response = new DefaultHttpResponse(HTTP_1_1, OK);
// 由于是分块传输，移除Content-Length头
response.headers().remove(HttpHeaderNames.CONTENT_LENGTH);
// 如果request中有KEEP ALIVE信息
if (HttpUtil.isKeepAlive(request)) {
response.headers().set(HttpHeaderNames.CONNECTION, HttpHeaderValues.KEEP_ALIVE);
}
// 将HTTP响应写入Channel
ctx.write(response);
// 分块传输文件内容
final int chunkSize = 8192; // 设置分块大小
ByteBuffer buffer = ByteBuffer.allocate(chunkSize);
while (true) {
int bytesRead = randomAccessFile.read(buffer.array());
if (bytesRead == -1) { // 文件读取完毕
break;
}
buffer.limit(bytesRead);
// 写入分块数据
ctx.write(new DefaultHttpContent(Unpooled.wrappedBuffer(buffer)));
buffer.clear(); // 清空缓冲区以供下次使用
}
// 写入最后一个分块，即空的HttpContent，表示传输结束
ctx.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT).addListener(ChannelFutureListener.CLOSE);

复制代码

这段代码的主要变化如下：

移除Content-Length头：由于是分块传输，我们不需要在相应头中设置Content-Length。
分块读取文件：使用一个固定大小的缓冲区ByteBuffer来分块读取文件内容。
发送分块数据：在循环中，每次读取文件内容到缓冲区后，创建一个DefaultHttpContent对象，并将缓冲区的数据包装在Unpooled.wrappedBuffer()中，然后写入Channel。
发送结束标志：在文件读取完毕后，发送一个空的LastHttpContent对象，以标志HTTP消息体的结束。
关闭毗连：在发送完最后一个分块后，使用addListener(ChannelFutureListener.CLOSE)确保关闭毗连。

分页传输

分页传输通常是指将大文件分成多个小的部分（页），然后逐个发送这些部分。
这种方式适用于在网络编程中传输大文件，因为它可以淘汰内存的使用，并且允许吸收方渐渐处理数据。
在Netty中，实现分页传输通常涉及到手动控制数据的发送，而不是使用HTTP分块编码（chunked encoding）。
以下是一个简化的分页传输实现示例，我们将使用Netty的FileRegion来实现高效的文件传输：

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.FileRegion;
import io.netty.channel.socket.SocketChannel;
import io.netty.handler.stream.ChunkedFile;
import java.io.RandomAccessFile;
import java.io.IOException;
import java.nio.channels.FileChannel;
import java.nio.file.Path;
import java.nio.file.Paths;
public class FilePageTransfer {
public static void sendFile(ChannelHandlerContext ctx, Path filePath) {
try {
RandomAccessFile randomAccessFile = new RandomAccessFile(filePath.toFile(), "r");
FileChannel fileChannel = randomAccessFile.getChannel();
long fileSize = fileChannel.size();
long position = 0;
final long pageSize = 8192; // 定义每页的大小，可以根据实际情况调整
while (position < fileSize) {
long remaining = fileSize - position;
long size = remaining > pageSize ? pageSize : remaining;
// 使用FileRegion进行传输
FileRegion region = new DefaultFileRegion(fileChannel, position, size);
((SocketChannel) ctx.channel()).write(region);
// 更新位置
position += size;
// 检查传输是否成功
if (!region.isWritten()) {
// 传输失败，可以进行重试或者发送错误响应
break;
}
}
// 发送结束标记
ctx.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT).addListener(ChannelFutureListener.CLOSE);
} catch (IOException e) {
e.printStackTrace();
// 发送错误响应
ctx.writeAndFlush(new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.NOT_FOUND));
}
}
}

复制代码

在这个示例中，我们定义了一个sendFile方法，它接受一个ChannelHandlerContext和一个文件路径Path作为参数。以下是该方法的主要步骤：

打开文件：使用RandomAccessFile打开要传输的文件，并获取FileChannel。
计算文件大小：通过fileChannel.size()获取文件的总大小。
分页传输：使用一个循环来逐页读取文件内容。在每次迭代中，我们计算要传输的数据块的大小，并使用FileRegion来表示这部分数据。
写入Channel：将FileRegion写入Netty的Channel。
更新位置：更新position变量以指向下一页的开始位置。
检查传输状态：通过region.isWritten()检查数据是否成功写入。
发送结束标志：传输完成后，发送LastHttpContent.EMPTY_LAST_CONTENT来标志消息结束，并关闭毗连。
错误处理：如果在传输过程中发生非常，发送一个错误相应。

请注意，这个示例是一个简化的版本，它没有处理HTTP协议的细节，也没有设置HTTP头信息。
在实际的HTTP服务器实现中，你需要在发送文件内容之前发送一个包含适当头信息的HTTP相应。
别的，LastHttpContent.EMPTY_LAST_CONTENT用于HTTP/1.1，如果你使用的是HTTP/1.0，可能需要差异的处理方式。
改进后的核心代码

统一的分发

为了避免实现膨胀，难以管理，我们将实现全部抽象。

protected NginxRequestDispatch getDispatch(NginxRequestDispatchContext context) {
final FullHttpRequest requestInfoBo = context.getRequest();
final NginxConfig nginxConfig = context.getNginxConfig();
// 消息解析不正确
/*如果无法解码400*/
if (!requestInfoBo.decoderResult().isSuccess()) {
return NginxRequestDispatches.http400();
}
// 文件
File targetFile = getTargetFile(requestInfoBo, nginxConfig);
// 是否存在
if(targetFile.exists()) {
// 设置文件
context.setFile(targetFile);
// 如果是文件夹
if(targetFile.isDirectory()) {
return NginxRequestDispatches.fileDir();
}
long fileSize = targetFile.length();
if(fileSize <= NginxConst.BIG_FILE_SIZE) {
return NginxRequestDispatches.fileSmall();
}
return NginxRequestDispatches.fileBig();
} else {
return NginxRequestDispatches.http404();
}
}

复制代码

小结

本节我们实现了一个大文件的下载处理，主要思想就是分段。
可以考虑类似于视频软件，采用分段加载及时播放的方式。
下一节，我们考虑实现以下文件的范围查询。
我是老马，期待与你的下次重逢。
开源地点

为了便于大家学习，已经将 nginx 开源

https://github.com/houbb/nginx4j

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

		自动登录	找回密码
密码			立即注册

从零手写实现 nginx-07-大文件传输分块传输（chunked transfer）/ 分页传 ...

0 个回复

快速回复

楼主热帖

标签云

从零手写实现 nginx-07-大文件传输 分块传输（chunked transfer）/ 分页传 ...

0 个回复

快速回复

楼主热帖

标签云

从零手写实现 nginx-07-大文件传输分块传输（chunked transfer）/ 分页传 ...