ASP.NET Core MVC 從入門到精通之文件上傳

来源:https://www.cnblogs.com/hsiang/archive/2023/05/10/17386616.html
-Advertisement-
Play Games

隨著技術的發展，ASP.NET Core MVC也推出了好長時間，經過不斷的版本更新迭代，已經越來越完善，本系列文章主要講解ASP.NET Core MVC開發B/S系統過程中所涉及到的相關內容，適用於初學者，在校畢業生，或其他想從事ASP.NET Core MVC 系統開發的人員。 經過前幾篇文章... ...


隨著技術的發展，ASP.NET Core MVC也推出了好長時間，經過不斷的版本更新迭代，已經越來越完善，本系列文章主要講解ASP.NET Core MVC開發B/S系統過程中所涉及到的相關內容，適用於初學者，在校畢業生，或其他想從事ASP.NET Core MVC 系統開發的人員。 經過前幾篇文章的講解，初步瞭解ASP.NET Core MVC項目創建，啟動運行，以及命名約定，創建控制器，視圖，模型，接收參數，傳遞數據ViewData，ViewBag，路由，頁面佈局，wwwroot和客戶端庫，Razor語法，EnityFrameworkCore與資料庫，HttpContext，Request，Response，Session，序列化等內容，今天繼續講解ASP.NET Core MVC 中文件上傳等相關內容，僅供學習分享使用。

 

概述

 

在實際應用開發中，文件上傳是非常常見的功能，文件上傳主要分為單文件上傳，多文件上傳，文件與其他內容混合上傳，大文件上傳幾種情況，本文會分別講解。

 

IFormFile

 

在ASP.NET Core MVC項目中，IFormFile表示使用 HttpRequest 發送的文件，可以用於文件流的接收。將整個文件讀入 IFormFile。 IFormFile 是用於處理或保存文件的文件的 C# 表示形式。

文件上傳使用的磁碟和記憶體取決於併發文件上傳的數量和大小。 如果應用嘗試緩衝過多上傳，站點就會在記憶體或磁碟空間不足時崩潰。 如果文件上傳的大小或頻率會消耗應用資源，請使用流式傳輸。

IFormFile的屬性和方法如下：

 對於小文件的上傳，一般採用IFormFile；大文件上傳，採用流式上傳，已實現可靠穩定傳輸。

IWebHostEnvironment 站點環境信息，用於獲取站點根目錄等內容。

 

單個文件上傳

 

單文件上傳功能主要分為兩部分：文件上傳視圖和後臺處理方法。

1. 文件上傳視圖

首先創建視圖，用於單個文件上傳。關於視圖有兩點說明，如下所示：

  1. 文件上傳通過form表單，採用post方式，加密類型為multipart/form-data
  2. 文件上傳採用input控制項，類型為file。

視圖代碼如下所示：

1 <form method="post" enctype="multipart/form-data" action="/File/OneFileUpload">
2     <h1>單文件上傳</h1>
3     <div>
4         <span>文件：</span>
5         <input type="file" name="file" />
6     </div>
7     <input type="submit" value="上傳" />
8 </form>

 

2. 後臺處理方法

form提交後臺處理方法OneFileUpload，關於處理方法有幾點說明，如下所示：

  1. 方法中的參數IFormFile  file用於接收客戶端上傳的文件，其他file和視圖中上傳控制項的name一一對應。如果錯誤，則無法上傳。
  2. _webHostEnvironment 為控制器通過介面註入的IWebHostEnvironment類型的獲取站點信息介面，主要用於獲取站點根目錄。
  3. 調用IFormFile的CopyTo方法進行保存，此方法接收Stream類型的參數。

上傳處理代碼，如下所示：

 1 /// <summary>
 2 /// 單文件上傳
 3 /// </summary>
 4 /// <returns></returns>
 5 public IActionResult OneFileUpload(IFormFile file)
 6 {
 7     var path = Path.Combine(_webHostEnvironment.ContentRootPath, "uploads", string.Format("{0}_{1}", DateTime.Now.Ticks, file.FileName));
 8     using (FileStream fs = new FileStream(path, FileMode.Create))
 9     {
10         file.CopyTo(fs);
11     }
12     return Ok("上傳成功");
13 }

 

