如何在.NET Core中利用 Web APi對文件進行分片上傳

本篇文章為大家展示了如何在.NET Core中利用 Web APi對文件進行分片上傳，內容簡明扼要并且容易理解，絕對能使你眼前一亮，通過這篇文章的詳細介紹希望你能有所收獲。

.NET Core Web APi文件分片上傳

這里我們依然是使用FormData來上傳，只不過在上傳之前對文件進行分片處理，如下HTML代碼

<div class="form-horizontal" >
  <div class="form-group">
    <div class="col-md-10">
      <input name="file" id="file" type="file" />
    </div>
  </div>
  <div class="form-group">
    <div class="col-md-offset-2 col-md-10">
      <input type="submit" id="submit" value="上傳" class="btn btn-success" />
    </div>
  </div>
</div>

接下來則是上傳腳本，如下：

$(function () {
  $('#submit').click(function () {
    UploadFile($('#file')[0].files);
  });
});

簡單來說只需實現上述UploadFile方法，對大文件進行分片處理，然后上傳就完事，文件上傳后大致如下圖所示，最后只需將所有文件進行合并處理為目標文件即可

接下來我們詳細講講如何實現，當然重點就在于如何進行分片處理，我們拿到上傳目標文件，然后通過slice方法進行分片，在分片處理之前我們定義緩沖區大?。J為8兆），然后循環遍歷文件大小，然后將分片數據塞入分片數組，最后利用循環或者隊列先進先出機制獲取數組分片元素上傳。

function UploadFile(targetFile) {
    // 創建上傳文件分片緩沖區
    var fileChunks = [];
    // 目標文件
    var file = targetFile[0];
    // 設置分片緩沖區大小
    var maxFileSizeMB = 8;
    var bufferChunkSize = maxFileSizeMB * (1024 * 1024);
    // 讀取文件流起始位置
    var fileStreamPos = 0;
    // 設置下一次讀取緩沖區初始大小
    var endPos = bufferChunkSize;
    // 文件大小
    var size = file.size;
    // 將文件進行循環分片處理塞入分片數組
    while (fileStreamPos < size) {
      var fileChunkInfo = {
        file: file.slice(fileStreamPos, endPos),
        start: fileStreamPos,
        end: endPos
      }
      fileChunks.push(fileChunkInfo);
      fileStreamPos = endPos;
      endPos = fileStreamPos + bufferChunkSize;
    }
    // 獲取上傳文件分片總數量
    var totalParts = fileChunks.length;
    var partCount = 0;
    // 循環調用上傳每一片
    while (chunk = fileChunks.shift()) {
      partCount++;
      // 上傳文件命名約定
      var filePartName = file.name + ".partNumber-" + partCount;
      chunk.filePartName = filePartName;
      // url參數
      var url = 'partNumber=' + partCount + '&chunks=' + totalParts + '&size=' + bufferChunkSize + '&start=' + chunk.start + '&end=' + chunk.end + '&total=' + size;
      chunk.urlParameter = url;
      // 上傳文件
      UploadFileChunk(chunk);
    }
}

上述關于分片塞入數組就不用再廢話，這里我們將每一片文件命名先進行一個約定（文件名+“.partNumber” + 分片號），以便所有分片上傳完成后獲取按照文件名中的分片號對其進行排序合并，這也就是合并文件的依據。接下來就是上傳每一片文件

function UploadFileChunk(chunk) {
  var data = new FormData();
  data.append("file", chunk.file, chunk.filePartName);
  $.ajax({
    url: '/api/upload/upload?' + chunk.urlParameter,
    type: "post",
    cache: false,
    contentType: false,
    processData: false,
    data: data,
  });
}

我們可以看到在URL上額外加了其他參數，為什么要加上這些參數呢？主要為解決幾個問題，其一：前端確認緩沖區大小，我們獲取前端確認的緩沖區大小，這樣后臺不用寫死，更加靈活，萬一后續進行了修改，誰知道呢？其二：我們怎么確定文件是否已經全部上傳完了呢？在URL上我們添加分片總數和文件實際大小來完全確定文件已經全部上傳和文件完整無缺。當然也額外添加了每一片讀取的起始位置和結束位置，若有所需也可以利用。多余的就不用我再解釋。接下來我們看看后臺如何對每一片進行處理呢？在.NET Core中實際上提供了對應APi來專門讀取FormData數據，利用Microsoft.AspNetCore.WebUtilities命名空間下的MultipartReader類。

首先我們判斷是否請求內容是否為FormData，同時通過上下文獲取上述文件讀取類的參數boundary，如下：

private bool IsMultipartContentType(string contentType)
{
  return
    !string.IsNullOrEmpty(contentType) &&
    contentType.IndexOf("multipart/", StringComparison.OrdinalIgnoreCase) >= 0;
}

private string GetBoundary(string contentType)
{
  var elements = contentType.Split(' ');
  var element = elements.Where(entry => entry.StartsWith("boundary=")).First();
  var boundary = element.Substring("boundary=".Length);
  if (boundary.Length >= 2 && boundary[0] == '"' &&
    boundary[boundary.Length - 1] == '"')
  {
    boundary = boundary.Substring(1, boundary.Length - 2);
  }
  return boundary;
}

private string GetFileName(string contentDisposition)
{
  return contentDisposition
    .Split(';')
    .SingleOrDefault(part => part.Contains("filename"))
    .Split('=')
    .Last()
    .Trim('"');
}

接下來我們定義分片類而獲取URL上每一片的參數，如下：

