导读:本期聚焦于小伙伴创作的《使用Fetch API实现文件上传进度跟踪:TransformStream与ReadableStream应用指南》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《使用Fetch API实现文件上传进度跟踪:TransformStream与ReadableStream应用指南》有用,将其分享出去将是对创作者最好的鼓励。

使用Fetch请求跟踪文件上传进度

在前端开发中,文件上传是常见的业务场景,很多时候我们需要让用户感知到上传的进度,避免等待时的焦虑感。传统的文件上传进度跟踪通常使用XMLHttpRequest实现,因为其自带progress事件。而Fetch API作为更现代的网络请求方案,本身并不支持原生的进度事件,不过我们可以结合ReadableStreamTransformStream来实现Fetch请求下的文件上传进度跟踪。

核心实现思路

要实现Fetch上传进度跟踪,核心逻辑分为以下几个步骤:

  • 获取需要上传的文件对象,计算文件总大小

  • 创建TransformStream,在流的处理过程中累加已经上传的字节数,计算进度比例

  • 使用Fetch API发送请求,将文件流通过TransformStream处理后作为请求体

  • 通过回调函数或者事件将进度信息传递给外部,用于更新UI

完整实现代码

以下是一个完整的文件上传进度跟踪示例,包含前端页面和核心逻辑:

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Fetch文件上传进度跟踪</title>
</head>
<body>
  <input type="file" id="fileInput">
  <button id="uploadBtn">开始上传</button>
  <div id="progressContainer" style="margin-top: 20px; width: 300px; height: 20px; background-color: #f0f0f0;">
    <div id="progressBar" style="width: 0%; height: 100%; background-color: #4caf50;"></div>
  </div>
  <p id="progressText">未开始上传</p>

  <script>
    const fileInput = document.getElementById('fileInput');
    const uploadBtn = document.getElementById('uploadBtn');
    const progressBar = document.getElementById('progressBar');
    const progressText = document.getElementById('progressText');

    // 创建进度跟踪的TransformStream
    function createProgressStream(totalSize, onProgress) {
      let uploadedSize = 0;
      return new TransformStream({
        transform(chunk, controller) {
          // 累加已上传的字节数,chunk是Uint8Array类型
          uploadedSize += chunk.byteLength;
          // 计算进度百分比
          const progress = Math.round((uploadedSize / totalSize) * 100);
          // 回调进度信息
          onProgress(progress, uploadedSize, totalSize);
          // 将chunk传递给下一个流
          controller.enqueue(chunk);
        }
      });
    }

    // 处理文件上传
    async function uploadFile(file) {
      if (!file) {
        alert('请先选择文件');
        return;
      }

      const totalSize = file.size;
      // 重置进度显示
      progressBar.style.width = '0%';
      progressText.textContent = '上传中:0%';

      // 创建进度跟踪的流
      const progressStream = createProgressStream(totalSize, (progress, uploaded, total) => {
        // 更新进度条和文本
        progressBar.style.width = `${progress}%`;
        progressText.textContent = `上传中:${progress}%(${uploaded}/${total} 字节)`;
      });

      try {
        // 发起Fetch请求,将文件流通过progressStream处理
        const response = await fetch('https://www.ipipp.com/upload', {
          method: 'POST',
          // 将文件流管道到progressStream,再作为请求体
          body: file.stream().pipeThrough(progressStream),
          // 如果后端需要表单格式,可以调整headers,这里示例为二进制流上传
          headers: {
            'Content-Type': 'application/octet-stream'
          }
        });

        if (response.ok) {
          progressText.textContent = '上传完成';
          alert('文件上传成功');
        } else {
          progressText.textContent = '上传失败';
          alert('文件上传失败');
        }
      } catch (error) {
        progressText.textContent = '上传出错';
        alert(`上传过程出错:${error.message}`);
      }
    }

    // 绑定上传按钮点击事件
    uploadBtn.addEventListener('click', () => {
      const file = fileInput.files[0];
      uploadFile(file);
    });
  </script>
</body>
</html>

代码说明

上述代码的核心部分在于createProgressStream函数,它创建了一个TransformStream实例:

  • TransformStreamtransform方法会在每个数据块被处理时触发,我们可以通过chunk.byteLength获取当前数据块的大小,累加得到已上传的总字节数。

  • 通过传入的onProgress回调函数,将计算得到的进度百分比、已上传字节数、总字节数传递给外部,用于更新页面的进度条和文本。

  • 在Fetch请求中,我们通过file.stream().pipeThrough(progressStream)将文件的原始流经过进度跟踪流处理后再作为请求体,这样所有上传的数据都会经过进度统计逻辑。

兼容性与注意事项

需要注意以下几点:

  • TransformStreamReadableStreampipeThrough方法是较新的浏览器特性,如果需要兼容旧版浏览器,可能需要添加对应的polyfill。

  • 上述示例的上传地址为https://www.ipipp.com/upload,实际使用时需要替换为真实的后端上传接口地址。

  • 如果后端要求使用multipart/form-data格式上传文件,需要调整请求体的构造方式,比如使用FormData结合流处理,不过FormData本身不支持直接管道流,这类场景下可能需要额外封装,或者仍使用XMLHttpRequest实现更简便的进度跟踪。

  • 进度计算是基于已发送的数据块大小,实际网络传输中可能存在缓冲等情况,进度显示可能存在微小偏差,属于正常现象。

总结

虽然Fetch API本身没有原生的进度事件,但通过结合TransformStream对上传流进行拦截处理,我们可以很方便地实现文件上传的进度跟踪。这种方式既使用了现代的Fetch API,又满足了进度展示的业务需求,适合在现代浏览器环境下使用。

FetchAPI 文件上传进度跟踪 TransformStream ReadableStream 前端文件上传

免责声明:已尽一切努力确保本网站所含信息的准确性。网站部分内容来源于网络或由用户自行发表,内容观点不代表本站立场。本站是个人网站免费分享,内容仅供个人学习、研究或参考使用,如内容中引用了第三方作品,其版权归原作者所有。若内容触犯了您的权益,请联系我们进行处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。前端、网络、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握网站开发与运维所需的核心技术栈。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端逻辑,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。