萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

jQuery AjaxFileUpload 附加參數傳遞:源碼修改與現代替代方案

經典 jquery.ajaxFileUpload.js 原版不支持附加表單字段。本文詳解修改源碼添加 data 參數的兩處關鍵點,並提供現代 FormData + fetch/axios 的零依賴替代方案。

原版調用方式 (無附加參數)

$.ajaxFileUpload({
  url: '/upload',
  fileElementId: 'fileInput',
  dataType: 'json',
  success: function(res) { ... }
});

修改源碼支持 data 參數

修改點 1:createUploadForm 函數 (約第 26 行)

// 原版簽名
createUploadForm: function(id, fileElementId) { ... }

// 修改為:接收 data 參數
createUploadForm: function(id, fileElementId, data) {
  // ... 原有創建 form、file input 邏輯 ...
  
  // 新增:處理附加數據,追加 hidden input
  if (data) {
    for (var key in data) {
      if (data.hasOwnProperty(key)) {
        $('')
          .appendTo(form);
      }
    }
  }
  return form;
}

修改點 2:ajaxFileUpload 主函數調用處

// 原版
var form = jQuery.createUploadForm(id, s.fileElementId);

// 修改:傳入 s.data
var form = jQuery.createUploadForm(id, s.fileElementId, s.data);

調用示例 (修改後)

$.ajaxFileUpload({
  url: '/upload',
  fileElementId: 'fileInput',
  data: {            // 新增:附加業務參數
    userId: 12345,
    category: 'avatar',
    token: 'xyz'
  },
  dataType: 'json',
  success: function(res) { console.log(res); }
});

原理深度解析

  1. ajaxFileUpload 內部動態創建 <form target="iframe" method="post" enctype="multipart/form-data">
  2. 將文件 <input type="file"> 移動到該 form
  3. 創建隱藏 <iframe> 作為 form 提交目標
  4. 提交 form,iframe 載入響應後解析 JSON
  5. 關鍵:附加參數只需在提交前追加 <input type="hidden"> 到 form

現代替代方案:FormData + Fetch (零依賴、原生、推薦)

async function uploadFile(fileInputId, extraData) {
  const fileInput = document.getElementById(fileInputId);
  const file = fileInput.files[0];
  if (!file) throw new Error('未選擇文件');
  
  const formData = new FormData();
  formData.append('file', file); // 文件字段名需與後端一致
  
  // 附加業務參數
  Object.entries(extraData || {}).forEach(([key, val]) => {
    formData.append(key, val);
  });
  
  try {
    const response = await fetch('/upload', {
      method: 'POST',
      body: formData,
      // 不設置 Content-Type!瀏覽器自動設置 multipart/form-data; boundary=...
      credentials: 'include' // 攜帶 Cookie
    });
    
    if (!response.ok) throw new Error('HTTP ' + response.status);
    return await response.json();
  } catch (err) {
    console.error('上傳失敗:', err);
    throw err;
  }
}

// 使用
uploadFile('fileInput', {userId: 12345, category: 'avatar'})
  .then(res => console.log('成功:', res))
  .catch(err => alert('上傳失敗: ' + err.message));

Axios 版本 (項目已用 Axios 時)

import axios from 'axios';

async function uploadWithAxios(file, extraData) {
  const formData = new FormData();
  formData.append('file', file);
  Object.entries(extraData).forEach(([k, v]) => formData.append(k, v));
  
  return axios.post('/upload', formData, {
    headers: {'Content-Type': 'multipart/form-data'}, // axios 會自動設置 boundary
    onUploadProgress: (e) => {
      const percent = Math.round((e.loaded * 100) / e.total);
      console.log('進度:', percent + '%');
    }
  });
}

大文件分片上傳進階 (斷點續傳雛形)

async function chunkedUpload(file, chunkSize = 2 * 1024 * 1024) {
  const totalChunks = Math.ceil(file.size / chunkSize);
  const fileHash = await calculateHash(file); // SparkMD5 等
  
  for (let i = 0; i < totalChunks; i++) {
    const start = i * chunkSize;
    const chunk = file.slice(start, start + chunkSize);
    
    const formData = new FormData();
    formData.append('chunk', chunk);
    formData.append('chunkIndex', i);
    formData.append('totalChunks', totalChunks);
    formData.append('fileHash', fileHash);
    formData.append('fileName', file.name);
    
    await fetch('/upload/chunk', {method: 'POST', body: formData});
    // 可在此更新進度條
  }
  
  // 通知後端合併
  return fetch('/upload/merge', {
    method: 'POST',
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify({fileHash, fileName: file.name})
  });
}

遷移建議

場景推薦方案
維護老項目、不想引入構建工具修改 ajaxFileUpload.js 源碼
新項目、現代瀏覽器環境FormData + Fetch (原生)
項目已用 Axios/Vue/ReactAxios + FormData
大文件、斷點續傳、秒傳分片上傳 + Web Worker 計算哈希
需要拖拽、預覽、壓縮圖片Uppy、FilePond、Dropzone 等成熟組件

理解 iframe 上傳原理,有助於在無現代 API 環境下快速實現文件上傳;但新項目請毫猶豫選擇 FormData + Fetch。

copyright © 萬盛學電腦網 all rights reserved