LinqToExcel.Extend 源码分析第二波

happlyfox

关注

发布于: 2021 年 03 月 09 日

接着上文的内容继续讲，上文中我提到了对 Excel 操作帮助类库 LinqToExcel 类库的优缺点和使用方法。我也讲到了自己在使用中碰到的问题，我也开发了一个简单的类库解决，下面就讲解一下这个帮助类。

Github 链接 LinqToExcel.Extend

LinqToExcel 没有包含验证，在无法保证客户提供的 Excel 数据规范的前提下容易发生错误。所以对其进行扩展，扩展的内容主要就是在实体转换前对数据进行验证。

经过网络的简单学习，我总结验证包含俩点

1.默认验证参数有效性

2.自定是逻辑有效性

###数据有效性

>数据有效性主要指的是 Excel 单元格字段类型是否和定义的实体类属性字段一致，如果不一致需要提示。例如定义了一个字段 Datetime,但是传进来的内容是 2018 年 9 月 33 日。这种不符合要求的数据就是有问题的值。

###逻辑有效性

>逻辑有效性这个就更加好理解了，Excel 的单元格只允许出现是 *否* 这俩值，可是用户却填写了不是这样的值，后来在验证的时候就要过滤并给出错误提示

>我的扩展主要就是基于这俩个内容，大概的代码贴图如下。

如果要验证 Excel 的数据是否满足条件我们 New 一个 WorkBookValidate 对象，参数是 Excel 路径。

然后我们执行方法，如果我们想要验证第一个工作表是否符合 User 实体类的要求，代码就是这样 workbook[0].StartValidate<User>();

//自定义工作簿验证WorkBookValidate workbook = new WorkBookValidate("Default.xlsx");//验证结束返回Verification对象，对象包含 俩个属性，一个为是否验证成功，一个为验证出错的集合信息workbook[0].StartValidate<User>();

复制代码

>需要验证的实体，这里的内容和 LinqToExcel 定义不变，还是使用相同的特性标签。

public class User {
[ExcelColumn("Id")]public string ID { get; set; }
[ExcelColumn("名称")]public string Name { get; set; }
[ExcelColumn("年龄")]public int Age { get; set; }
[ExcelColumn("出生日期")]public DateTime BirthDay { get; set; }
public override string ToString(){    return string.Format("{0}\t{1}\t{2}", ID, Name, Age);}}

复制代码

这里主要是对各种事例的说明，主要分三个方法讲解

>对出错对象的输出，是下面例子的通用方法

    private static void Validate(Verification verifity)    {        Console.WriteLine(string.Format("是否通过{0}", verifity.IfPass));        //出错列        foreach (var item in verifity.ErrCells)        {            Console.WriteLine(item);        }    }

复制代码

BasicValidate

>首先第一个方法 BasicValidate，很标准的一个 Action,相信大家能够看懂，实例化对象，执行方法，打印错误字段

 /// <summary>    /// 基础验证 通过实体特性    /// </summary>    public static void BasicValidate()    {        WorkBookValidate workbook = new WorkBookValidate("Default.xlsx");        var errlist = workbook[0].StartValidate<User>();        Validate(errlist);    }

复制代码

####BasicValidate2

>第二个方法 BasicValidate2，和第一个方法类似，只是多了一个实体映射的方法，这个方法和 LinqToExcel 的方法使用类似，如果实体类未定义映射的特性标签，那么就通过如下方式自定义设置

    /// <summary>    /// 基础验证 自定义对应关系    /// </summary>    public static void BasicValidate2()    {        WorkBookValidate workbook = new WorkBookValidate("Other.xlsx");
        workbook[0].AddMapping("ID", "主键");        var errlist = workbook[0].StartValidate<User>();        Validate(errlist);    }

复制代码

ValidateWithCondition

>第三个方法 ValidateWithCondition 主要是增加了逻辑有效性验证，调用上述俩个方法，就相当于执行的是数据有效性验证，如果要增加逻辑有效性验证，只需要多添加一个参数就可以，参数如下所示

首先是验证的字段

然后是验证条件

最后是出错的提示信息

    /// <summary>    /// 带条件验证    /// </summary>    public static void ValidateWithCondition()    {        WorkBookValidate workbook = new WorkBookValidate("Default.xlsx");
        List<CellMatching<User>> rowValidate = new List<CellMatching<User>>();        rowValidate.Add(new CellMatching<User>()        {            paramater = u => u.Age,            matchCondition = u => u.Age > 10,            errMsg = "请选择年龄大于10的人员"        });
        var errlist = workbook[0].StartValidate<User>(rowValidate);        Validate(errlist);    }

复制代码

###总结

以上主要是对 API 使用的一些说明，大家可以自行下载代码。希望大家一起提出好的意见，一起优化，一起进步，一起学习。

发布于: 2021 年 03 月 09 日阅读数: 10

原文链接:【http://xie.infoq.cn/article/f703764e343a1a03538dae28e】。文章转载请联系作者。

happlyfox

关注

公众号程序员工具集 2021.02.18 加入

博客 [www.zhouhuibo.club] 分享优秀的开源项目、学习资源和常用工具。谈论新闻热点、职场经验、学习感悟。共同进步！

发布

暂无评论

创作场景

LinqToExcel.Extend 源码分析 第二波

BasicValidate

ValidateWithCondition

happlyfox

评论

LinqToExcel.Extend 源码分析第二波