多文件上傳

 

多文件上傳表示一次可以上傳多個文件。。上傳功能主要分為兩部分：文件上傳視圖和後臺處理方法。

 

1. 多文件上傳視圖

 

input控制項在類型為file時表示文件上傳，預設是單個文件上傳，通過設置multiple屬性，可實現多文件上傳。視圖代碼如下所示：

1 <form method="post" enctype="multipart/form-data" action="/File/MoreFileUpload">
2     <h1>多文件上傳</h1>
3     <div>
4         <span>文件：</span>
5         <input type="file" name="files" multiple />
6     </div>
7     <input type="submit" value="上傳" />
8 </form>

 

2. 多文件後臺處理方法

 

多個文件上傳，參數為IFormFile數組類型，可以接受上傳文件列表，然後迴圈獲取併進行保存即可。如下所示：

 1 /// <summary>
 2 /// 多文件上傳
 3 /// </summary>
 4 /// <returns></returns>
 5 public IActionResult MoreFileUpload(IFormFile[] files)
 6 {
 7     foreach (var file in files)
 8     {
 9         var path = Path.Combine(_webHostEnvironment.ContentRootPath, "uploads", string.Format("{0}_{1}", DateTime.Now.Ticks, file.FileName));
10         using (FileStream fs = new FileStream(path, FileMode.Create))
11         {
12             file.CopyTo(fs);
13         }
14     }
15 
16     return Ok("上傳成功");
17 }

 

文件文本混合上傳

 

在實際應用中，文件上傳只是一部分，還需要搭配其他的文本說明，如錄入產品信息，並上傳附件等。

 

1. 創建模型

 

在Product中，包含兩個屬性，一個字元串類型的Name，用於綁定名稱，一個IFormFile類型的File，用於上傳文件。如下所示：

1 namespace DemoCoreMVC.Models
2 {
3     public class Product
4     {
5         public string Name { get; set; }
6 
7         public IFormFile File { get; set; }
8     }
9 }

 

2. 視圖綁定模型

 

在視圖最頂部，為視圖指定模型，如下所示：

1 @model DemoCoreMVC.Models.Product

 

3. 混合文本文件上傳視圖

 

在form表單中，除了文件上傳控制項，還有一個文件框，用於輸入名稱。其中控制項name和模型相對應。如下所示：

 1 <form method="post" enctype="multipart/form-data" action="/File/FileWithContentUpload">
 2     <h1>文件，文本混合上傳</h1>
 3     <div>
 4         <span>名稱：</span>
 5         <input type="text" name="Name"  />
 6     </div>
 7     <div>
 8         <span>文件：</span>
 9         <input type="file" name="File" />
10     </div>
11     <input type="submit" value="上傳" />
12 </form>

 

4. 後臺處理方法

 

文件文本混合上傳，參數為模型Product，通過屬性匹配接收參數，然後獲取屬性File對應的記憶體流進行保存即可。如下所示：

 1 /// <summary>
 2 /// 文件內容混合上傳
 3 /// </summary>
 4 /// <returns></returns>
 5 public IActionResult FileWithContentUpload(Product product)
 6 {
 7     var file = product.File;
 8     var path = Path.Combine(_webHostEnvironment.ContentRootPath, "uploads", string.Format("{0}_{1}", DateTime.Now.Ticks, file.FileName));
 9     using (FileStream fs = new FileStream(path, FileMode.Create))
10     {
11         file.CopyTo(fs);
12     }
13     return Ok($"{product.Name} 上傳成功");
14 }

 

大文件上傳

 

