Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(download): optimize file download handling #574

Merged
merged 1 commit into from
Mar 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions web/src/utils/download.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import request from '@/utils/http'
import type { AxiosResponse } from 'axios'

interface DownloadOptions {
url: string
method?: 'GET' | 'POST'
data?: any
fileName?: string
mimeType?: string
onProgress?: (progress: number) => void
}

declare global {
interface Navigator {
msSaveOrOpenBlob?: (blob: Blob, defaultName?: string) => boolean
}
}

interface DownloadResponse extends AxiosResponse {
fileName?: string
}

/**
* 文件下载工具函数
* @param options 下载配置项
*/
export async function downloadFile(options: DownloadOptions) {
const {
url,
method = 'GET',
data,
fileName,
mimeType,
onProgress,
} = options

const response = await request.http({
url,
method,
data,
responseType: 'blob',
onDownloadProgress: (progressEvent) => {
if (onProgress && progressEvent.total) {
const progress = Math.round((progressEvent.loaded * 100) / progressEvent.total)
onProgress(progress)
}
},
}) as DownloadResponse

const downloadFileName = fileName || response.fileName || '未命名文件'

// 创建 Blob
const blob = new Blob([response.data], {
type: mimeType || response.headers['content-type'],
})

if (window.navigator && window.navigator.msSaveOrOpenBlob) {
window.navigator.msSaveOrOpenBlob(blob, downloadFileName)
return
}

const downloadUrl = window.URL.createObjectURL(blob)
const link = document.createElement('a')
link.href = downloadUrl
link.download = downloadFileName
link.style.display = 'none'
document.body.appendChild(link)
link.click()
document.body.removeChild(link)
window.URL.revokeObjectURL(downloadUrl)
}
38 changes: 32 additions & 6 deletions web/src/utils/http.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,38 @@ http.interceptors.response.use(
const userStore = useUserStore()
await usePluginStore().callHooks('networkResponse', response)
const config = response.config
if ((response.request.responseType === 'blob'
|| response.request.responseType === 'arraybuffer')
&& !/^application\/json/.test(response.headers['content-type'])
&& response.status === ResultCode.SUCCESS
) {
return Promise.resolve(response.data)

if (response.request.responseType === 'blob' || response.request.responseType === 'arraybuffer') {
// 处理 JSON 格式的错误响应
if (response.data instanceof Blob && response.data.type === 'application/json') {
return new Promise((resolve, reject) => {
const reader = new FileReader()
reader.onload = () => {
const result = JSON.parse(reader.result as string)
if (result.code !== ResultCode.SUCCESS) {
Message.error(result.message || '下载失败', { zIndex: 9999 })
reject(result)
}
}
reader.readAsText(response.data)
})
}

// 正常的文件下载响应
const disposition = response.headers['content-disposition']
let fileName = '未命名文件'
if (disposition) {
const match = disposition.match(/filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/)
if (match && match[1]) {
fileName = decodeURIComponent(match[1].replace(/['"]/g, ''))
}
}

return Promise.resolve({
data: response.data,
fileName,
headers: response.headers,
})
}

if (response?.data?.code === ResultCode.SUCCESS) {
Expand Down