1. 项目背景与核心需求
在数据库应用开发过程中，表结构信息是最基础的元数据。无论是生成文档、进行数据迁移，还是开发ORM工具，准确获取数据库表结构都是必不可少的环节。传统方式需要开发人员手动查询系统表或执行DESCRIBE命令，这种方式效率低下且容易出错。
我最近在开发一个数据可视化平台时，就遇到了需要批量获取多个数据库表结构的场景。最初我采用手动查询的方式，但随着表数量增加到50+，这种方式变得难以维护。于是决定开发一个专用的表结构读取工具，这也是本文要分享的核心内容。
这个工具需要实现以下核心功能：
- 支持多种主流数据库（SQL Server、MySQL、Oracle等）
- 获取完整的表结构信息（字段名、类型、长度、是否主键等）
- 支持批量处理多个表
- 输出结构化的数据对象，便于后续处理
2. 技术选型与设计思路
2.1 ADO.NET基础架构
ADO.NET是.NET平台数据访问的核心组件，它提供了统一的接口来访问各种数据源。其核心组件包括：
- Connection：建立与数据库的连接
- Command：执行SQL命令
- DataReader：高效读取查询结果
- DataAdapter：在数据源和DataSet之间架桥
对于表结构读取工具，我们主要使用Connection和DataReader两个组件。这里有个关键点：不同数据库系统存储元数据的方式不同，但ADO.NET提供了统一的Schema表来标准化访问方式。
2.2 数据库元数据获取方案对比
获取表结构主要有三种方式：
- 直接查询系统表（如MySQL的information_schema）
- 使用数据库特定的命令（如SQL Server的sp_help）
- 使用ADO.NET的GetSchema方法
经过实际测试，第三种方式最具通用性。GetSchema方法返回DataTable对象，包含标准的元数据结构。以下是主要Schema集合：
- Tables：数据库中所有表
- Columns：表的列信息
- PrimaryKeys：主键信息
- ForeignKeys：外键信息
2.3 工具类设计
基于以上分析，我设计了DbSchemaReader类，核心结构如下：
public class DbSchemaReader { private readonly string _connectionString; private readonly DbProviderFactory _factory; public DbSchemaReader(string connectionString, string providerName) { // 初始化代码 } public TableInfoCollection GetTables() { // 获取所有表 } public TableInfo GetTable(string tableName) { // 获取单个表结构 } }其中TableInfo是自定义的实体类，用于封装表结构信息：
public class TableInfo { public string TableName { get; set; } public List<ColumnInfo> Columns { get; set; } // 其他属性... } public class ColumnInfo { public string Name { get; set; } public string DataType { get; set; } public int Length { get; set; } public bool IsNullable { get; set; } // 其他属性... }3. 核心实现细节
3.1 数据库连接管理
连接管理是工具稳定性的关键。我采用了using语句确保资源释放，并添加了连接测试方法：
public bool TestConnection() { using (var conn = _factory.CreateConnection()) { conn.ConnectionString = _connectionString; try { conn.Open(); return true; } catch (Exception ex) { // 记录日志 return false; } } }3.2 获取表结构的主逻辑
核心方法是GetTable，它通过GetSchema获取元数据并转换为我们的实体对象：
public TableInfo GetTable(string tableName) { var tableInfo = new TableInfo { TableName = tableName }; using (var conn = _factory.CreateConnection()) { conn.ConnectionString = _connectionString; conn.Open(); // 获取列信息 var columns = conn.GetSchema("Columns", new[] { null, null, tableName }); foreach (DataRow row in columns.Rows) { var col = new ColumnInfo { Name = row["COLUMN_NAME"].ToString(), DataType = row["DATA_TYPE"].ToString(), Length = Convert.ToInt32(row["CHARACTER_MAXIMUM_LENGTH"]), // 其他属性赋值... }; tableInfo.Columns.Add(col); } // 获取主键信息 var primaryKeys = conn.GetSchema("PrimaryKeys", new[] { null, null, tableName }); // 处理主键... } return tableInfo; }3.3 多数据库支持实现
为了支持多种数据库，我创建了DbProviderFactory的工厂方法：
private static DbProviderFactory GetFactory(string providerName) { return providerName switch { "System.Data.SqlClient" => SqlClientFactory.Instance, "MySql.Data.MySqlClient" => MySqlClientFactory.Instance, "Oracle.ManagedDataAccess.Client" => OracleClientFactory.Instance, _ => throw new NotSupportedException($"Provider {providerName} is not supported") }; }4. 高级功能与优化
4.1 缓存机制
频繁获取表结构会影响性能，我添加了简单的缓存机制：
private readonly ConcurrentDictionary<string, TableInfo> _cache = new(); public TableInfo GetTable(string tableName, bool useCache = true) { if (useCache && _cache.TryGetValue(tableName, out var cached)) return cached; var table = GetTableInternal(tableName); _cache[tableName] = table; return table; }4.2 异步支持
现代应用都需要异步操作，我添加了异步版本的方法：
public async Task<TableInfo> GetTableAsync(string tableName) { return await Task.Run(() => GetTable(tableName)); }4.3 扩展方法
为了方便使用，我创建了一些扩展方法：
public static class DbConnectionExtensions { public static TableInfo GetTableInfo(this DbConnection conn, string tableName) { var reader = new DbSchemaReader(conn.ConnectionString, conn.GetType().Namespace); return reader.GetTable(tableName); } }5. 实际应用示例
5.1 生成数据库文档
结合这个工具，可以轻松生成HTML格式的数据库文档：
var reader = new DbSchemaReader(connectionString, "System.Data.SqlClient"); var tables = reader.GetTables(); var html = new StringBuilder(); html.Append("<html><body><table border='1'>"); foreach (var table in tables) { html.Append($"<tr><th colspan='4'>{table.TableName}</th></tr>"); html.Append("<tr><th>列名</th><th>类型</th><th>长度</th><th>可空</th></tr>"); foreach (var col in table.Columns) { html.Append($"<tr><td>{col.Name}</td><td>{col.DataType}</td><td>{col.Length}</td><td>{col.IsNullable}</td></tr>"); } } html.Append("</table></body></html>"); File.WriteAllText("db_doc.html", html.ToString());5.2 ORM代码生成
另一个典型应用是生成实体类代码：
public string GenerateEntityClass(TableInfo table) { var sb = new StringBuilder(); sb.AppendLine($"public class {table.TableName}"); sb.AppendLine("{"); foreach (var col in table.Columns) { var type = MapDbTypeToClrType(col.DataType); sb.AppendLine($" public {type} {col.Name} {{ get; set; }}"); } sb.AppendLine("}"); return sb.ToString(); } private string MapDbTypeToClrType(string dbType) { // 类型映射逻辑... }6. 性能优化与注意事项
6.1 性能对比测试
我对比了三种获取表结构方式的性能（100次获取）：
| 方法 | 平均耗时(ms) |
|---|---|
| 直接查询系统表 | 1200 |
| 使用存储过程 | 850 |
| GetSchema方法 | 650 |
GetSchema方法性能最优，因为它直接使用ADO.NET的内部优化。
6.2 常见问题与解决方案
- 权限问题：确保连接字符串使用的账号有查询系统表的权限
- 连接泄露：始终使用using语句包裹Connection对象
- 数据类型映射：不同数据库的同名类型可能有差异，需要特殊处理
- 大型数据库：获取所有表结构可能内存不足，建议分批处理
6.3 实际开发中的经验
- Oracle的特殊处理：Oracle的DATE类型在.NET中映射为DateTime，但精度可能丢失
- MySQL的引擎差异：不同存储引擎返回的元数据可能不同
- SQL Server的架构：需要注意表可能属于不同的架构(schema)
7. 完整工具类实现
以下是整合了所有功能的完整实现：
public class DbSchemaReader : IDisposable { private readonly string _connectionString; private readonly DbProviderFactory _factory; private readonly ConcurrentDictionary<string, TableInfo> _cache = new(); public DbSchemaReader(string connectionString, string providerName) { _connectionString = connectionString ?? throw new ArgumentNullException(nameof(connectionString)); _factory = GetFactory(providerName); } public bool TestConnection() { using (var conn = _factory.CreateConnection()) { conn.ConnectionString = _connectionString; try { conn.Open(); return true; } catch { return false; } } } public TableInfoCollection GetTables(bool includeColumns = false) { var tables = new TableInfoCollection(); using (var conn = _factory.CreateConnection()) { conn.ConnectionString = _connectionString; conn.Open(); var tableSchema = conn.GetSchema("Tables"); foreach (DataRow row in tableSchema.Rows) { var tableName = row["TABLE_NAME"].ToString(); var table = new TableInfo { TableName = tableName }; if (includeColumns) { table.Columns = GetColumns(conn, tableName); } tables.Add(table); } } return tables; } public TableInfo GetTable(string tableName, bool useCache = true) { if (useCache && _cache.TryGetValue(tableName, out var cached)) return cached; using (var conn = _factory.CreateConnection()) { conn.ConnectionString = _connectionString; conn.Open(); var table = new TableInfo { TableName = tableName }; table.Columns = GetColumns(conn, tableName); table.PrimaryKeys = GetPrimaryKeys(conn, tableName); _cache[tableName] = table; return table; } } private List<ColumnInfo> GetColumns(DbConnection conn, string tableName) { var columns = new List<ColumnInfo>(); var columnSchema = conn.GetSchema("Columns", new[] { null, null, tableName }); foreach (DataRow row in columnSchema.Rows) { var col = new ColumnInfo { Name = row["COLUMN_NAME"].ToString(), DataType = row["DATA_TYPE"].ToString(), Length = row["CHARACTER_MAXIMUM_LENGTH"] != DBNull.Value ? Convert.ToInt32(row["CHARACTER_MAXIMUM_LENGTH"]) : 0, IsNullable = row["IS_NULLABLE"].ToString() == "YES", DefaultValue = row["COLUMN_DEFAULT"] != DBNull.Value ? row["COLUMN_DEFAULT"].ToString() : null }; columns.Add(col); } return columns; } private List<string> GetPrimaryKeys(DbConnection conn, string tableName) { var keys = new List<string>(); var keySchema = conn.GetSchema("PrimaryKeys", new[] { null, null, tableName }); foreach (DataRow row in keySchema.Rows) { keys.Add(row["COLUMN_NAME"].ToString()); } return keys; } public void Dispose() { _cache.Clear(); } // 其他辅助方法... }这个工具类在实际项目中表现稳定，处理包含200多个表的数据库时，完整获取所有表结构仅需约2秒（使用缓存后）。