首先如何界定大文件/小文件，並沒有統一的標準。根據官網相關參數說明：

  1. 預設情況下， HttpRequest.Form 不會緩衝整個請求正文 (BufferBody) ，但會緩衝包含的任何多部分表單文件。
  2. MultipartBodyLengthLimit 是緩衝表單文件的最大大小，預設值為 128MB。
  3. MemoryBufferThreshold 指示在轉換為磁碟上的緩衝區文件之前，記憶體中的文件緩衝量，預設為 64KB。
  4. MemoryBufferThreshold 充當小型和大型文件之間的邊界，這些文件根據應用資源和方案而引發或降低。

大文件上傳採用流式傳輸，可降低上傳文件時對記憶體或磁碟空間的需求。

 

1. 創建視圖

 

大文件和小文件上傳在視圖上並無差別，只是後臺處理方法不同，如下所示：

1 <form method="post" enctype="multipart/form-data" action="/File/BigFileUpload">
2     <h1>大文件上傳</h1>
3     <div>
4         <span>文件：</span>
5         <input type="file" name="file" />
6     </div>
7     <input type="submit" value="上傳" />
8 </form>

 

2. 後臺處理方法

 

首先創建大文件上傳幫助類MultipartRequestHelper，如下所示：

 1 using System;
 2 using System.IO;
 3 using Microsoft.Net.Http.Headers;
 4 namespace DemoCoreMVC
 5 {
 6     public static class MultipartRequestHelper
 7     {
 8         // Content-Type: multipart/form-data; boundary="----WebKitFormBoundarymx2fSWqWSd0OxQqq"
 9         public static string GetBoundary(MediaTypeHeaderValue contentType, int lengthLimit)
10         {
11             var boundary = HeaderUtilities.RemoveQuotes(contentType.Boundary).Value;
12 
13             if (string.IsNullOrWhiteSpace(boundary))
14             {
15                 throw new InvalidDataException("Missing content-type boundary.");
16             }
17 
18             if (boundary.Length > lengthLimit)
19             {
20                 throw new InvalidDataException(
21                     $"Multipart boundary length limit {lengthLimit} exceeded.");
22             }
23 
24             return boundary;
25         }
26 
27         public static bool IsMultipartContentType(string contentType)
28         {
29             return !string.IsNullOrEmpty(contentType)
30                    && contentType.IndexOf("multipart/", StringComparison.OrdinalIgnoreCase) >= 0;
31         }
32 
33         public static bool HasFileContentDisposition(ContentDispositionHeaderValue contentDisposition)
34         {
35             // Content-Disposition: form-data; name="myfile1"; filename="Misc 002.jpg"
36             return contentDisposition != null
37                 && contentDisposition.DispositionType.Equals("form-data")
38                 && (!string.IsNullOrEmpty(contentDisposition.FileName.Value)
39                     || !string.IsNullOrEmpty(contentDisposition.FileNameStar.Value));
40         }
41 
42         // 如果一個section的Header是： Content-Disposition: form-data; name="myfile1"; filename="F:\Misc 002.jpg"
43         // 那麼本方法返回： Misc 002.jpg
44         public static string GetFileName(ContentDispositionHeaderValue contentDisposition)
45         {
46             return Path.GetFileName(contentDisposition.FileName.Value);
47         }
48 
49     }
50 }

處理方法BigFileUploadAsync，關於Action說明，如下所示：

Action中要進行DisableRequestSizeLimit特性說明，否則會有大小限制【InvalidDataException: Multipart body length limit 16384 exceeded】。

