使用 EPPlus 封裝的 excel 表格導入功能 (二) delegate 委托 --永遠滴神

前言

接上一篇 使用 EPPlus 封裝的 excel 表格導入功能 (一)

前一篇的是大概能用但是不一定好用的版本

后來我又重新封裝擴展了一下

支持自定義更多東西(但是封裝地是否有必要我就說不清了)

上個版本的問題

上個版本封裝之后的使用代碼:

public ICollection<TestDto> ExcelImport(IFormFile file)
{
    var config = ExcelCellOption<TestDto>
    .GenExcelOption("姓名", item => item.Name)
    .Add("年齡", item => item.Age, item => int.Parse(item))
    .Add("性別", item => item.Gender, item => item == "男")
    .Add("身高", item => item.Height, item => double.Parse(item));

    ICollection<TestDto> result = ExcelOperation.ExcelToEntity(file.OpenReadStream(), config);

    return result;
}

設計邏輯是 一個單元格 對應 實體中的一個字段

這個設計一開始是沒什么問題的，將excel中的數據導入到 DTO集合 中，然后就可以進行下一步的操作

但在實際使用的時候發現，拿到 DTO集合 之后，總是需要再套個 foreach 做一些初始化操作

比如:

• 通過身份證號碼判斷性別
• 通過用戶名查詢賬單信息
• 給某個字段賦值
• 對應導入的數據生成其他的數據
• ......

基於以上的需要，重新修改后的調用代碼如下:

public ICollection<TestDto> ExcelImport(IFormFile file)
{
    var config = new ExcelImportOption<TestDto>()
    .Add("姓名", item => item.Name)
    .Add("年齡", item => item.Age, item => int.Parse(item))
    .Default(item => item.Height, 233)
    .AddInit(item =>
    {
        item.Name += "hhhhhhhh";
        item.Gender = false;
        return item;
    });
    ICollection<TestDto> result = ExcelOperation.ExcelToEntity(file.OpenReadStream(), config);

    return result;
}

代碼/設計/想法

由於我想在解析 excel 的同時進行初始化操作，所以委托這東西必不可少

Func<T, T> Init { get; set; }

由於現階段的需求比較簡單，不需要什么復雜的參數，所以使用 Func<> 或 Action<> 都可以

定義這個初始化 Init 之后，單純的 ICollection<ExcelCellOption<T>> 已經是不夠用了

所以重新定義了一個 配置

public class ExcelOption<T>
{
    public ICollection<ExcelCellOption<T>> FieldOption { get; set; } = new List<ExcelCellOption<T>>();
    public ICollection<ExcelCellOption<T>> DefaultOption { get; set; } = new List<ExcelCellOption<T>>();
    public Func<T, T> Init { get; set; }
}

其中的 DefaultOption 沒有也行

然后對 ExcelOption<T> 進行擴展

public static class ExcelOptionExt
{

    ......

    public static ExcelOption<T> AddInit<T>(this ExcelOption<T> origin, Func<T, T> action = null)
    {
        if (origin.Init == null) origin.Init = action;
        return origin;
    }
    // 沒有 DefaultOption 的情況下使用 FieldOption 也行
    public static ExcelOption<T> Default<T, E>(this ExcelOption<T> origin, Expression<Func<T, E>> prop, object defaultValue = null)
    {
        var member = prop.GetMember();
        if (origin.DefaultOption == null) origin.DefaultOption = new List<ExcelCellOption<T>>();
        origin.DefaultOption.Add(new ExcelCellOption<T>
        {
            PropName = member.Name,
            Prop = (PropertyInfo)member,
            ExcelField = string.Empty,
            Action = item => defaultValue
        });
        return origin;
    }

    ......
}

配置 接口改變之后，ExcelOperation 的 ExcelToEntity 方法也要進行修改

