ASP.NET 開源導入導出庫Magicodes.IE 完成Excel圖片導入導出
- 2020 年 3 月 18 日
- 筆記
Magicodes.IE Excel圖片導入導出
為了更好的根據實際功能來迭代，從2.2的里程碑規劃開始，我們將結合社區的建議和意見來進行迭代，您可以點此鏈接來提交您的意見和建議：
https://github.com/dotnetcore/Magicodes.IE/issues/46
說明
本章教程主要說明如何使用Magicodes.IE.Excel進行圖片的導入導出。
要點
- 配置DTO進行Excel圖片導出
- 配置DTO進行Excel圖片導入
圖片導入導出特性說明
ExportImageFieldAttribute
- Height： 高度(默認15)
- Width：寬度(默認50)
- Alt：圖片不存在時替換文本
ImportImageFieldAttribute
- ImageDirectory： 圖片存儲路徑（默認存儲到臨時目錄）
- ImportImageTo：圖片導出方式（默認Base64），支援的方式如下所示：
/// <summary> /// 圖片導入類型 /// </summary> public enum ImportImageTo { /// <summary> /// 導入到臨時目錄 /// </summary> TempFolder, /// <summary> /// 導入為base64格式 /// </summary> Base64 }主要步驟
1.安裝包Magicodes.IE.Excel
Install-Package Magicodes.IE.Excel2.使用Magicodes.IE.Excel導出圖片到Excel
如下述示例程式碼所示，我們需要在圖片屬性上添加ExportImageFieldAttribute特性，使用特性的「Width」屬性指定圖片寬度，「Height」屬性指定圖片高度，「Alt」屬性指定替換文本，也就是當圖片不存在時則會顯示此文本：
[ExcelExporter(Name = "測試")] public class ExportTestDataWithPicture { [ExporterHeader(DisplayName = "加粗文本", IsBold = true)] public string Text { get; set; } [ExporterHeader(DisplayName = "普通文本")] public string Text2 { get; set; } [ExporterHeader(DisplayName = "忽略", IsIgnore = true)] public string Text3 { get; set; } [ExportImageField(Width = 20, Height = 120)] [ExporterHeader(DisplayName = "圖1")] public string Img1 { get; set; } [ExporterHeader(DisplayName = "數值", Format = "#,##0")] public decimal Number { get; set; } [ExporterHeader(DisplayName = "名稱", IsAutoFit = true)] public string Name { get; set; } /// <summary> /// 時間測試 /// </summary> [ExporterHeader(DisplayName = "日期1", Format = "yyyy-MM-dd")] public DateTime Time1 { get; set; } [ExportImageField(Width = 50, Height = 120, Alt = "404")] [ExporterHeader(DisplayName = "圖", IsAutoFit = false)] public string Img { get; set; } }值得注意的是：
- ExportImageFieldAttribute特性是必須的
- 圖片屬性類型必須為string類型，支援本地圖片和遠程圖片地址
接下來，我們就可以使用API來執行導出了。其實除了Dto的不同，導出API還是一個，如下述程式碼所示：
public async Task ExportPicture_Test() { IExporter exporter = new ExcelExporter(); var url = Path.Combine("TestFiles", "ExporterTest.png"); for (var i = 0; i < data.Count; i++) { var item = data[i]; item.Img1 = url; if (i == 4) item.Img = null; else item.Img = "https://docs.microsoft.com/en-us/media/microsoft-logo-dark.png"; } var result = await exporter.Export(filePath, data); }如上述程式碼所示，目前圖片導出可以設置為遠程圖片地址，以及本地圖片地址，並且也可以設置為null（null將會被替代文本所代替）。效果如下圖：
3.使用Magicodes.IE.Excel導入圖片
Magicodes.IE.Excel支援從Excel導入圖片，僅需使用特性「ImportImageField」。其支援兩種導入方式：
- 導入到臨時目錄
- 導入為Base64
僅需設置ImportImageTo屬性。
ImportImageTo枚舉
Base64 導入為base64格式
TempFolder 導入到臨時目錄
值得注意的是，同上文一樣，圖片屬性欄位類型也僅支援string類型。
準備待導入的包含圖片的Excel
在開始之前，我們需準備好導入的Excel，本示例中的模板如下圖所示：
導入到臨時目錄
Dto模型如下所示：
public class ImportPictureDto { [ImporterHeader(Name = "加粗文本")] public string Text { get; set; } [ImporterHeader(Name = "普通文本")] public string Text2 { get; set; } /// <summary> /// 將圖片寫入到臨時目錄 /// </summary> [ImportImageField(ImportImageTo = ImportImageTo.TempFolder)] [ImporterHeader(Name = "圖1")] public string Img1 { get; set; } [ImporterHeader(Name = "數值")] public string Number { get; set; } [ImporterHeader(Name = "名稱")] public string Name { get; set; } [ImporterHeader(Name = "日期")] public DateTime Time { get; set; } /// <summary> /// 將圖片寫入到臨時目錄 /// </summary> [ImportImageField(ImportImageTo = ImportImageTo.TempFolder)] [ImporterHeader(Name = "圖")] public string Img { get; set; } } 導入還是那個導入，只是Dto設置變了：
public async Task ImportPicture_Test() { var filePath = Path.Combine(Directory.GetCurrentDirectory(), "TestFiles", "Import", "圖片導入模板.xlsx"); var import = await Importer.Import<ImportPictureDto>(filePath); if (import.Exception != null) _testOutputHelper.WriteLine(import.Exception.ToString()); if (import.RowErrors.Count > 0) _testOutputHelper.WriteLine(JsonConvert.SerializeObject(import.RowErrors)); } 如下圖所示，Excel中的圖片就會導入到臨時目錄。值得注意的是：
- 圖片導入到臨時目錄之後，如果導入結果符合業務需要，請立即將圖片移動到正式存儲位置，比如網站目錄、雲存儲等；
- 圖片導入也支援指定位置，不過不推薦。
將圖片導入為base64
將圖片導入為base64僅需設置「ImportImageTo」屬性值為「ImportImageTo.Base64」即可：
public class ImportPictureBase64Dto { [ImporterHeader(Name = "加粗文本")] public string Text { get; set; } [ImporterHeader(Name = "普通文本")] public string Text2 { get; set; } /// <summary> /// 將圖片導入為base64（默認為base64） /// </summary> [ImportImageField(ImportImageTo = ImportImageTo.Base64)] [ImporterHeader(Name = "圖1")] public string Img1 { get; set; } [ImporterHeader(Name = "數值")] public string Number { get; set; } [ImporterHeader(Name = "名稱")] public string Name { get; set; } [ImporterHeader(Name = "日期")] public DateTime Time { get; set; } /// <summary> /// 將圖片導入到臨時目錄 /// </summary> [ImportImageField(ImportImageTo = ImportImageTo.TempFolder)] [ImporterHeader(Name = "圖")] public string Img { get; set; } } 導入程式碼同上：
public async Task ImportPictureBase64_Test() { var filePath = Path.Combine(Directory.GetCurrentDirectory(), "TestFiles", "Import", "圖片導入模板.xlsx"); var import = await Importer.Import<ImportPictureBase64Dto>(filePath); } 如下圖所示，我們就很方便的得到了圖片的base64編碼的結果：
Reference
https://github.com/dotnetcore/Magicodes.IE
