开源 - Ideal库 - Excel帮助类，TableHelper实现（二）

可樂

书接上回，我们今天开始实现对象集合与DataTable的相互转换。

01、接口设计

上文中已经详细讲解了整体设计思路以及大致设计了需要哪些方法。下面我们先针对上文设计思想确定对外提供的接口。具体接口如下：

1. //根据列名数组创建表格
2. public static DataTable Create(string[] columnNames, string? tableName = null);
4. //根据列名-类型键值对创建表格
5. public static DataTable Create(Dictionary<string, Type> columns, string? tableName = null);
7. //根据类创建表格
8. //如果设置DescriptionAttribute，则将特性值作为表格的列名称
9. //否则将属性名作为表格的列名称
10. public static DataTable Create<T>(string? tableName = null);
12. //把表格转换为实体对象集合
13. //如果设置DescriptionAttribute，则将特性值作为表格的列名称
14. //否则将属性名作为表格的列名称
15. public static IEnumerable<T> ToModels<T>(DataTable dataTable);
17. //把实体对象集合转为表格
18. //如果设置DescriptionAttribute，则将特性值作为表格的列名称
19. //否则将属性名作为表格的列名称
20. public static DataTable ToDataTable<T>(IEnumerable<T> models, string? tableName = null);
22. //把一维数组作为一列转换为表格
23. public static DataTable ToDataTableWithColumnArray<TColumn>(TColumn[] array, string? tableName = null, string? columnName = null);
25. //把一维数组作为一行转换为表格
26. public static DataTable ToDataTableWithRowArray<TRow>(TRow[] array, string? tableName = null);
28. //行列转置
29. public static DataTable Transpose(DataTable dataTable, bool isColumnNameAsData = true);

复制代码

02、根据列名数组创建表格

该方法实现比较简单，我们直接看代码：

1. //根据列名数组创建表格
2. public static DataTable Create(string[] columnNames, string? tableName = null)
3. {
4.     var table = new DataTable(tableName);
5.     foreach (var columnName in columnNames)
6.     {
7.         table.Columns.Add(columnName);
8.     }
9.     return table;
10. }

复制代码

我们进行一个简单的单元测试：

1. [Fact]
2. public void Create()
3. {
4.     //正常创建成功
5.     var columnNames = new string[] { "A", "B" };
6.     var table = TableHelper.Create(columnNames);
7.     Assert.Equal("", table.TableName);
8.     Assert.Equal(2, table.Columns.Count);
9.     Assert.Equal(columnNames[0], table.Columns[0].ColumnName);
10.     Assert.Equal(columnNames[1], table.Columns[1].ColumnName);
11.     Assert.Equal(typeof(string), table.Columns[0].DataType);
12.     Assert.Equal(typeof(string), table.Columns[1].DataType);
14.     //验证表名
15.     table = TableHelper.Create(columnNames, "test");
16.     Assert.Equal("test", table.TableName);
18.     //验证列名不能重复
19.     columnNames = new string[] { "A", "A" };
20.     Assert.Throws<DuplicateNameException>(() => TableHelper.Create(columnNames));
21. }

复制代码

03、根据列名-类型键值对创建表格

此方法是上一个方法的补充，默认直接根据列名创建表格，则所有列的数据类型都是string类型，而此方法可以指定每列的数据类型，实现也很简单，代码如下：

1. //根据列名-类型键值对创建表格
2. public static DataTable Create(Dictionary<string, Type> columns, string? tableName = null)
3. {
4.     var table = new DataTable(tableName);
5.     foreach (var column in columns)
6.     {
7.         table.Columns.Add(column.Key, column.Value);
8.     }
9.     return table;
10. }

复制代码

04、根据类创建表格

