PHP中使用 TUS 协议来实现可恢复文件上传

曾经尝试过用PHP上传大文件吗？想知道您是否可以从上次中断的地方继续上传，而不会在遇到任何中断的情况下再次重新上传整个数据？如果您觉得这个场景很熟悉，请接着往下阅读。

文件上传是我们几乎所有现代Web项目中的一项很常见的任务。在任何语言中，有了可用的工具，实现文件上传功能都不难。但是，对于大文件上传，这个事情还是有些让人头疼。

假设您正在尝试上传相当大的文件。您已经等待了一个多小时，上传率为90％。然后突然，您的连接断开或浏览器崩溃。上传被中止，您需要从头开始上传。这很令人沮丧，不是吗？更糟糕的是，如果您的连接速度较慢，就像世界上许多地方一样，无论尝试多少次，每次都只能上传第一部分内容。无论你重来多少次，你都不可能上传成功。你的心态扛得住嘛?!?!

在这篇文章中，我们将尝试通过使用tus协议以可恢复块的形式上传文件来解决PHP中的此问题。

首先什么是tus？

Tus是用于可恢复文件上传的基于HTTP的开放协议。可恢复意味着可以在中断的地方继续工作，而不会在遇到任何中断的情况下再次重新上传整个数据。如果用户希望暂停，则中断可能会发生，或者在网络问题或服务器中断的情况下，偶然发生。

Vimeo于2017年5月采用了 Tus协议。

为什么是tus？

引用Vimeo的博客：

我们之所以决定在上载堆栈中使用tus，是因为tus协议以简洁明了的方式标准化了上载文件的过程。这种标准化将使API开发人员可以将更多的精力放在其特定于应用程序的代码上，而不必将精力放在上传过程本身上。

通过这种方式上传文件的另一个主要好处是，您可以从笔记本电脑开始上传，甚至可以继续从移动设备或任何其他设备上载相同的文件，这可以极大地提升用户体验。

图片：基本的Tus架构

入门

从添加我们的依赖关系开始

$ composer require ankitpokhrel/tus-php

tus-php是用于tus可断续上传协议v1.0.0的纯PHP框架服务器和客户端实现。
tus-php-for用于tus可恢复上载协议v1.0.0的纯PHP服务器和客户端 github.com

更新：Vimeo现在在其官方PHP库的 v3 中将TusPHP 用于Vimeo API。

创建一个服务器来处理我们的请求

这就是简单服务器的外观。

// server.php

$server   = new \TusPhp\Tus\Server('redis');

$response = $server->serve();

$response->send();

exit(0); // 从当前的PHP进程退出.

您需要配置服务器以响应特定的端点。例如，在Nginx中，您可以执行以下操作：

# nginx.conf

location /files {

    try_files $uri $uri/ /path/to/server.php?$query_string;

}

假设服务器的URL是http：//server.tus.local。因此，基于上面的nginx配置，我们可以使用http：//server.tus.local/files访问tus端点。

现在，我们可以使用以下RESTful端点。

# 收集有关服务器当前配置的信息\

OPTIONS /files

# 检查指定的上传\

HEAD /files/{upload-key}

# 创建一个新的上传\

POST /files

# 创建一个新的上传\

PATCH /files/{upload-key}

# 创建一个新的上传\

DELETE /files/{upload-key}

查看协议详细信息以获取有关端点的更多信息。

如果您使用的是Laravel之类的框架，则不需要修改服务器配置，而可以在框架路由文件中定义到所有基于tus端点的路由。这个我们将在另一个教程中对此进行详细介绍。

使用 tus-php 客户端处理上传

一旦服务器就位，就可以使用客户端上载文件。让我们首先创建一个简单的HTML表单以获取用户输入。

<form action="upload.php" method="post" enctype="multipart/form-data">

    <input type="file" name="tus_file" id="tus-file" />

    <input type="submit" value="Upload" />

</form>

提交表单后，我们需要按照几个步骤来处理上传。

创建一个tus-php客户端对象

// Tus client

$client = new \TusPhp\Tus\Client('http://server.tus.local');

上面代码中的第一个参数是您的 tus 服务器端点。

2. 使用文件元数据初始化客户端

