ASP.NET MVC 匯入 Excel 簡單做 - Part.2 匯入資料

上一篇完成了 Excel 的檔案上傳功能，那接下來要處理的就是已上傳 Excel 檔案的資料匯入，其實整個操作的流程會是檔案上傳完成後就直接進行 Excel 資料的匯入，我們就來完成這些功能吧。

 

---

請務必要先看過上一篇「ASP.NET MVC 匯入 Excel 簡單做 - Part.1 檔案上傳」，否則會在很多地方感覺到莫名其妙。

Excel 資料的匯入功能，其實資料的內容會決定功能好不好做，有的 Excel 資料的格式試相當複雜，例如欄位並非固定，有的會跨欄、有的會跨行，有的一張表會需要匯入到不同的資料庫表格，不管怎樣的格式，我們這邊就是相當單純的一個 Excel 檔案、一個 WorkSheet、直接匯入到一個資料庫表格。

資料的匯入並不是上傳一個 Excel 資料之後就把資料讀出來然後直接寫入到 Table 裡，在匯入之前要先做資料的檢查，以確保資料匯入的正確性，如果所上傳的 Excel 資料有錯誤，則該次的所上傳的 Excel 資料就不匯入，並且要讓使用者知道所上傳的 Excel 資料有哪些錯誤。

 

建立相關檔案

CheckResult.cs

這是用來裝載匯入資料的檢查資訊，其實如果做得更為仔細一點的話，這就是每一次上傳 Excel 檔案的檢查紀錄檔。

再來就是 ImportDataHelper.cs，這個類別就是用來檢查上傳的 Excel 檔案資料，以及將 Excel 資料匯入到 Table 裡，而讀取 Excel 資料的部份就是要透過 Linq to Excel，這個套件可以透過 NuGet 來安裝，

ImportDataHelper.cs

using System;

using System.Collections.Generic;

using System.IO;

using System.Linq;

using System.Text;

using System.Web;

using BlogSample.Models;

using LinqToExcel;

namespace BlogSample.Infrastructure.Helpers

{

    public class ImportDataHelper

    {

        /// <summary>

        /// 檢查匯入的 Excel 資料.

        /// </summary>

        /// <param name="fileName">Name of the file.</param>

        /// <param name="importZipCodes">The import zip codes.</param>

        /// <returns></returns>

        public CheckResult CheckImportData(

            string fileName,

            List<TaiwanZipCode> importZipCodes)

        {

            var result = new CheckResult();

            var targetFile = new FileInfo(fileName);

            if (!targetFile.Exists)

            {

                result.ID = Guid.NewGuid();

                result.Success = false;

                result.ErrorCount = 0;

                result.ErrorMessage = "匯入的資料檔案不存在";

                return result;

            }

            var excelFile = new ExcelQueryFactory(fileName);

            //欄位對映

            excelFile.AddMapping<TaiwanZipCode>(x => x.ID, "ID");

            excelFile.AddMapping<TaiwanZipCode>(x => x.Zip, "Zip");

            excelFile.AddMapping<TaiwanZipCode>(x => x.CityName, "CityName");

            excelFile.AddMapping<TaiwanZipCode>(x => x.Town, "Town");

            excelFile.AddMapping<TaiwanZipCode>(x => x.Sequence, "Sequence");

            //SheetName

            var excelContent = excelFile.Worksheet<TaiwanZipCode>("臺灣郵遞區號");

            int errorCount = 0;

            int rowIndex = 1;

            var importErrorMessages = new List<string>();

            //檢查資料

            foreach (var row in excelContent)

            {

                var errorMessage = new StringBuilder();

                var zipCode = new TaiwanZipCode();

                zipCode.ID = row.ID;

                zipCode.Sequence = row.Sequence;

                zipCode.Zip = row.Zip;

                zipCode.CreateDate = DateTime.Now;

                //CityName

                if (string.IsNullOrWhiteSpace(row.CityName))

                {

                    errorMessage.Append("縣市名稱 - 不可空白. ");

                }

                zipCode.CityName = row.CityName;

                //Town

                if (string.IsNullOrWhiteSpace(row.Town))

                {

                    errorMessage.Append("鄉鎮市區名稱 - 不可空白. ");

                }

                zipCode.Town = row.Town;

                //=============================================================================

                if (errorMessage.Length > 0)

                {

                    errorCount += 1;

                    importErrorMessages.Add(string.Format(

                        "第 {0} 列資料發現錯誤：{1}{2}",

                        rowIndex,

                        errorMessage,

                        "<br/>"));

                }

                importZipCodes.Add(zipCode);

                rowIndex += 1;

            }

            try

            {

                result.ID = Guid.NewGuid();

                result.Success = errorCount.Equals(0);

                result.RowCount = importZipCodes.Count;

                result.ErrorCount = errorCount;

                string allErrorMessage = string.Empty;

                foreach (var message in importErrorMessages)

                {

                    allErrorMessage += message;

                }

                result.ErrorMessage = allErrorMessage;

                return result;

            }

            catch (Exception ex)

            {

                throw;

            }

        }

        /// <summary>

        /// Saves the import data.

        /// </summary>

        /// <param name="importZipCodes">The import zip codes.</param>