public static ICollection<T> ExcelToEntity<T>(Stream excelStream, ExcelOption<T> options)
{
    using ExcelPackage pack = new ExcelPackage(excelStream);
    // 合並 FieldOption 和 DefaultOption
    var propOptions = options.FieldOption.Concat(options.DefaultOption);

    var sheet = pack.Workbook.Worksheets[1];
    int rowCount = sheet.Dimension.Rows, colCount = sheet.Dimension.Columns;
    // 獲取對應設置的 表頭 以及其 column
    var header = sheet.Cells[1, 1, 1, sheet.Dimension.Columns]
    .Where(item => propOptions.Any(opt => opt.ExcelField == item.Value?.ToString().Trim()))
    .ToDictionary(item => item.Value?.ToString().Trim(), item => item.End.Column);
    List<T> data = new List<T>();
    // 將excel 的數據轉換為 對應實體
    for (int r = 2; r <= rowCount; r++)
    {
        // 將單行數據轉換為 表頭:數據 的鍵值對
        var rowData = sheet.Cells[r, 1, r, colCount]
        .Where(item => header.Any(title => title.Value == item.End.Column))
        .Select(item => new KeyValuePair<string, string>(header.First(title => title.Value == item.End.Column).Key, item.Value?.ToString().Trim()))
        .ToDictionary(item => item.Key, item => item.Value);
        var obj = Activator.CreateInstance(typeof(T));
        // 根據對應傳入的設置 為obj賦值
        foreach (var option in propOptions)
        {
            if (!string.IsNullOrEmpty(option.ExcelField))
            {
                var value = rowData.ContainsKey(option.ExcelField) ? rowData[option.ExcelField] : string.Empty;
                if (!string.IsNullOrEmpty(value))
                    option.Prop.SetValue(obj, option.Action == null ? value : option.Action(value));
            }
            else
                option.Prop.SetValue(obj, option.Action == null ? null : option.Action(string.Empty));
        }
        // 實際上只是加了個 Init 操作
        if (options.Init != null)
            obj = options.Init((T)obj);
        data.Add((T)obj);
    }
    return data;
}

然后這個階段就算是大功告成了！

再貼一次使用時的代碼

public ICollection<TestDto> ExcelImport(IFormFile file)
{
    var config = new ExcelImportOption<TestDto>()
    .Add("姓名", item => item.Name)
    .Add("年齡", item => item.Age, item => int.Parse(item))
    .Default(item => item.Height, 233)
    .AddInit(item =>
    {
        item.Name += "hhhhhhhh";
        item.Gender = false;
        return item;
    });
    ICollection<TestDto> result = ExcelOperation.ExcelToEntity(file.OpenReadStream(), config);

    return result;
}

完整代碼

public class ExcelOperation
{

    public static ICollection<T> ExcelToEntity<T>(Stream excelStream, ExcelOption<T> options)
    {
        using ExcelPackage pack = new ExcelPackage(excelStream);
        // 合並 FieldOption 和 DefaultOption
        var propOptions = options.FieldOption.Concat(options.DefaultOption);

        var sheet = pack.Workbook.Worksheets[1];
        int rowCount = sheet.Dimension.Rows, colCount = sheet.Dimension.Columns;
        // 獲取對應設置的 表頭 以及其 column
        var header = sheet.Cells[1, 1, 1, sheet.Dimension.Columns]
        .Where(item => propOptions.Any(opt => opt.ExcelField == item.Value?.ToString().Trim()))
        .ToDictionary(item => item.Value?.ToString().Trim(), item => item.End.Column);
        List<T> data = new List<T>();
        // 將excel 的數據轉換為 對應實體
        for (int r = 2; r <= rowCount; r++)
        {
            // 將單行數據轉換為 表頭:數據 的鍵值對
            var rowData = sheet.Cells[r, 1, r, colCount]
            .Where(item => header.Any(title => title.Value == item.End.Column))
            .Select(item => new KeyValuePair<string, string>(header.First(title => title.Value == item.End.Column).Key, item.Value?.ToString().Trim()))
            .ToDictionary(item => item.Key, item => item.Value);
            var obj = Activator.CreateInstance(typeof(T));
            // 根據對應傳入的設置 為obj賦值
            foreach (var option in propOptions)
            {
                if (!string.IsNullOrEmpty(option.ExcelField))
                {
                    var value = rowData.ContainsKey(option.ExcelField) ? rowData[option.ExcelField] : string.Empty;
                    if (!string.IsNullOrEmpty(value))
                        option.Prop.SetValue(obj, option.Action == null ? value : option.Action(value));
                }
                else
                    option.Prop.SetValue(obj, option.Action == null ? null : option.Action(string.Empty));
            }
            if (options.Init != null)
                obj = options.Init((T)obj);
            data.Add((T)obj);
        }
        return data;
    }

