本文背景
在下载arraybuffer文件时,想要获取文件名,这时引入本文内容Content-Disposition,我们在Content-Disposition获取到文件名就可以在下载后的文件以该文件名命名了。
一、简介
Content-Disposition是HTTP协议中的一个响应头字段,它主要用于指示如何处理响应的内容以及如何呈现给用户。这个字段是MIME协议类型的扩展,用于指导MIME用户代理(如浏览器)如何显示附加的文件。Content-Disposition的主要用途包括控制文件是直接在浏览器中打开,还是提示用户下载,并可以指定下载文件的默认名称。
二、Content-Disposition的定义与语法
Content-Disposition字段的语法如下
Content-Disposition: <disposition-type> [; <parameter-name>="<parameter-value>"]
<disposition-type>:表示处理方式,常见的值有"inline"和"attachment"。
"inline":表示内容应该尝试直接在浏览器中显示,这是默认值。
"attachment":表示内容应该作为附件下载,此时通常会附加一个filename参数来指定下载文件的默认名称。
<parameter-name>和<parameter-value>:用于进一步定义文件的处理细节,如文件名、字符编码等。
三、Content-Disposition的用途
3.1、文件下载
当服务器希望用户下载文件而不是在浏览器中直接打开时,可以在响应头中包含Content-Disposition: attachment; filename="文件名"。这样,浏览器会弹出一个下载对话框,让用户选择保存文件的位置和文件名(如果服务器指定了文件名,则作为默认文件名)。
这样在下载arraybuffer类型的文件时候就可以拿到文件名了。
// 获取文件名
let fileName = res.headers['content-disposition'].split('filename=')[1]
if (!fileName) {
fileName = res.headers['content-disposition'].split('UTF-8\'\'')[1]
}
fileName = fileName ? fileName.replace(/\"/g, '') : 'file.xlsx'
fileName = decodeURI(fileName) || ''
3.2、文件上传
虽然在文件上传的HTTP请求中不直接设置Content-Disposition响应头,但Content-Disposition在请求体中用于定义表单数据的格式。特别是当使用multipart/form-data
编码类型上传文件时,每个表单字段(包括文件)都会用Content-Disposition来标识其名称和(对于文件)文件名。
四、注意事项
当使用filename参数指定文件名时,如果文件名包含非ASCII字符(如中文),可能需要使用URL编码或filename*参数来确保兼容性。
在某些浏览器中,如果文件名包含空格或特殊字符,可能需要额外的处理来确保文件名在下载后正确显示。
Content-Disposition与Content-Type头字段通常一起使用,以提供关于响应内容的完整信息。
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="example.pdf"
...(PDF文件内容)...
在这个示例中,服务器响应了一个PDF文件,并通过Content-Disposition头字段指示浏览器将其作为附件下载,下载时的默认文件名为"example.pdf"。