1. SmartDapper.UI 项目概述SmartDapper.UI 是一款专注于数据库反向生成实体类的可视化工具。作为长期使用Dapper进行数据库开发的工程师我深知手动编写实体类的痛苦——每次数据库表结构变更都需要同步修改代码既耗时又容易出错。这个工具正是为了解决这个痛点而生。它通过直观的UI界面连接数据库自动扫描表结构并生成对应的C#实体类支持SQL Server、MySQL、PostgreSQL等主流数据库。与常规代码生成器不同SmartDapper.UI特别针对Dapper的使用场景进行了优化生成的实体类天然适配Dapper的轻量级ORM特性。2. 核心功能解析2.1 数据库连接与元数据提取工具内置多数据库连接驱动通过ADO.NET标准接口获取数据库元信息。连接配置支持基础连接字符串设置连接测试与验证多环境配置保存与切换元数据提取过程会读取表基本信息表名、注释列定义字段名、数据类型、长度、是否可空主键/外键约束索引信息提示对于大型数据库建议通过表名过滤减少加载时间特别是在开发环境连接生产库时。2.2 实体类生成引擎生成引擎采用模板化设计核心处理流程// 伪代码示例 foreach(var table in schema.Tables) { var classCode new StringBuilder(); // 添加using语句 classCode.AppendLine(using System;); // 生成类定义 classCode.AppendLine($public class {table.ClassName}); classCode.AppendLine({); // 生成属性 foreach(var column in table.Columns) { classCode.AppendLine($ public {column.NetType} {column.PropertyName} {{ get; set; }}); } classCode.AppendLine(}); SaveToFile(table.ClassName .cs); }关键特性包括类型映射系统DB类型→C#类型命名转换规则表名→类名字段名→属性名可配置的代码样式缩进、大括号位置等2.3 可视化配置界面UI层采用WPF实现主要功能区域数据库连接面板表选择树形列表生成选项配置区命名风格PascalCase/camelCase是否生成注释是否包含数据注解输出目录设置实时预览窗口3. 技术实现细节3.1 架构设计整体采用MVVM模式分层Presentation Layer (WPF) ↓ Business Logic Layer ↓ Data Access Layer (ADO.NET) ↓ Database依赖注入容器管理各模块DbConnector数据库连接管理MetadataReader元数据提取CodeGenerator代码生成引擎FileExporter文件输出3.2 类型映射系统内置的默认类型映射表数据库类型C#类型特殊处理varchar/nvarcharstring根据长度添加StringLength注解intint主键标记为Key注解datetimeDateTime可空版本自动处理decimaldecimal精度/小数位数保留bitbool自动转换支持通过配置文件自定义映射规则TypeMappings add DbTypetinyint NetTypebyte / add DbTypeuniqueidentifier NetTypeGuid / /TypeMappings3.3 命名转换策略实现的核心转换逻辑public static string ToPascalCase(string dbName) { // 处理下划线命名法 var parts dbName.Split(_); return string.Join(, parts.Select(p p.Length 0 ? char.ToUpper(p[0]) p.Substring(1).ToLower() : )); }支持多种命名风格转换保持原样user_name → user_name帕斯卡命名user_name → UserName驼峰命名user_name → userName自定义分隔符转换4. 高级功能实现4.1 关系映射生成对于外键关系可配置生成导航属性public class Order { public int Id { get; set; } public int CustomerId { get; set; } // 生成的导航属性 public virtual Customer Customer { get; set; } }支持的关系配置选项单向/双向导航延迟加载配置集合属性生成一对多关系4.2 数据注解支持可选的注解生成包括[Table(tbl_user)] public class User { [Key] [DatabaseGenerated(DatabaseGeneratedOption.Identity)] public int Id { get; set; } [Required] [StringLength(50)] public string Name { get; set; } [Column(create_time)] public DateTime CreateTime { get; set; } }4.3 部分类生成支持将实体类拆分为多个文件User.cs User.Metadata.cs便于在手动编写的部分中添加业务逻辑同时保留自动生成的部分可随时更新。5. 使用技巧与最佳实践5.1 团队协作方案推荐的工作流程将生成的实体类放入Generated文件夹通过部分类扩展功能在版本控制中忽略生成的代码在CI/CD流程中加入生成步骤5.2 模板自定义高级用户可编辑T4模板来定制生成逻辑# template languageC# # # import namespaceSystem.Collections.Generic # # foreach(var table in Tables) { # // 自定义类头注释 /// summary /// # table.Comment # /// /summary public partial class # table.ClassName # { # foreach(var col in table.Columns) { # public # col.NetType # # col.PropertyName # { get; set; } # } # } # } #5.3 性能优化技巧对于大型数据库使用异步加载表列表实现分页加载列信息缓存数据库元数据后台生成线程处理6. 常见问题解决6.1 连接问题排查常见错误及解决方案错误现象可能原因解决方法连接超时网络问题/防火墙检查端口开放情况登录失败凭据错误验证用户名密码缺少驱动程序未安装对应数据库驱动安装官方驱动仅显示系统表权限不足授予用户元数据查询权限6.2 生成代码问题典型代码问题处理类型映射错误检查自定义类型映射表验证数据库字段类型命名冲突调整命名转换规则使用自定义名称覆盖注释缺失确保数据库表/列有注释开启生成注释选项6.3 扩展性建议二次开发方向插件系统支持更多数据库支持如MongoDB生成仓储接口单元测试框架集成领域驱动设计支持在实际项目中使用时我建议将生成代码作为基础设施层的一部分配合Dapper的扩展方法实现高效数据访问。对于频繁变更的数据库结构可以设置定时生成任务确保代码与数据库保持同步。