在該操作中，使用 MultipartReader 讀取窗體的內容，它會讀取每個單獨的 MultipartSection，從而根據需要處理文件或存儲內容。 讀取多部分節後，該操作會執行自己的模型綁定。

 1 /// <summary>
 2 /// 大文件上傳
 3 /// </summary>
 4 /// <returns></returns>
 5 [DisableRequestSizeLimit]
 6 public async Task<IActionResult> BigFileUploadAsync()
 7 {
 8     var contentType = Request.ContentType;
 9     if (!MultipartRequestHelper.IsMultipartContentType(contentType))
10     {
11         ModelState.AddModelError("File",
12             $"上傳文件類型不對.");
13         return BadRequest(ModelState);
14     }
15     var path = Path.Combine(_webHostEnvironment.ContentRootPath, "uploads");
16 
17     var boundary = MultipartRequestHelper.GetBoundary(MediaTypeHeaderValue.Parse(Request.ContentType), _defaultFormOptions.MultipartBoundaryLengthLimit);
18 
19     var reader = new MultipartReader(boundary, HttpContext.Request.Body);
20 
21     var section = await reader.ReadNextSectionAsync();
22 
23     while (section != null)
24     {
25         var hasContentDispositionHeader =
26             ContentDispositionHeaderValue.TryParse(
27                 section.ContentDisposition, out var contentDisposition);
28 
29         if (hasContentDispositionHeader)
30         {
31             if (!MultipartRequestHelper.HasFileContentDisposition(contentDisposition))
32             {
33                 ModelState.AddModelError("File",
34                     $"The request couldn't be processed (Error 2).");
35 
36                 return BadRequest(ModelState);
37             }
38             else
39             {
40                 var fileName = MultipartRequestHelper.GetFileName(contentDisposition);
41                 var loadBufferBytes = 1024;//這個是每一次從Http請求的section中讀出文件數據的大小，單位是Byte即位元組，這裡設置為1024的意思是，每次從Http請求的section數據流中讀取出1024位元組的數據到伺服器記憶體中，然後寫入下麵targetFileStream的文件流中，可以根據伺服器的記憶體大小調整這個值。這樣就避免了一次載入所有上傳文件的數據到伺服器記憶體中，導致伺服器崩潰。
42 
43                 using (var targetFileStream = new FileStream(path + "\\" + string.Format("{0}_{1}", DateTime.Now.Ticks, fileName), FileMode.Create, FileAccess.ReadWrite))
44                 {
45                     using (section.Body)
46                     {
47                         //section.Body是System.IO.Stream類型，表示的是Http請求中一個section的數據流，從該數據流中可以讀出每一個section的全部數據，所以我們下麵也可以不用section.Body.CopyToAsync方法，而是在一個迴圈中用section.Body.Read方法自己讀出數據（如果section.Body.Read方法返回0，表示數據流已經到末尾，數據已經全部都讀取完了），再將數據寫入到targetFileStream
48                         await section.Body.CopyToAsync(targetFileStream, loadBufferBytes);
49                     }
50                 }
51             }
52         }
53         section = await reader.ReadNextSectionAsync();
54     }
55     return Ok("上傳成功");
56 }

註意：在文件上傳功能中，上傳後的文件一般都要進行重命名的，否則如何客戶端上傳相同名稱的文件，則可能會被覆蓋。在本例中，在原文件前面加上了時間戳，以減少重覆的概率。

 

文件上傳校驗

 

在實際開發中，為了避免客戶端上傳不滿足條件的文件，一般都會進行校驗。

  1. 文件擴展名驗證：應在允許的擴展名列表中查找上傳的文件的擴展名。
  2. 文件簽名驗證：文件的簽名由文件開頭部分中的前幾個位元組確定。 可以使用這些位元組指示擴展名是否與文件內容匹配。 示例應用檢查一些常見文件類型的文件簽名。
  3. 文件名安全：切勿使用客戶端提供的文件名來將文件保存到物理存儲。
  4. 文件大小驗證：限制上傳的文件的大小。

 

文件上傳安全

 