    /// <summary>
    /// 將表格數據轉換為指定的數據實體
    /// </summary>
    public static ICollection<T> ExcelToEntity<T>(Stream excelStream, ICollection<ExcelCellOption<T>> options)
    {
        using ExcelPackage pack = new ExcelPackage(excelStream);
        var sheet = pack.Workbook.Worksheets[1];
        int rowCount = sheet.Dimension.Rows, colCount = sheet.Dimension.Columns;
        // 獲取對應設置的 表頭 以及其 column
        var header = sheet.Cells[1, 1, 1, sheet.Dimension.Columns]
        .Where(item => options.Any(opt => opt.ExcelField == item.Value?.ToString().Trim()))
        .ToDictionary(item => item.Value?.ToString().Trim(), item => item.End.Column);
        List<T> data = new List<T>();
        // 將excel 的數據轉換為 對應實體
        for (int r = 2; r <= rowCount; r++)
        {
            // 將單行數據轉換為 表頭:數據 的鍵值對
            var rowData = sheet.Cells[r, 1, r, colCount]
            .Where(item => header.Any(title => title.Value == item.End.Column))
            .Select(item => new KeyValuePair<string, string>(header.First(title => title.Value == item.End.Column).Key, item.Value?.ToString().Trim()))
            .ToDictionary(item => item.Key, item => item.Value);
            var obj = Activator.CreateInstance(typeof(T));
            // 根據對應傳入的設置 為obj賦值
            foreach (var option in options)
            {
                if (!string.IsNullOrEmpty(option.ExcelField))
                {
                    var value = rowData.ContainsKey(option.ExcelField) ? rowData[option.ExcelField] : string.Empty;
                    if (!string.IsNullOrEmpty(value))
                        option.Prop.SetValue(obj, option.Action == null ? value : option.Action(value));
                }
                else
                    option.Prop.SetValue(obj, option.Action == null ? null : option.Action(string.Empty));
            }
            data.Add((T)obj);

        }
        return data;
    }
}

public class ExcelOption<T>
{
    public ICollection<ExcelCellOption<T>> FieldOption { get; set; } = new List<ExcelCellOption<T>>();
    public ICollection<ExcelCellOption<T>> DefaultOption { get; set; } = new List<ExcelCellOption<T>>();
    public Func<T, T> Init { get; set; }
}

public class ExcelCellOption<T>
{
    /// <summary>
    /// 對應excel中的header字段
    /// </summary>
    public string ExcelField { get; set; }
    /// <summary>
    /// 對應字段的屬性(實際上包含PropName)
    /// </summary>
    public PropertyInfo Prop { get; set; }
    /// <summary>
    /// 就是一個看起來比較方便的標識
    /// </summary>
    public string PropName { get; set; }
    /// <summary>
    /// 轉換 表格 數據的方法 (現在是個雞肋了)
    /// </summary>
    public Func<string, object> Action { get; set; }
    public static ICollection<ExcelCellOption<T>> GenExcelOption<E>(string field, Expression<Func<T, E>> prop, Func<string, object> action = null)
    {
        var member = prop.GetMember();
        return new List<ExcelCellOption<T>>{
            new ExcelCellOption<T>
            {
                PropName = member.Name,
                Prop = (PropertyInfo)member,
                ExcelField = field,
                Action = action
            }
        };
    }
}

public static class ExcelOptionExt
{
    public static ICollection<ExcelCellOption<T>> Add<T, E>(this ICollection<ExcelCellOption<T>> origin, string field, Expression<Func<T, E>> prop, Func<string, object> action = null)
    {
        var member = prop.GetMember();
        origin.Add(new ExcelCellOption<T>
        {
            PropName = member.Name,
            Prop = (PropertyInfo)member,
            ExcelField = field,
            Action = action
        });
        return origin;
    }

    public static ExcelOption<T> Add<T, E>(this ExcelOption<T> origin, string field, Expression<Func<T, E>> prop, Func<string, object> action = null)
    {
        var member = prop.GetMember();
        if (origin.FieldOption == null) origin.FieldOption = new List<ExcelCellOption<T>>();
        origin.FieldOption.Add(new ExcelCellOption<T>
        {
            PropName = member.Name,
            Prop = (PropertyInfo)member,
            ExcelField = field,
            Action = action
        });
        return origin;
    }
    public static ExcelOption<T> Default<T, E>(this ExcelOption<T> origin, Expression<Func<T, E>> prop, object defaultValue = null)
    {
        var member = prop.GetMember();
        if (origin.DefaultOption == null) origin.DefaultOption = new List<ExcelCellOption<T>>();
        origin.DefaultOption.Add(new ExcelCellOption<T>
        {
            PropName = member.Name,
            Prop = (PropertyInfo)member,
            ExcelField = string.Empty,
            Action = item => defaultValue
        });
        return origin;
    }
    public static ExcelOption<T> AddInit<T>(this ExcelOption<T> origin, Func<T, T> action = null)
    {
        if (origin.Init == null) origin.Init = action;
        return origin;
    }
}

未完待續