ShadowSql.net之正确使用方式
ShadowSql是面向接口模块化可插拔可扩展的工具[*]ShadowSql不是全家桶
[*]不把所有功能都做一个项目里面就是为了大家不一次引用所有的nuget包
[*]大家可以先判断需要哪些功能,再引用对应的nuget包
[*]当然同时引用这6个nuget包也是可以的
一、相关项目简介
名称项目Nuget包依赖大小主要用途精简版ShadowSql.CoreShadowSql.Core无147K简洁高效拼接sql易用版ShadowSqlShadowSqlShadowSql.Core96K(+147K)泛型表操作、链式拼接sql表达式版ShadowSql.ExpressionsShadowSql.ExpressionsShadowSql.Core75K(+147K)表达式树操作、链式拼接sqlDDLShadow.DDLShadow.DDLShadowSql.Core15K(+147K)拼接CreateTable、表Schema支持DapperDapperDapper无240K执行sql、类型Mapping精简版扩展Dapper.Shadow.CoreShadowSql.Dapper.CoreShadowSql.Core和Dapper17K(+387K)执行ShadowSql.Core拼接的sql易用版扩展Dapper.ShadowShadowSql.DapperShadowSql.Dapper.Core、ShadowSql.Core、ShadowSql和Dapper35K(+500K)执行ShadowSql拼接的sql二、如果选型
[*]主要看个人或团队偏好
1. 偏好Lambda选表达式版
[*]表达式树是Lambda的影子,可以生成委托,但这里只解析表达式树
[*]表达式版提供类EF的查询体验
[*]表达式树会用到反射,性能上会有点损耗,对比带来的便利性完全是可以接受的
[*]如果使用参数查询并缓存sql复用,完全可以忽略这个性能损耗,甚至可以忽略整个拼写sql的性能消耗
[*]表达式版搭配Dapper.Shadow.Core或者直接搭配Dapper甚至ADO.NET使用
1.1 EFCore示例
[*]ShadowSql不含EFCore的功能,这个示例是为了和表达式版对比
var query = context.Set<User>("Users")
.Where(u => u.Status)
.Take(10)
.Skip(20)
.OrderByDescending(u => u.Id)
.Select(u => new { u.Id, u.Name });1.2 表达式版示例
[*]表达式版可以写出与EFCore类似的代码
var select = db.From("Users")
.ToSqlQuery<User>()
.Where(u => u.Status)
.Take(10)
.Skip(20)
.Desc(u => u.Id)
.ToSelect()
.Select(u => new { u.Id, u.Name });1.3 表达式版参数化查询示例
var select = db.From("Users")
.ToSqlQuery<User>()
.Where<UserParameter>((u, p) => u.Id == p.Id2 && u.Status)
.Take(10)
.Skip(20)
.Desc(u => u.Id)
.ToSelect()
.Select(u => new { u.Id, u.Name });
// MsSql生成sql: SELECT , FROM WHERE =@Id2 AND =1 ORDER BY DESC OFFSET 20 ROWS FETCH NEXT 10 ROWS ONLY1.4 表达式版更多功能
[*]参看表达式版简介
2. 偏好链式查询选易用版
[*]易用版支持泛型表操作几乎无性能损耗(对比精简版)
[*]每个模型类最好定义数据表影子类(联表定义别名表),以便做到sql编译检测
[*]不定义数据表影子类可以用按字段查询或严格查询
[*]ShadowSql搭配Dapper.Shadow或Dapper.Shadow.Core或直接搭配Dapper甚至ADO.NET使用
2.1 易用版示例
var select = new UserTable()
.ToSqlQuery()
.Where(table => table.Status.EqualValue(true))
.Take(10, 20)
.Asc(table => table.Id)
.ToSelect()
.Select(table => );
// MsSql生成sql: SELECT , FROM WHERE =@Id2 AND =1 ORDER BY DESC OFFSET 20 ROWS FETCH NEXT 10 ROWS ONLY2.2 易用版更多功能
[*]参看易用版版简介
3. 有“洁癖”选精简版
[*]使用精简版也可以定义数据表影子类(联表定义别名表)
[*]查询时使用列或者数据表的列,这样代码可读性高,也可以做到sql编译检测
[*]ShadowSql.Core搭配Dapper.Shadow.Core或者直接搭配Dapper甚至ADO.NET使用
3.1 精简版示例
var table = new UserTable();
var query = new TableSqlQuery(table)
.Where(table.Status.EqualValue(true));
var cursor = new TableCursor(query)
.Take(10)
.Skip(20)
.Asc(table.Id);
var select = new CursorSelect(cursor)
.Select(table.Id, table.Name);3.2 易用版更多功能
[*]参看易用版简介
4. 需要CreateTable或表Schema的选DDL
[*]DDL可以搭配易用版或表达式版
[*]参看DDL简介
4.1 CreateTable
ColumnSchema id = new("Id", "INTEGER") { ColumnType = ColumnType.Identity | ColumnType.Key };
ColumnSchema name = new("Name", "TEXT");
TableSchema table = new("Students", );
CreateTable create = new(table);
// Sqlite生成sql: CREATE TABLE "Students"("Id" INTEGER PRIMARY KEY AUTOINCREMENT,"Name" TEXT)4.2 表Schema查询示例
UserTable table = new("Users", "tenant1");
var query = new TableQuery(table)
.And(table.Status.EqualValue(true));
var cursor = new TableCursor(query, 10, 20)
.Desc(table.Id);
var select = new CursorSelect(cursor)
.Select(table.Id, table.Name);
// MsSql生成sql: SELECT , FROM . WHERE =1 ORDER BY DESC OFFSET 20 ROWS FETCH NEXT 10 ROWS ONLYpublic class UserTable(string tableName = "Users", string schema = "")
: TableSchema(tableName, , schema)
{
#region Columns
public readonly ColumnSchema Id = Defines.Id;
new public readonly ColumnSchema Name= Defines.Name;
public readonly ColumnSchema Status = Defines.Status;
#endregion
class Defines
{
public static readonly ColumnSchema Id = new("Id") { ColumnType = ColumnType.Key };
public static readonly ColumnSchema Name = new("Name");
public static readonly ColumnSchema Status = new("Status");
}
}4.3 DDL+表达式版查询示例
var select = new TableSchema("Users", [], "tenant1")
.ToSqlQuery<User>()
.Where(u => u.Status)
.Take(10, 20)
.Desc(u => u.Id)
.ToSelect();
// MsSql生成sql: SELECT * FROM . WHERE =1 ORDER BY DESC OFFSET 20 ROWS FETCH NEXT 10 ROWS ONLY5. 易用版和表达式版一般不一起使用
[*]易用版和表达式版有同名类和方法,在不同命名空间
[*]同一个类引用命名空间ShadowSql和ShadowSql.Expressions调用某些方法会报不明确引用错误
[*]同一项目一个类用易用版,另一个类用表达式版是可行的
我们可以把ShadowSql当做乐高玩具一样看待,通过自己的组装可以实现意想不到的美妙效果
源码托管地址: https://github.com/donetsoftwork/Shadow ,也欢迎大家直接查看源码。
gitee同步更新:https://gitee.com/donetsoftwork/Shadow
文档地址: https://donetsoftwork.github.io/Shadow/expression/index.html
如果大家喜欢请动动您发财的小手手帮忙点一下Star。
来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
页:
[1]