為避免文件上傳功能造成攻擊可能性，常規安全措施如下：

  1. 將文件上傳到專用文件上傳區域，最好是非系統驅動器。 使用專用位置便於對上傳的文件實施安全限制。 禁用對文件上傳位置的執行許可權。
  2. 請勿將上傳的文件保存在與應用相同的目錄樹中。
  3. 使用應用確定的安全的文件名。 請勿使用用戶提供的文件名或上傳的文件的不受信任的文件名。† 當顯示不受信任的文件名時 HTML 會對它進行編碼。 例如，記錄文件名或在 UI 中顯示（Razor 自動對輸出進行 HTML 編碼）。
  4. 按照應用的設計規範，僅允許已批准的文件擴展名。
  5. 驗證是否對伺服器執行客戶端檢查。† 客戶端檢查易於規避。
  6. 檢查已上傳文件的大小。 設置一個大小上限以防止上傳大型文件。
  7. 文件不應該被具有相同名稱的上傳文件覆蓋時，先在資料庫或物理存儲上檢查文件名，然後再上傳文件。
  8. 先對上傳的內容運行病毒/惡意軟體掃描程式，然後再存儲文件。

參考文章

本篇文章主要參考內容如下：

1. 官方文檔：https://learn.microsoft.com/zh-cn/aspnet/core/mvc/models/file-uploads?view=aspnetcore-6.0

 

以上就是ASP.NET Core MVC從入門到精通之文件上傳的全部內容。


作者：小六公子
出處：http://www.cnblogs.com/hsiang/
本文版權歸作者和博客園共有，寫文不易，支持原創，歡迎轉載【點贊】，轉載請保留此段聲明，且在文章頁面明顯位置給出原文連接，謝謝。
關註個人公眾號，定時同步更新技術及職場文章


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 34基於Java的學生選課系統或學生課程管理系統
    基於java的學生課程管理系統，基於java的學生選課系統，javaWeb的學生選課系統，學生成績管理系統，課表管理系統，學院管理系統，大學生選課系統設計與實現，網上選課系統,課程成績打分。 ...
  • Python中的交互庫-os庫
    本文設計並實現了一種專用於路徑路由匹配的規則，以一種簡單而通用的方式描述一組路徑的特征，來簡化這種場景路由描述難度，讓小白可以快速學習並上手。 ...
  • 【pandas基礎】--數據檢索
    pandas的數據檢索功能是其最基礎也是最重要的功能之一。 pandas中最常用的幾種數據過濾方式如下： 行列過濾：選取指定的行或者列 條件過濾：對列的數據設置過濾條件 函數過濾：通過函數設置更加複雜的過濾條件 本篇所有示例所使用的測試數據如下： import pandas as pd import ...
  • 萬字長文詳解如何使用Swift提高代碼質量
    京喜APP最早在2019年引入了Swift，使用Swift完成了第一個訂單模塊的開發。之後一年多我們持續在團隊/公司內部推廣和普及Swift，目前Swift已經支撐了70%+以上的業務。通過使用Swift提高了團隊內同學的開發效率，同時也帶來了質量的提升，目前來自Swift的Crash的占比不到1%... ...
  • SpringBoot定義優雅全局統一Restful API 響應框架四
    好代碼是優化出來的，不是寫出來的！！ 如果沒看前面文章，可以先看前面幾篇 SpringBoot定義優雅全局統一Restful API 響應框架 ...
  • 高效c語言1快速入門
    對象存儲是雲的基礎組件之一，各大雲廠商都有相關產品。這裡跟大家介紹一下rust與對象存儲交到的基本套路和其中的一些技巧。 ...
  • Java的抽象類 & 介面
    抽象類：在子類繼承父類時，父類的一些方法實現是不明確的（父類對子類的實現一無所知）。這時需要使父類是抽象類，在子類中提供方法的實現。 介面（interface）技術主要用來描述類具有什麼功能，而並不給出每個功能的具體實現。 ...
  • 【11個適合畢設的Python可視化大屏】用pyecharts開發拖拽式可視化數據大屏
    你好，我是@馬哥python說，一枚10年程式猿。 一、效果演示 以下是我近期用Python開發的原創可視化數據分析大屏，非常適合畢設用，下麵逐一展示：（以下是截圖，實際上有動態交互效果哦） 以下大屏均為@馬哥python說的個人原創，請勿轉載。 1.1 影視劇分析大屏 1.2 豆瓣電影分析大屏A ...