该方法是将类的属性名作为表格的列名称，属性对应的类型作为表格列的数据类型，把类转为表格。
同时我们需要约束类只能为结构体或类，而不能是枚举、基础类型、以及集合类型、委托、接口等。显然我们很难通过泛型约束达到我们的需求，因此我们首先需要对该方法的泛型进行类型校验。
校验成功后，我们只需要通过反射即可拿到类的所有属性信息，即可创建表格。同时我们约定如果属性设置了DescriptionAttribute特性，则特性值作为列名，如果没有设置特性则取属性名称作为列名。

1. //根据类创建表格
2. //如果设置DescriptionAttribute，则将特性值作为表格的列名称
3. //否则将属性名作为表格的列名称
4. public static DataTable Create<T>(string? tableName = null)
5. {
6.     //T必须是结构体或类，并且不能是集合类型
7.     AssertTypeValid<T>();
8.     //获取类的所有公共属性
9.     var properties = typeof(T).GetProperties();
10.     var columns = new Dictionary<string, Type>();
11.     foreach (var property in properties)
12.     {
13.         //根据属性获取列名
14.         var columnName = GetColumnName(property);
15.         //组织列名-类型键值对
16.         columns.Add(columnName, property.PropertyType);
17.     }
18.     return Create(columns, tableName);
19. }
21. //断言类型有效性
22. private static void AssertTypeValid<T>()
23. {
24.     var type = typeof(T);
25.     if (type.IsValueType && !type.IsEnum && !type.IsPrimitive)
26.     {
27.         //是值类型，但是不是枚举或基础类型
28.         return;
29.     }
30.     else if (typeof(T).IsClass && !typeof(IEnumerable).IsAssignableFrom(typeof(T)))
31.     {
32.         //是类类型，但是不是集合类型，同时也不是委托、接口类型
33.         return;
34.     }
35.     throw new InvalidOperationException("T must be a struct or class and cannot be a collection type.");
36. }
38. //根据属性获取列名称
39. private static string GetColumnName(PropertyInfo property)
40. {
41.     //获取描述特性
42.     var attribute = property.GetCustomAttribute<DescriptionAttribute>();
43.     //如果存在描述特性则返回描述，否则返回属性名称
44.     return attribute?.Description ?? property.Name;
45. }

复制代码

下面我们针对枚举、字符串，基础类型、集合等情况进行详细的单元测试，代码如下：

1. [Fact]
2. public void Create_T()
3. {
4.     //验证枚举
5.     var expectedMessage = "T must be a struct or class and cannot be a collection type.";
6.     var exception1 = Assert.Throws<InvalidOperationException>(() => TableHelper.Create<StatusEnum>());
7.     Assert.Equal(expectedMessage, exception1.Message);
9.     //验证基础类型
10.     var exception2 = Assert.Throws<InvalidOperationException>(() => TableHelper.Create<int>());
11.     Assert.Equal(expectedMessage, exception2.Message);
13.     //验证字符串类型
14.     var exception3 = Assert.Throws<InvalidOperationException>(() => TableHelper.Create<string>());
15.     Assert.Equal(expectedMessage, exception3.Message);
17.     //验证集合
18.     var exception4 = Assert.Throws<InvalidOperationException>(() => TableHelper.Create<Dictionary<string, Type>>());
19.     Assert.Equal(expectedMessage, exception4.Message);
21.     //验证正常情况
22.     var table = TableHelper.Create<Student<double>>();
23.     Assert.Equal("", table.TableName);
24.     Assert.Equal(3, table.Columns.Count);
25.     Assert.Equal("标识", table.Columns[0].ColumnName);
26.     Assert.Equal("姓名", table.Columns[1].ColumnName);
27.     Assert.Equal("Age", table.Columns[2].ColumnName);
28.     Assert.Equal(typeof(string), table.Columns[0].DataType);
29.     Assert.Equal(typeof(string), table.Columns[1].DataType);
30.     Assert.Equal(typeof(double), table.Columns[2].DataType);
31. }

复制代码

注：测试方法代码以及示例源码都已经上传至代码库，有兴趣的可以看看。https://gitee.com/hugogoos/Ideal

来源:https://www.cnblogs.com/hugogoos/p/18577563
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！