public class FileChunk
  {
    //文件名
    public string FileName { get; set; }
    /// <summary>
    /// 當前分片
    /// </summary>
    public int PartNumber { get; set; }
    /// <summary>
    /// 緩沖區大小
    /// </summary>
    public int Size { get; set; }
    /// <summary>
    /// 分片總數
    /// </summary>
    public int Chunks { get; set; }
    /// <summary>
    /// 文件讀取起始位置
    /// </summary>
    public int Start { get; set; }
    /// <summary>
    /// 文件讀取結束位置
    /// </summary>
    public int End { get; set; }
    /// <summary>
    /// 文件大小
    /// </summary>
    public int Total { get; set; }
  }

接下來在提交控制器方法上去讀取每一片數據如下

if (!IsMultipartContentType(context.Request.ContentType))
{
  return BadRequest();
}

var boundary = GetBoundary(context.Request.ContentType);
if (string.IsNullOrEmpty(boundary))
{
  return BadRequest();
}

var reader = new MultipartReader(boundary, context.Request.Body);

var section = await reader.ReadNextSectionAsync();

然后就是循環每一片（section），若不為空說明還存有分片文件，然后讀取URL上的緩沖區大小，如下：

while (section != null)
{
  //chunk為控制器方法上類FileChunk參數
  var buffer = new byte[chunk.Size];
  var fileName = GetFileName(section.ContentDisposition);
  //這里獲取文件名便于查找指定文件夾下所有文件
  chunk.FileName = fileName;
  var path = Path.Combine(_environment.WebRootPath, DEFAULT_FOLDER, fileName);
  using (var stream = new FileStream(path, FileMode.Append))
  {
    int bytesRead;
    do
    {
      bytesRead = await section.Body.ReadAsync(buffer, 0, buffer.Length);
      stream.Write(buffer, 0, bytesRead);

    } while (bytesRead > 0);
  }

  section = await reader.ReadNextSectionAsync();
}

在利用內置APi讀取FormData數據時，在.NET Core 3.x會拋出如下異常：

大致原因出在.NET Core內置提供了對于參數的綁定和此方法讀取貌似有點沖突導致，我們實現如下特性移除對應綁定，然后將其添加到文件上傳方法上即可

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public sealed class DisableFormValueModelBindingAttribute : Attribute, IResourceFilter
{
  public void OnResourceExecuting(ResourceExecutingContext context)
  {
    var factories = context.ValueProviderFactories;
    factories.RemoveType<FormValueProviderFactory>();
    factories.RemoveType<FormFileValueProviderFactory>();
    factories.RemoveType<JQueryFormValueProviderFactory>();
  }

  public void OnResourceExecuted(ResourceExecutedContext context)
  {
  }
}

所有分片文件上傳完成后則是合并文件，合并的依據則是判斷URL上當前分片數和分片總數是否相等，如下：

//計算上傳文件大小實時反饋進度（TODO)

//合并文件（可能涉及轉碼等）
if (chunk.PartNumber == chunk.Chunks)
{
  await MergeChunkFile(chunk);
}

既然是合并文件那就需要通過分片文件名稱上末尾的分片號進行排序和拿到每一個分片文件路徑以便合并后刪除所有分片文件，所以我們定義如下類

public class FileSort
{
  public const string PART_NUMBER = ".partNumber-";
  /// <summary>
  /// 文件名
  /// </summary>
  public string FileName { get; set; }
  /// <summary>
  /// 文件分片號
  /// </summary>
  public int PartNumber { get; set; }
}

最終合并文件方法，如下：

public async Task MergeChunkFile(FileChunk chunk)
{
  //文件上傳目錄名
  var uploadDirectoryName = Path.Combine(_environment.WebRootPath, DEFAULT_FOLDER, chunk.FileName);

  //分片文件命名約定
  var partToken = FileSort.PART_NUMBER;

  //上傳文件實際名稱
  var baseFileName = chunk.FileName.Substring(0, chunk.FileName.IndexOf(partToken));

  //根據命名約定查詢指定目錄下符合條件的所有分片文件
  var searchpattern = $"{Path.GetFileName(baseFileName)}{partToken}*";

  //獲取所有分片文件列表
  var filesList = Directory.GetFiles(Path.GetDirectoryName(uploadDirectoryName), searchpattern);
  if (!filesList.Any()) { return; }

  var mergeFiles = new List<FileSort>();
  foreach (string file in filesList)
  {    var sort = new FileSort
    {
      FileName = file
    };

    baseFileName = file.Substring(0, file.IndexOf(partToken));

    var fileIndex = file.Substring(file.IndexOf(partToken) + partToken.Length);

    int.TryParse(fileIndex, out var number);
    if (number <= 0) { continue; }

    sort.PartNumber = number;

    mergeFiles.Add(sort);
  }  // 按照分片排序
  var mergeOrders = mergeFiles.OrderBy(s => s.PartNumber).ToList();

  // 合并文件
  using var fileStream = new FileStream(baseFileName, FileMode.Create);
  foreach (var fileSort in mergeOrders)
  {
    using FileStream fileChunk =
       new FileStream(fileSort.FileName, FileMode.Open);
    await fileChunk.CopyToAsync(fileStream);
  }

  //刪除分片文件
  DeleteFile(mergeFiles);

}

public void DeleteFile(List<FileSort> files)
{
  foreach (var file in files)
  {
    System.IO.File.Delete(file.FileName);
  }
}

上述內容就是如何在.NET Core中利用 Web APi對文件進行分片上傳，你們學到知識或技能了嗎？如果還想學到更多技能或者豐富自己的知識儲備，歡迎關注億速云行業資訊頻道。