一周排行
    -Advertisement-
    Play Games
  • 如何基於surging跨網關跨語言進行緩存降級
    基於.NET Framework 4.8 開發的深度學習模型部署測試平臺，提供了YOLO框架的主流系列模型，包括YOLOv8~v9，以及其系列下的Det、Seg、Pose、Obb、Cls等應用場景，同時支持圖像與視頻檢測。模型部署引擎使用的是OpenVINO™、TensorRT、ONNX runti... ...
  • 十年沉澱，重啟開發之路
    十年沉澱，重啟開發之路 十年前，我沉浸在開發的海洋中，每日與代碼為伍，與演算法共舞。那時的我，滿懷激情，對技術的追求近乎狂熱。然而，隨著歲月的流逝，生活的忙碌逐漸占據了我的大部分時間，讓我無暇顧及技術的沉澱與積累。 十年間，我經歷了職業生涯的起伏和變遷。從初出茅廬的菜鳥到逐漸嶄露頭角的開發者，我見證了 ...
  • C#.NET體系圖文概述—2024最全總結
    C# 是一種簡單、現代、面向對象和類型安全的編程語言。.NET 是由 Microsoft 創建的開發平臺，平臺包含了語言規範、工具、運行，支持開發各種應用，如Web、移動、桌面等。.NET框架有多個實現，如.NET Framework、.NET Core（及後續的.NET 5+版本），以及社區版本M... ...
  • 班級擂臺（光榮）榜 - 極簡教育小工具
    前言 本文介紹瞭如何使用三菱提供的MX Component插件實現對三菱PLC軟元件數據的讀寫，記錄了使用電腦模擬，模擬PLC，直至完成測試的詳細流程，並重點介紹了在這個過程中的易錯點，供參考。 用到的軟體： 1. PLC開發編程環境GX Works2，GX Works2下載鏈接 https:// ...
  • web server apache tomcat11-31-websocket
    前言 整理這個官方翻譯的系列，原因是網上大部分的 tomcat 版本比較舊，此版本為 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎，輕嗅薔薇。 系列文章 web server apache tomcat11-01-官方文檔入門介紹 web serv ...
  • day31-jQuery
    1、jQuery介紹 jQuery是什麼 jQuery是一個快速、簡潔的JavaScript框架，是繼Prototype之後又一個優秀的JavaScript代碼庫（或JavaScript框架）。jQuery設計的宗旨是“write Less，Do More”，即倡導寫更少的代碼，做更多的事情。它封裝 ...
  • aardio爬蟲) 實戰篇：逆向有道翻譯web介面
    前言 之前的文章把js引擎(aardio封裝庫) 微軟開源的js引擎(ChakraCore))寫好了，這篇文章整點js代碼來測一下bug。測試網站：https://fanyi.youdao.com/index.html#/ 逆向思路 逆向思路可以看有道翻譯js逆向（MD5加密，AES加密）附完整源碼 ...
  • 面試官：這就是你理解的Java多線程基礎？
    引言 現代的操作系統（Windows，Linux，Mac OS）等都可以同時打開多個軟體（任務），這些軟體在我們的感知上是同時運行的，例如我們可以一邊瀏覽網頁，一邊聽音樂。而CPU執行代碼同一時間只能執行一條，但即使我們的電腦是單核CPU也可以同時運行多個任務，如下圖所示，這是因為我們的 CPU 的 ...
  • Python文本統計與分析從基礎到進階
    掌握使用Python進行文本英文統計的基本方法，並瞭解如何進一步優化和擴展這些方法，以應對更複雜的文本分析任務。 ...
  • Redis多數據源，看這篇就夠了
    背景 Redis多數據源常見的場景： 分區數據處理：當數據量增長時，單個Redis實例可能無法處理所有的數據。通過使用多個Redis數據源，可以將數據分區存儲在不同的實例中，使得數據處理更加高效。 多租戶應用程式：對於多租戶應用程式，每個租戶可以擁有自己的Redis數據源，以確保數據隔離和安全性。 ...
所有分類