        /// <exception cref="System.NotImplementedException"></exception>

        public void SaveImportData(IEnumerable<TaiwanZipCode> importZipCodes)

        {

            try

            {

                //先砍掉全部資料

                using (var db = new SampleEntities())

                {

                    foreach (var item in db.TaiwanZipCodes.OrderBy(x => x.ID))

                    {

                        db.TaiwanZipCodes.Remove(item);

                    }

                    db.SaveChanges();

                }

                //再把匯入的資料給存到資料庫

                using (var db = new SampleEntities())

                {

                    foreach (var item in importZipCodes)

                    {

                        db.TaiwanZipCodes.Add(item);

                    }

                    db.SaveChanges();

                }

            }

            catch (Exception ex)

            {

                throw;

            }

        }

    }

}

在最後的資料寫入 Table 部份，我並沒有去做資料重複性的檢查，因為是簡單做，所以我就直接先把原本的資料給全部刪除，接著再做匯入資料的新增。

 

ZipCodeController.cs

完成資料匯入的相關檔案建立之後，回到 ZipCodeController 裡建立檔案上傳完成之後的資料匯入的流程處理，

[HttpPost]

public ActionResult Import(string savedFileName)

{

    var jo = new JObject();

    string result;

    try

    {

        var fileName = string.Concat(Server.MapPath(fileSavedPath), "/", savedFileName);

        var importZipCodes = new List<TaiwanZipCode>();

        var helper = new ImportDataHelper();

        var checkResult = helper.CheckImportData(fileName, importZipCodes);

        jo.Add("Result", checkResult.Success);

        jo.Add("Msg", checkResult.Success ? string.Empty : checkResult.ErrorMessage);

        if (checkResult.Success)

        {

            //儲存匯入的資料

            helper.SaveImportData(importZipCodes);

        }

        result = JsonConvert.SerializeObject(jo);

    }

    catch (Exception ex)

    {

        throw;

    }

    return Content(result, "application/json");

}

 

前端

完成了 ZipCodeController.cs 的 Import Action 方法，所以就在 View 裡增加方法的路徑，並且在 project.ZipCode.js 增加匯入資料的前端處理。

~/Views/ZipCode/Index.cshtml

project.ZipCode.js

//================================================================================================

/// <reference path="_references.js" /> Ps.如果你要新增給IntelliSense用的js檔案, 請加在該檔案中

//================================================================================================

(function (app) {

    //===========================================================================================

    var current = app.ZipCode = {};

    //===========================================================================================

    jQuery.extend(app.ZipCode,

    {

        Initialize: function (actionUrls) {

            /// <summary>

            /// 初始化函式

            /// </summary>

            /// <param name="actionUrls"></param>

            jQuery.extend(project.ActionUrls, actionUrls);

            //上傳檔案事件處理

            current.UploadEventHandler();

        },

        UploadEventHandler: function () {

            /// <summary>

            /// 上傳匯入資料

            /// </summary>

            $("#UploadForm").ajaxForm({

                iframe: true,

                dataType: "json",

                success: function (result) {

                    $("#UploadForm").resetForm();

                    if (!result.Result) {

                        project.AlertErrorMessage("錯誤", result.Msg);

                    }

                    else {

                        $('#ResultContent').html(result.Msg);

                        project.ShowMessageCallback("訊息", "檔案上傳完成, 點選「確認」後開始進行資料匯入", function () {

                            current.ImportData(result.Msg);

                        });

                    }

                },

                error: function (xhr, textStatus, errorThrown) {

                    $("#UploadForm").resetForm();

                    project.AlertErrorMessage("錯誤", "檔案上傳錯誤");

                }

            });

        },

        ImportData: function (savedFileName) {

            /// <summary>

            /// 資料匯入

            /// </summary>

            /// <param name="mainID"></param>

            $.ajax({

                type: 'post',

                url: project.ActionUrls.Import,

                data: { savedFileName: savedFileName },

                async: false,

                cache: false,

                dataType: 'json',

                success: function (data) {

                    if (data.Msg) {

                        project.AlertErrorMessage("錯誤", data.Msg);

                        $('#UploadModal').modal('hide');

                    }

                    else {

                        project.ShowMessageCallback("訊息", "匯入完成", function () {

                            $('#UploadModal').modal('hide');

                            window.location.reload();

                        });

                    }

                },

                error: function () {

                    project.AlertErrorMessage("錯誤", "資料匯入發生錯誤");

                    $('#UploadModal').modal('hide');

                }

            });

        }

    });

})

(project);

 

執行結果

上傳一個內容資料有錯誤的 Excel 檔案

將檢查出錯誤的訊息給顯示出來

再來上傳一個資料正確的 Excel 檔案，上傳完成並且匯入完成

在顯示「匯入完成」的訊息視窗裡按下「確認」後就會重新整理頁面，就會把剛才所上傳並且匯入的資料顯示出來

 

就這樣，我們完成了一個簡單的 Excel 上傳與匯入的功能。既然已經完成 Excel 上傳與匯入功能之後，那麼也應該要再做一個匯出 Excel 的功能吧～

是的，下一篇就來說明怎麼簡單做 Excel 匯出的功能。

 

以上