基于NPOI的Excel数据导入

从Excel导入数据最令人头疼的是数据格式的兼容性，特别是日期类型的兼容性。为了能够无脑导入日期，折腾了一天的NPOI。在经过测试确实可以导入任意格式的合法日期后，写下这篇小文，与大家共享。完整代码请移步：https://github.com/xuanbg/Utility

2016-11-13 04:06 修正一个bug。由try DateCellValue改为判断列数据类型，如类型为DateTiime返回DateCellValue，否则返回NumericCellValue或StringCellValue。

概述：

这个帮助类是一个泛型类，泛型参数对应的实体类还起到模板的作用。如果你的Excel文件使用与实体类不同的列标题的话，可以通过给属性加上Alias特性，将列标题和属性进行对应。例如：

Excel格式如图：

实体类：

using System;
using Insight.Utils.Common;

namespace Insight.WS.Server.Common.Entity
{
    public class Logistics
    {
        [Alias("订单号")]
        public string OrderCode { get; set; }

        [Alias("物流公司")]
        public string Service { get; set; }

        [Alias("物流单号")]
        public string Number { get; set; }

        [Alias("发货时间")]
        public DateTime DeliveryTime { get; set; }
    }
}

返回的Json：

[
  {
    "OrderCode": "201611S1200324",
    "Service": "顺丰",
    "Number": "33012231F54351",
    "DeliveryTime": "2016-11-10T11:02:44"
  },
  {
    "OrderCode": "2016111200324",
    "Service": "顺丰",
    "Number": "33012231F54352",
    "DeliveryTime": "2016-11-12T09:02:44"
  },
  {
    "OrderCode": "2016111200324",
    "Service": "EMS",
    "Number": "33012231F54353",
    "DeliveryTime": "2016-11-12T09:02:44"
  }
]

1、类主体，负责根据传入的文件路径读取数据，并调用其他私有方法对数据进行处理。最后转换成List<T>并序列化成Json返回。

using System;
using System.Collections.Generic;
using System.Data;
using System.IO;
using Insight.Utils.Entity;
using NPOI.SS.UserModel;

namespace Insight.Utils.Common
{
    public class NpoiHelper<T> where T : new()
    {
        private readonly Result _Result = new Result();

        /// <summary>
        /// 导入Excel文件
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="index">Sheet索引</param>
        /// <returns>Result</returns>
        public Result Import(string path, int index = 0)
        {
            if (!File.Exists(path))
            {
                _Result.FileNotExists();
                return _Result;
            }

            IWorkbook book;
            using (var file = new FileStream(path, FileMode.Open, FileAccess.Read))
            {
                book = WorkbookFactory.Create(file);
            }

            if (index >= book.NumberOfSheets)
            {
                _Result.SheetNotExists();
                return _Result;
            }

            var sheet = book.GetSheetAt(index);
            var table = GetSheetData(sheet);
            var list = Util.ConvertToList<T>(table);
            _Result.Success(list);
            return _Result;
        }
    }
}

2、GetSheetData方法，负责将Sheet中的数据读取到DataTable。这里通过实体类属性的特性值作为列名，属性类型作为列数据类型来初始化DataTable。当然，首行是例外，因为首行是列标题而非数据。

        /// <summary>
        /// 读取Sheet中的数据到DataTable
        /// </summary>
        /// <param name="sheet">当前数据表</param>
        /// <returns>DataTable</returns>
        private DataTable GetSheetData(ISheet sheet)
        {
            var table = InitTable(sheet);
            if (table == null) return null;

            var rows = sheet.GetEnumerator();
            while (rows.MoveNext())
            {
                var row = (IRow) rows.Current;
                if (row.RowNum == 0) continue;

                var dr = table.NewRow();
                for (var i = 0; i < table.Columns.Count; i++)
                {
                    try
                    {
                        var type = table.Columns[i].DataType;
                        dr[i] = GetCellData(row.GetCell(i), type);
                    }
                    catch (Exception)
                    {
                        dr[i] = DBNull.Value;
                    }

                }
                table.Rows.Add(dr);
            }

            return table;
        }

