Linq2DB 中执行原生 SQL 查询的最佳实践

背景介绍

Linq2DB 是一个轻量级的 ORM 框架，提供了比 Entity Framework 更灵活的查询能力。在实际开发中，我们有时需要执行原生 SQL 查询，特别是当需要使用数据库特有的函数时。

原生 SQL 查询的几种方式

1. 使用 Execute 方法执行标量查询

对于简单的标量查询，可以使用 Execute 方法：

var ipremoteaddr = "192.168.0.1";
var inetAton = db.Execute<long>("SELECT INET_ATON('{ipremoteaddr}') AS Value");

这种方式简单直接，但需要注意字符串拼接可能导致 SQL 注入风险。

2. 使用 FromSql 方法（推荐）

对于更复杂的查询，特别是需要返回实体类型的场景，推荐使用 FromSql 方法：

var result = db.FromSql<MyResultType>("SELECT INET_ATON({0}) AS Value", ipremoteaddr)
              .FirstOrDefault();

这种方式支持参数化查询，更安全，且可以与 LINQ 查询组合使用。

3. 自定义数据库函数映射

对于常用的数据库函数，可以创建 C# 方法映射：

[Sql.Function("INET_ATON", ServerSideOnly = true)]
public static long InetAton(string ipAddress)
{
    throw new InvalidOperationException("This method should only be called in LINQ queries");
}

// 使用方式
var inetAton = db.Select(() => InetAton(ipremoteaddr));

这种方式既保持了类型安全，又能利用数据库特有功能。

常见问题与解决方案

1. 参数化查询问题

当使用字符串插值（FormattableString）时，可能会遇到参数解析错误。这是已知问题，将在下一个版本修复。目前建议使用明确的参数占位符（如 {0}）或自定义函数映射。

2. 标量查询与实体查询

• 标量查询：使用 Execute 或 Select 方法
• 实体查询：使用 FromSql 方法返回 IQueryable

3. 数据库特有函数

对于 MySQL 的 INET_ATON 等特有函数，最佳实践是创建映射函数，而不是直接写 SQL。这样代码更可维护，且能利用 LINQ 的编译时检查。

性能考虑

1. 对于高频调用的数据库函数，映射方式比原生 SQL 更高效
2. 复杂查询使用 FromSql 可以更好地利用 LINQ 的延迟执行特性
3. 标量查询使用 Execute 最为轻量级

总结

Linq2DB 提供了多种执行原生 SQL 的方式，开发者应根据具体场景选择：

• 简单标量查询：Execute 方法
• 复杂查询或需要组合 LINQ：FromSql 方法
• 常用数据库函数：自定义映射函数

通过合理选择查询方式，可以在保持代码安全性和可维护性的同时，充分利用数据库的特有功能。