upload_progress_template

`upload_progress_template` 指令在 NGINX 中定义了用于上报上传进度数据的模板。

语法upload_progress_template ;
默认值none
上下文http, server, location
参数2

说明

upload_progress_template 指令是 NGINX 上传进度跟踪模块的一部分,该模块允许用户监控服务器处理的文件上传的进度。此指令为在查询上传进度时返回给客户端的响应设置模板。它接受两个参数:模板字符串和报告中要包含的变量说明。该模板可以定制以不同格式输出数据,例如 JSON、纯文本或客户端所需的任何其他字符串格式。

此指令应与 track_uploads 指令结合使用,后者在指定位置启用上传跟踪功能。当客户端向服务器发出 POST 请求时,NGINX 会跟踪上传进度并使用有关上传状态的实时数据更新相应的模板。模板中包含的变量允许开发者根据需要显示特定信息,例如已上传的文件大小和状态消息。

upload_progress_template 指令有助于创建需要以视觉化方式显示上传进度的动态用户界面,符合现代 Web 标准。正确实现需要确保所指定的模板准确反映上传跟踪模块捕获的进度数据,该模板可以针对各种应用进行全面定制。

配置示例

location /upload {
    upload_progress zone_name 1m;
    track_uploads zone_name 60s;
    upload_progress_template "{ "size": "$size", "status": "$status" }" ;
}

确保模板格式正确,以防在渲染响应时发生错误。

模板中使用的变量必须与上传进度上下文中可用的变量相匹配。

无效的模板语法可能导致进度报告失败。

← 返回所有指令