SqlKata Query Builder：.NET 开发者的终极 SQL 查询构建解决方案
项目地址: https://gitcode.com/gh_mirrors/qu/querybuilder 还在为复杂的 SQL 查询编写而头疼吗？还在为不同数据库的语法差异而烦恼吗？SqlKata Query Builder 将彻底改变你的 .NET 数据库操作体验！
什么是 SqlKata Query Builder？
SqlKata 是一个强大、灵活且安全的 SQL 查询构建器，专为 .NET 开发者设计。它提供了一套统一的 API，让你能够以流畅、直观的方式构建复杂的 SQL 查询，同时支持多种主流数据库引擎。
核心特性一览
| 特性 | 描述 | 优势 |
|---|---|---|
| 多数据库支持 | SqlServer、MySQL、PostgreSQL、Oracle、Firebird | 一套代码，多库通用 |
| 流畅 API | 链式调用，类似 LINQ 的语法 | 代码可读性极高 |
| 类型安全 | 强类型构建，减少运行时错误 | 开发体验更佳 |
| Dapper 集成 | 内置 Dapper 支持，性能卓越 | 执行效率极高 |
| 复杂查询支持 | 嵌套查询、联合查询、条件查询等 | 应对各种业务场景 |
为什么选择 SqlKata？
1. 告别 SQL 注入风险
// 传统方式 - 存在 SQL 注入风险
string sql = $"SELECT * FROM Users WHERE Name = '{userInput}'";
// SqlKata 方式 - 完全安全
var query = new Query("Users").Where("Name", userInput);
2. 跨数据库兼容性
3. 丰富的查询功能支持
基础查询示例
// 简单查询
var users = db.Query("Users")
.Where("Active", true)
.OrderBy("CreatedAt")
.Get();
// 分页查询
var page2 = db.Query("Products")
.Where("Category", "Electronics")
.Paginate(20, 2);
// 联表查询
var orders = db.Query("Orders")
.Join("Customers", "Customers.Id", "Orders.CustomerId")
.Select("Orders.*", "Customers.Name as CustomerName")
.Get();
高级功能示例
// 条件查询
var isWeekend = DateTime.Now.DayOfWeek == DayOfWeek.Saturday
|| DateTime.Now.DayOfWeek == DayOfWeek.Sunday;
var products = db.Query("Products")
.When(isWeekend, q => q.Where("IsFeatured", true))
.When(!isWeekend, q => q.Where("IsOnSale", true))
.Get();
// 嵌套查询（子查询）
var expensiveProducts = db.Query("Products")
.WhereIn("CategoryId",
db.Query("Categories").Where("IsPremium", true).Select("Id"))
.Get();
// CTE（公用表表达式）
var cteQuery = db.Query("Users")
.Where("Age", ">", 18)
.As("Adults");
var result = db.Query(cteQuery)
.Join("Orders", "Orders.UserId", "Adults.Id")
.Select("Adults.*", "Orders.TotalAmount")
.Get();
安装与配置
安装 NuGet 包
# 核心查询构建器
dotnet add package SqlKata
# 执行扩展（推荐）
dotnet add package SqlKata.Execution
基本配置
using SqlKata;
using SqlKata.Compilers;
using SqlKata.Execution;
using System.Data.SqlClient;
// 配置数据库连接
var connection = new SqlConnection("YourConnectionString");
var compiler = new SqlServerCompiler(); // 根据数据库选择编译器
// 创建查询工厂
var db = new QueryFactory(connection, compiler);
// 设置全局日志（可选）
db.Logger = result =>
{
Console.WriteLine(result.Sql);
Console.WriteLine(string.Join(",", result.Bindings));
};
实战案例：电商系统查询构建
场景 1：商品搜索与过滤
public IEnumerable<Product> SearchProducts(ProductSearchCriteria criteria)
{
var query = db.Query("Products")
.Where("IsActive", true);
// 条件过滤
if (!string.IsNullOrEmpty(criteria.Category))
query = query.Where("Category", criteria.Category);
if (criteria.MinPrice.HasValue)
query = query.Where("Price", ">=", criteria.MinPrice.Value);
if (criteria.MaxPrice.HasValue)
query = query.Where("Price", "<=", criteria.MaxPrice.Value);
// 排序
query = criteria.SortBy switch
{
"price" => query.OrderBy("Price"),
"name" => query.OrderBy("Name"),
"date" => query.OrderByDesc("CreatedAt"),
_ => query.OrderBy("Id")
};
// 分页
return query.Paginate(criteria.PageSize, criteria.PageNumber);
}
场景 2：用户行为分析
public dynamic GetUserActivityReport(int userId)
{
return db.Query("UserActivities")
.Where("UserId", userId)
.WhereBetween("ActivityDate", DateTime.Now.AddDays(-30), DateTime.Now)
.SelectRaw("COUNT(*) as TotalActivities")
.SelectRaw("COUNT(CASE WHEN ActivityType = 'Purchase' THEN 1 END) as Purchases")
.SelectRaw("COUNT(CASE WHEN ActivityType = 'View' THEN 1 END) as Views")
.SelectRaw("SUM(CASE WHEN ActivityType = 'Purchase' THEN Amount ELSE 0 END) as TotalSpent")
.First();
}
性能优化建议
1. 使用合适的编译器
// 根据数据库类型选择最优编译器
var compiler = DatabaseType switch
{
"SqlServer" => new SqlServerCompiler(),
"MySQL" => new MySqlCompiler(),
"PostgreSQL" => new PostgresCompiler(),
"Oracle" => new OracleCompiler(),
"Firebird" => new FirebirdCompiler(),
_ => throw new NotSupportedException($"Unsupported database: {DatabaseType}")
};
2. 批量操作优化
// 批量插入
var users = new[]
{
new { Name = "John", Email = "john@example.com" },
new { Name = "Jane", Email = "jane@example.com" }
};
int affected = db.Query("Users").Insert(users);
// 批量更新
db.Query("Products")
.WhereIn("Id", productIds)
.Update(new { IsActive = false });
3. 查询缓存策略
// 使用内存缓存查询结果
var cacheKey = $"products_{category}_{page}";
var products = _cache.GetOrCreate(cacheKey, entry =>
{
entry.AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(5);
return db.Query("Products")
.Where("Category", category)
.Paginate(20, page);
});
与其他 ORM 的对比
| 特性 | SqlKata | Entity Framework | Dapper | NHibernate |
|---|---|---|---|---|
| 学习曲线 | ⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐ | ⭐⭐⭐⭐ |
| 性能 | ⭐⭐⭐⭐ | ⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐ |
| 灵活性 | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐⭐ |
| 跨数据库 | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐ | ⭐⭐⭐⭐ |
| 复杂查询 | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ | ⭐⭐ | ⭐⭐⭐ |
最佳实践指南
1. 项目结构组织
src/
├── Application/
│ ├── Queries/ # 查询对象
│ ├── Repositories/ # 仓储接口
│ └── Services/ # 业务服务
├── Infrastructure/
│ ├── Repositories/ # 仓储实现
│ └── SqlKata/ # SqlKata 扩展
└── Domain/
└── Models/ # 领域模型
2. 查询封装模式
public interface IProductQueryBuilder
{
IProductQueryBuilder WithCategory(string category);
IProductQueryBuilder WithPriceRange(decimal? minPrice, decimal? maxPrice);
IProductQueryBuilder WithSorting(string sortBy);
Query Build();
}
public class ProductQueryBuilder : IProductQueryBuilder
{
private Query _query;
public ProductQueryBuilder()
{
_query = new Query("Products").Where("IsActive", true);
}
public IProductQueryBuilder WithCategory(string category)
{
if (!string.IsNullOrEmpty(category))
_query = _query.Where("Category", category);
return this;
}
public Query Build() => _query;
}
3. 单元测试策略
[Test]
public void Should_Build_Correct_Product_Query()
{
// Arrange
var builder = new ProductQueryBuilder()
.WithCategory("Electronics")
.WithPriceRange(100, 1000);
// Act
var query = builder.Build();
var sql = compiler.Compile(query).Sql;
// Assert
Assert.That(sql, Contains.Substring("[Category] = @p0"));
Assert.That(sql, Contains.Substring("[Price] >= @p1"));
Assert.That(sql, Contains.Substring("[Price] <= @p2"));
}
常见问题解答
Q: SqlKata 支持存储过程吗？
A: 是的，通过 FromSql 方法可以执行原始 SQL 和存储过程。
Q: 如何处理数据库迁移？
A: SqlKata 专注于查询构建，建议使用专门的迁移工具（如 FluentMigrator）处理数据库结构变更。
Q: 是否支持异步操作？
A: 是的，SqlKata.Execution 提供了完整的异步 API 支持。
Q: 如何自定义编译器？
A: 继承 Compiler 基类并实现特定数据库的编译逻辑即可。
总结
SqlKata Query Builder 为 .NET 开发者提供了一个强大、灵活且安全的 SQL 查询构建解决方案。无论你是构建简单的 CRUD 应用还是复杂的企业级系统，SqlKata 都能提供卓越的开发体验和性能表现。
主要优势总结：
- ✅ 彻底消除 SQL 注入风险
- ✅ 一套 API 支持多种数据库
- ✅ 流畅的链式调用语法
- ✅ 卓越的性能表现
- ✅ 丰富的功能集
- ✅ 活跃的社区支持
立即开始使用 SqlKata，体验现代化数据库操作的最佳实践！
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