初始化DataTable的方法：

        /// <summary>
        /// 初始化DataTable
        /// </summary>
        /// <param name="sheet">当前数据表</param>
        /// <returns>DataTable</returns>
        private DataTable InitTable(ISheet sheet)
        {
            var title = sheet.GetRow(0);
            if (title == null)
            {
                _Result.NoRowsRead();
                return null;
            }

            try
            {
                var dict = GetDictionary();
                var table = new DataTable();
                foreach (var cell in title.Cells)
                {
                    var col_name = cell.StringCellValue;
                    var col_type = dict[col_name];
                    table.Columns.Add(cell.StringCellValue, col_type);
                }

                return table;
            }
            catch
            {
                _Result.IncorrectExcelFormat();
                return null;
            }
        }

生成模板字典的方法：

        /// <summary>
        /// 获取指定类型的属性名称/类型字典
        /// </summary>
        /// <returns>Dictionary</returns>
        private Dictionary<string, Type> GetDictionary()
        {
            var dict = new Dictionary<string, Type>();
            var propertys = typeof(T).GetProperties();
            foreach (var p in propertys)
            {
                string name;
                var attributes = p.GetCustomAttributes(typeof(AliasAttribute), false);
                if (attributes.Length > 0)
                {
                    var type = (AliasAttribute)attributes[0];
                    name = type.Alias;
                }
                else
                {
                    name = p.Name;
                }

                dict.Add(name, p.PropertyType);
            }

            return dict;
        }

3、重点来了！

因为日期/时间在Excel中可能被表示为文本格式或日期格式（其实是Numeric类型），所以在CellType为String/Numeric的时候，如果列数据类型为DateTime，则取cell的DateCellValue，否则取cell的StringCellValue/NumericCellValue就好了。

这样，无论日期是文本或日期格式，都可以完美获取。

        /// <summary>
        /// 读Excel单元格的数据
        /// </summary>
        /// <param name="cell">Excel单元格</param>
        /// <param name="type">列数据类型</param>
        /// <returns>object 单元格数据</returns>
        private object GetCellData(ICell cell, Type type)
        {
            switch (cell.CellType)
            {
                case CellType.Numeric:
                    if (type == typeof(DateTime)) return cell.DateCellValue;

                    return cell.NumericCellValue;

                case CellType.String:
                    if (type == typeof(DateTime)) return cell.DateCellValue;

                    return cell.StringCellValue;

                case CellType.Boolean:
                    return cell.BooleanCellValue;

                case CellType.Unknown:
                case CellType.Formula:
                case CellType.Blank:
                case CellType.Error:
                    return null;
                default:
                    return null;
            }
        }

 4、DataTable转成List<T>的方法：

        /// <summary>
        /// 将DataTable转为List
        /// </summary>
        /// <param name="table">DataTable</param>
        /// <returns>List</returns>
        public static List<T> ConvertToList<T>(DataTable table) where T: new()
        {
            var list = new List<T>();
            var propertys = typeof(T).GetProperties();
            foreach (DataRow row in table.Rows)
            {
                var obj = new T();
                foreach (var p in propertys)
                {
                    string name;
                    var attributes = p.GetCustomAttributes(typeof(AliasAttribute), false);
                    if (attributes.Length > 0)
                    {
                        var type = (AliasAttribute) attributes[0];
                        name = type.Alias;
                    }
                    else
                    {
                        name = p.Name;
                    }

                    if (table.Columns.Contains(name))
                    {
                        if (!p.CanWrite) continue;

                        var value = row[name];
                        if (value == DBNull.Value) value = null;

                        p.SetValue(obj, value, null);
                    }
                }
                list.Add(obj);
            }
            return list;
        }

自定义特性：

using System;

namespace Insight.Utils.Common
{
    [AttributeUsage(AttributeTargets.Property)]
    public class AliasAttribute : Attribute
    {
        /// <summary>
        /// 属性别名
        /// </summary>
        public string Alias { get; }

        /// <summary>
        /// 构造方法
        /// </summary>
        /// <param name="alias">别名</param>
        public AliasAttribute(string alias)
        {
            Alias = alias;
        }
    }
}

请大家对此多发表意见和建议，谢谢。