基于Dapper与MySQL的C#类外键属性定义及填充咨询
Dapper + MySQL 下外键属性定义与填充方案
一、外键对应的类属性正确定义方式
结合你给出的一对多场景(Product侧持有外键C_CustomerID关联单个Customer,Customer侧关联多个Product),先逐一分析你提到的4个方案:
- 方案1(
public int C_CustomerID { get; set; }):完全正确。这就是数据库中外键标量字段的直接映射,和表字段名完全一致,Dapper可以自动完成映射,不需要额外配置。 - 方案2(
public List<CustomerID> C_CustomerID { get; set; }):完全错误。CustomerID是int类型,不是自定义类,无法作为List的泛型参数;且Product侧仅关联单个Customer,外键是单值,不需要集合类型。 - 方案3(
public List<Customer> C_CustomerID { get; set; }):完全错误。C_CustomerID对应数据库返回的单个int值,设为List<Customer>类型会直接导致Dapper自动映射失败;且Product仅关联单个Customer,不需要集合类型。 - 方案4(
public List<Customer> Customer { get; set; }):不适用当前场景。如果是写在Product类中,单个产品只对应一个Customer,不需要List集合,应该定义为单个Customer类型的导航属性(比如public Customer Customer { get; set; });如果是写在Customer类中用来表达一对多关系,才需要集合类型,且属性名应该对应关联的多端实体(比如public List<Product> Products { get; set; })。
推荐的完整类定义
// Customer类(关系一端) public class Customer { public int CustomerID { get; set; } public string CustomerName { get; set; } // 一对多导航属性:存储当前客户关联的所有产品 public List<Product> Products { get; set; } } // Product类(关系多端) public class Product { public int ProductID { get; set; } public string ProductName { get; set; } // 外键标量属性:对应数据库的C_CustomerID字段 public int C_CustomerID { get; set; } // 一对一导航属性:存储当前产品关联的完整Customer对象 public Customer Customer { get; set; } }
二、使用Dapper填充属性的实现方式
Dapper作为轻量ORM,本身不提供自动关联导航属性的功能(没有EF Core的Include方法),所有关联数据都需要手动处理,没有强制要求使用存储过程,内嵌SQL即可满足需求,常用实现分三类场景:
1. 仅填充标量外键属性
直接查询Product表的所有字段即可,Dapper会自动按字段名映射到同名属性:
// 前提:已初始化好MySQL的IDbConnection对象 string querySql = "SELECT ProductID, ProductName, C_CustomerID FROM Product WHERE C_CustomerID = @CustomerId"; // 直接执行查询,C_CustomerID会自动完成映射 var productList = conn.Query<Product>(querySql, new { CustomerId = 1 }).ToList();
2. 填充Product的Customer导航属性
单条数据场景:用Dapper多映射功能一次联表查询
如果只需要查单个Product及其关联的Customer,可以一次联表查询,通过Dapper的多对象映射拆分赋值:
string joinSql = @" SELECT p.ProductID, p.ProductName, p.C_CustomerID, c.CustomerID, c.CustomerName FROM Product p LEFT JOIN Customer c ON p.C_CustomerID = c.CustomerID WHERE p.ProductID = @ProductId"; var product = conn.Query<Product, Customer, Product>( sql: joinSql, map: (product, customer) => { // 将查询到的Customer对象赋值给Product的导航属性 product.Customer = customer; return product; }, param: new { ProductId = 1 }, // 指定拆分点:从CustomerID字段开始拆分第二个Customer对象 splitOn: "CustomerID" ).FirstOrDefault();
批量数据场景:内存匹配赋值,避免循环查库
如果需要批量查询多个Product及其关联的Customer,不要循环执行单条查询,先批量取数再内存匹配:
// 第一步:批量查出所有需要的Product var productList = conn.Query<Product>( "SELECT * FROM Product WHERE CreateTime > @StartTime", new { StartTime = DateTime.Now.AddDays(-7) } ).ToList(); // 第二步:提取所有不重复的外键值,一次性批量查对应的Customer var customerIdList = productList.Select(p => p.C_CustomerID).Distinct().ToList(); var customerDict = conn.Query<Customer>( "SELECT * FROM Customer WHERE CustomerID IN @CustomerIdList", new { CustomerIdList = customerIdList } ).ToDictionary(c => c.CustomerID); // 第三步:内存匹配,给每个Product的导航属性赋值 foreach (var product in productList) { if (customerDict.TryGetValue(product.C_CustomerID, out var relatedCustomer)) { product.Customer = relatedCustomer; } }
3. 填充Customer的Products导航属性
逻辑和上述批量场景完全一致:先批量查出所有需要的Customer,再一次性查出这些客户关联的所有Product,按CustomerID分组后赋值即可。
注:如果你的项目规范要求使用存储过程,只需要将上述SQL语句替换为存储过程名,同时在Dapper查询方法中增加
commandType: CommandType.StoredProcedure参数即可,映射逻辑完全不变。
内容的提问来源于stack exchange,提问作者user14952224
相关产品推荐
相关产品推荐

