【亲测免费】 tus-js-client 使用教程

2026-01-17 08:44:34作者：申梦珏Efrain

项目介绍

tus-js-client 是一个纯 JavaScript 客户端，用于 tus 可恢复上传协议。它可以在浏览器、Node.js、React Native 和 Apache Cordova 应用程序中使用。该协议版本为 1.0.0。tus-js-client 支持断点续传，即使在网络中断或服务器宕机的情况下也能保证文件上传的完整性。

项目快速启动

安装

你可以通过 npm 或 yarn 安装 tus-js-client：

npm install tus-js-client
# 或者
yarn add tus-js-client

基本使用

以下是一个简单的示例，展示如何在浏览器中使用 tus-js-client 上传文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Tus Upload Example</title>
    <script src="https://cdn.jsdelivr.net/npm/tus-js-client@latest/dist/tus.min.js"></script>
</head>
<body>
    <input type="file" id="fileInput">
    <button onclick="startUpload()">Upload</button>
    <script>
        function startUpload() {
            const fileInput = document.getElementById('fileInput');
            const file = fileInput.files[0];

            const upload = new tus.Upload(file, {
                endpoint: 'http://localhost:1080/files/',
                retryDelays: [0, 3000, 5000, 10000, 20000],
                metadata: {
                    filename: file.name,
                    filetype: file.type
                },
                onError: function (error) {
                    console.log('Failed because: ' + error);
                },
                onProgress: function (bytesUploaded, bytesTotal) {
                    const percentage = (bytesUploaded / bytesTotal * 100).toFixed(2);
                    console.log(bytesUploaded, bytesTotal, percentage + '%');
                },
                onSuccess: function () {
                    console.log('Upload finished:', upload.url);
                }
            });

            upload.start();
        }
    </script>
</body>
</html>

应用案例和最佳实践

应用案例

tus-js-client 可以广泛应用于需要大文件上传的场景，例如：

视频上传：用户可以上传大型视频文件，即使网络中断也能保证上传的完整性。
图片上传：支持高分辨率图片的上传，确保上传过程中不会因为网络问题导致上传失败。
文件备份：用户可以上传重要文件进行备份，即使网络不稳定也能保证文件的完整上传。

最佳实践

设置合理的重试延迟：通过设置 retryDelays 参数，可以在网络不稳定时自动重试上传，提高上传成功率。
使用元数据：通过 metadata 参数，可以传递文件的额外信息，如文件名和文件类型，便于服务器处理。
错误处理：在 onError 回调中处理上传过程中可能出现的错误，确保用户能够及时了解上传状态。

典型生态项目

tus-js-client 是 tus 生态系统的一部分，以下是一些相关的项目：

tusd：一个 Go 语言实现的服务器端 tus 协议实现，用于处理客户端的上传请求。
tus-android-client：一个 Android 客户端库，用于在 Android 应用中实现 tus 协议上传。
tus-java-client：一个 Java 客户端库，用于在 Java 应用中实现 tus 协议上传。
tusdotnet：一个 .NET 实现的服务器端 tus 协议实现，用于处理客户端的上传请求。

这些项目共同构成了 tus 生态系统，为用户提供了从客户端到服务器端的完整解决方案。

tus-js-client

A pure JavaScript client for the tus resumable upload protocol

项目地址：https://gitcode.com/gh_mirrors/tu/tus-js-client

登录后查看全文