为了确保上传文件的唯一性，我们需要使用一些标识符来识别即将到来的请求中的上传。为此，我们将必须生成一个唯一的上传密钥，该密钥可在以后用于恢复上传。您可以提供一个上传密钥，也可以让系统自己生成一个密钥。

// 设置上传密钥和文件元数据

$client->setKey($uploadKey)

    ->file($_FILES['tus_file']['tmp_name'], 'your file name');

如果您未明确提供上传密钥，可以这样写，系统会自动生成：

$client->file($_FILES['tus_file']['tmp_name'], 'your file name');

$uploadKey = $client->getKey(); // Unique upload key

3. 分块上传文件

// $chunkSize 是以字节为单位的，例如 5000000 等于 5 MB

$bytesUploaded = $client->upload($chunkSize);

下次，当您要上传另一个块时，可以使用相同的上传密钥继续。

// 在下一个请求中恢复文件

$bytesUploaded = $client->setKey($uploadKey)->upload($chunkSize);

文件全部上传完成后，默认情况下，服务器会使用 sha256 来校验文件总和，以确保不会有丢失的文件。

使用 tus-js-client 客户端处理文件上传

tus 协议的团队还开发了一个模块化的文件上传插件 Uppy。您可以使用uppy将正式的tus-js-client与tus-php服务器无缝集成。这意味着我们正在使用服务器的php实现和客户端的js实现。

uppy.use(Tus, {

  endpoint: 'https://server.tus.local/files/', // 你的 tus 服务器

  resume: true,

  autoRetry: true,

  retryDelays: [0, 1000, 3000, 5000]

})

更多细节可以查看uppy的文档，还有些例子可以供你参考。

分块上传

tus-php 服务器支持 concatenation 扩展，并且可以把多次上传的文件合为一个文件。因此，我们可以在客户端支持并行上传以及非连续的分块文件上传。

使用 tus-php 实现分块上传

tus-partial-upload.php

<?php

// 文件唯一标识码

$uploadKey = uniqid();

$client->setKey($uploadKey)->file('/path/to/file', 'chunk_a.ext');

// 从第 1000  个字节开始上传 10000 字节

$bytesUploaded = $client->seek(1000)->upload(10000);

$chunkAkey     = $client->getKey();

// 从 第 0 个字节开始上传 10000 字节

$bytesUploaded = $client->setFileName('chunk_b.ext')->seek(0)->upload(1000);

$chunkBkey     = $client->getKey();

// 从第 11000 个字节  (10000 +  1000) 开始上传剩余的字节

$bytesUploaded = $client->setFileName('chunk_c.ext')->seek(11000)->upload();

$chunkCkey     = $client->getKey();

// 把分块上传的文件组合起来

$client->setFileName('actual_file.ext')->concat($uploadKey, $chunkAkey, $chunkBkey, $chunkCkey);

分块上传的完整例子在这里.

最后说一下TUS 协议

核心协议

核心协议描述如何继续中断的上传。这里假定你已经有一个用于上传的 RUL ，这个 URL 通常是由扩展协议 Creation创建。

所有客户端和服务端必须实现核心协议。

协议没有描述 RUL 的结构，而是留给协议的实现来决定。本文中所有展示的 URL 仅用于举例。

此外，认证和授权的实现也留给服务端来决定。

示例

用一个请求头指明应当从什么地方开始续传上传。

以下示例展示中断位置由70变为100

请求

HEAD /files/24e533e02ec3bc40c387f1a0e460e216 HTTP/1.1

Host: http://tus.example.org

Tus-Resumable: 1.0.0

响应

HTTP/1.1 200 OK

Upload-Offset: 70

Tus-Resumable: 1.0.0

对于给定的中断位置，客户端使用 PATCH 方法来续传。

请求

PATCH /files/24e533e02ec3bc40c387f1a0e460e216 HTTP/1.1

Host: http://tus.example.org

Content-Type: application/offset+octet-stream

Content-Length: 30

Upload-Offset: 70

Tus-Resumable: 1.0.0

[remaining 30 bytes]

响应

HTTP/1.1 204 No Content

Tus-Resumable: 1.0.0

Upload-Offset: 100

由于 tus-php 项目本身还出于初级阶段，某些部分将来可能会有改动。在 example 文件夹里，有三个不同的例子供你参考。如果任何问题或者建议，欢迎留言交流。

Happy Coding!