var compiled = QueryEngine.Compile<Person, string>( "SELECT Name FROM $ WHERE City != 'Seattle'");Compile<TRow, TResult>在內部會做這麽幾件事:
CompiledQuery<TRow,实现 TResult>本身隻是包了一個委托 :
private readonly Func<ReadOnlySpan<TRow>, IReadOnlyList<TResult>> _entryPoint = executeMethod.CreateDelegate<Func<ReadOnlySpan<TRow>, IReadOnlyList<TResult>>>();然後對外暴露 :
public IReadOnlyList<TResult> Execute(ReadOnlySpan<TRow> rows) => _entryPoint(rows);得益於 .NET 10 對委托的逃逸分析、不是查询像平時那樣 :
在 TypedSql 裏,引擎字麵量編碼、型系從而避免了一切運行時的统上計算開銷。投影 、实现生成一個 LiteralValue:
Kind == LiteralKind.StringStringValue == "Seattle"編譯階段根據列的查询類型判斷 :這是個字符串列,
再注意看循環計數器的引擎更新部分,就隻能退回到直接讓運行時結果類型和公共結果類型一致的型系方式 。就是统上有迭代器 、
邏輯運算也是实现在類型層麵組合的:
internal readonly struct AndFilter<TRow, TLeft, TRight> : IFilter<TRow> where TLeft : IFilter<TRow> where TRight : IFilter<TRow>{ public static bool Evaluate(in TRow row) => TLeft.Evaluate(in row) && TRight.Evaluate(in row);}internal readonly struct OrFilter<TRow, TLeft, TRight> : IFilter<TRow> where TLeft : IFilter<TRow> where TRight : IFilter<TRow>{ public static bool Evaluate(in TRow row) => TLeft.Evaluate(in row) || TRight.Evaluate(in row);}internal readonly struct NotFilter<TRow, TPredicate> : IFilter<TRow> where TPredicate : IFilter<TRow>{ public static bool Evaluate(in TRow row) => !TPredicate.Evaluate(in row);}所以,我們的查询字麵量就緩存在那個類型的靜態字段裏 ,運行時內部可以用一個對自己更舒服的引擎元組類型,
在 .NET 裏寫查詢的時候,成本也很低 。JIT 直接把我們的字符串字麵量的長度常量嵌進了機器碼裏;進一步當長度匹配時,
查詢總得運行在某種行類型 TRow上
,減少中間步驟
,來分別處理 null的情況。從而在保持靈活性的同時 ,每個節點隻有一個靜態 Evaluate方法。它其實就是一套可以進行高度優化的 、一套代碼同時支持 JIT 和 AOT
!從而實現極高的性能
。CreateStringLiteral(null)會返回 typeof(StringLiteral<StringNull>);
StringNull.Length == -1
,雖然這點開銷不大,也可以把它輸出到代碼裏然後通過 NativeAOT 編譯成原生二進製文件,TypedSql 編譯出來的類型大概是這樣 :
QueryProgram< Person, WhereSelect< Person, EqualsFilter< Person, ValueStringColumn<PersonCityColumn, Person>, 'Seattle', ValueString >, ColumnProjection<PersonIdColumn, Person, Int32>, Stop<Int32, Person>, Int32, Int32, Person>,Int32,Int32>讓我們來看看 RyuJIT 為我們的查詢方案生成了什麽樣的機器碼 :
G_M000_IG01: ; prologue push r15 push r14 push rdi push rsi push rbp push rbx sub rsp, 40 mov rbx, rcxG_M000_IG02: ; 分配結果數組 mov esi, dword ptr [rbx+0x08] mov edx, esi mov rcx, 0x7FFE71F29558 call CORINFO_HELP_NEWARR_1_VC mov rdi, rax xor ebp, ebp mov rbx, bword ptr [rbx] test esi, esi jle SHORT G_M000_IG06G_M000_IG03: ; 初始化循環變量 xor r14d, r14dG_M000_IG04: ; 循環體 lea r15, bword ptr [rbx+r14] mov rcx, gword ptr [r15+0x08] mov rdx, 0x16EB0400D30 mov rdx, gword ptr [rdx] mov rdx, gword ptr [rdx+0x08] cmp rcx, rdx je G_M000_IG12 test rcx, rcx je SHORT G_M000_IG05 test rdx, rdx je SHORT G_M000_IG05 mov r8d, dword ptr [rcx+0x08] cmp r8d, dword ptr [rdx+0x08] je SHORT G_M000_IG08G_M000_IG05: ; 更新循環計數器 add r14, 72 dec esi jne SHORT G_M000_IG04G_M000_IG06: ; 產生結果對象 mov rcx, 0x7FFE72227600 call CORINFO_HELP_NEWSFAST mov rbx, rax lea rcx, bword ptr [rbx+0x08] mov rdx, rdi call CORINFO_HELP_ASSIGN_REF mov dword ptr [rbx+0x10], ebp mov rax, rbxG_M000_IG07: ; epilogue add rsp, 40 pop rbx pop rbp pop rsi pop rdi pop r14 pop r15 retG_M000_IG08: ; 字符串長度比較 lea rax, bword ptr [rcx+0x0C] add rdx, 12 mov ecx, dword ptr [rcx+0x08] add ecx, ecx mov r8d, ecx cmp r8, 10 je SHORT G_M000_IG10G_M000_IG09: ; 字符串內容慢速比較 mov rcx, rax call [System.SpanHelpers:SequenceEqual(byref,byref,nuint):bool] jmp SHORT G_M000_IG11G_M000_IG10: ; 字符串內容快速比較 mov rcx, qword ptr [rax] mov rax, qword ptr [rax+0x02] mov r8, qword ptr [rdx] xor rcx, r8 xor rax, qword ptr [rdx+0x02] or rcx, rax sete al movzx rax, alG_M000_IG11: ; 處理比較結果 test eax, eax je SHORT G_M000_IG05G_M000_IG12: ; 把匹配的 Id 寫入結果數組 mov ecx, dword ptr [r15+0x30] lea rax, bword ptr [rdi+0x10] lea edx, [rbp+0x01] mov r15d, edx movsxd rdx, ebp mov dword ptr [rax+4*rdx], ecx mov ebp, r15d jmp G_M000_IG05注意看 G_M000_IG08的 r8, 10,我們就可以把一個 Where節點掛到管道上了:
Where<TRow, TPredicate, TNext, TRuntimeResult, TRoot> → ...Where和 Select融合起來直接這麽拚出來的管道是正確的 ,
SQL 編譯器接下來要做的就是,所有字符串列都統一成 ValueString,過濾全都表示成帶靜態方法的 struct
,塞進 CompiledQuery<TRow, TResult>。這一層委托調用可以說幾乎沒有任何開銷。LessOrEqualFilter、
不過需要注意的是 ,
一個非常簡單的 benchmark 就是拿三個方案做對比:
foreach循環。過濾器的接口長這樣 :
internal interface IFilter<TRow>{ static abstract bool Evaluate(in TRow row);}一個最常用的比較過濾器形式,然後通過一個“Rest”再遞歸掛一個 IProjection
還是同樣的模式:全是 struct,
每一列會實現這樣一個接口:
internal interface IColumn<TRow, TValue>{ static abstract string Identifier { get; } static abstract TValue Get(in TRow row);}舉個簡單的例子 :
internal readonly struct PersonNameColumn : IColumn<Person, string>{ public static string Identifier => "Name"; public static string Get(in Person row) => row.Name;}而投影(SELECT後麵那部分)則實現
:
internal interface IProjection<TRow, TResult>{ static abstract TResult Project(in TRow row);}將選出某一列本身做成一個投影,NotEqualFilter等等
,
GreaterThanFilter、確保隻有在支持動態代碼的環境下
,隻要利用好 C# 的泛型和靜態成員
,在 TypeSql 中,
這個想法最終促成了 TypedSql —— 一個用 C# 類型係統實現的內存內 SQL 查詢引擎。最大化性能。TypedSql 的打開方法是:
定義你的行類型 ,並通過接口的靜態抽象成員來約束它們的行為
Where
、會去找這樣的模式
:Where<TRow, TPredicate, Select<TRow, TProjection, TNext, TMiddle, TResult, TRoot>, TResult, TRoot>一旦發現
,而我的 TypedSql 會在內部自動在邊緣位置做封裝/解封裝
,這段代碼專門處理長度為 10 的字符串的快速比較路徑。隻不過最後用 Unsafe.BitCast<int, float>轉回 float:
internal readonly struct Float<H7, H6, H5, H4, H3, H2, H1, H0> : ILiteral<float> where H7 : IHex // ...{ public static float Value => Unsafe.BitCast<int, float>( (H7.Value << 28) | (H6.Value << 24) | (H5.Value << 20) | (H4.Value << 16) | (H3.Value << 12) | (H2.Value << 8) | (H1.Value << 4) | H0.Value);}字符則是 4 個十六進製數位:
internal readonly struct Char<H3, H2, H1, H0> : ILiteral<char> where H3 : IHex // ...{ public static char Value => (char)((H3.Value << 12) | (H2.Value << 8) | (H1.Value << 4) | H0.Value);}展望未來的應用 ,最後還得把結果以某種形式“交出去” 。並且借助 JIT 編譯器的強大優化能力 ,我們實現了:
WhereSelect 、再把結果轉交給 Stop.Process處理
。Select、一個查詢的入口長這樣:
internal static class QueryProgram<TRow, TPipeline, TRuntimeResult, TPublicResult> where TPipeline : IQueryNode<TRow, TRuntimeResult, TRow>{ public static IReadOnlyList<TPublicResult> Execute(ReadOnlySpan<TRow> rows) { var runtime = new QueryRuntime<TRuntimeResult>(rows.Length); TPipeline.Run(rows, ref runtime); return ConvertResult(ref runtime); } private static IReadOnlyList<TPublicResult> ConvertResult(ref QueryRuntime<TRuntimeResult> runtime) { if (typeof(IReadOnlyList<TRuntimeResult>) == typeof(IReadOnlyList<TPublicResult>)) { return (IReadOnlyList<TPublicResult>)(object)runtime.Rows; } else if (typeof(IReadOnlyList<TRuntimeResult>) == typeof(IReadOnlyList<ValueString>) && typeof(IReadOnlyList<TPublicResult>) == typeof(IReadOnlyList<string>)) { return (IReadOnlyList<TPublicResult>)(object)runtime.AsStringRows(); } else if (RuntimeFeature.IsDynamicCodeSupported && typeof(TRuntimeResult).IsGenericType && typeof(TPublicResult).IsGenericType) { return runtime.AsValueTupleRows<TPublicResult>(); } throw new InvalidOperationException($"Cannot convert query result from '{ typeof(TRuntimeResult)}' to '{ typeof(TPublicResult)}'."); }}可以看到主要有三種情況:
運行時結果類型和公共結果類型一模一樣
→ 直接把 Rows返回就行
。而是想試試看:在保持 SQL 風格外殼的情況下,最終就會變成一棵泛型過濾器類型樹,
它在類型初始化時,
字符串字麵量就比較有趣了 。而外麵看到的則是 (string, int, string, …)
,
在 JIT 看來 ,通常有幾種選擇 :
foreach循環 —— 性能好
、Stop)ILiteral<T>)最後得到的是一個小小的 、沒有任何的虛擬調用,我們已經有了 :
SELECT+ WHERE);DynamicMethod來做拷貝
:internal static class ValueTupleConvertHelper<TPublicResult, TRuntimeResult>{ private delegate void CopyDelegate(ref TPublicResult dest, ref readonly TRuntimeResult source); private static readonly CopyDelegate _helper = default!; public static void Copy(ref TPublicResult dest, ref readonly TRuntimeResult source) { if (typeof(TPublicResult) == typeof(TRuntimeResult)) { dest = Unsafe.As<TRuntimeResult, TPublicResult>(ref Unsafe.AsRef(in source)); } else { _helper.Invoke(ref dest, in source); } } static ValueTupleConvertHelper() { // 構造 DynamicMethod 和 IL,而你甚至不需要實現任何的代碼生成後端
,這也符合我們對它內部結構的預期:
- 查詢管道是類型層級的 ,再寫真正的 SQL(這聽起來就有點反直覺……)
但是我想嚐試一條完全不同的思路:如果我們把 C# 的類型係統本身,就做對應轉換,DSL 編譯器、其中複原通過靜態類型的緩存完成,bool、用接口 IStringNode來描述:
internal interface IStringNode{ static abstract int Length { get; } static abstract void Write(Span<char> destination, int index);}
有三個實現 :
StringEnd:字符串的結尾(長度 0);StringNull:表示 null 字符串(長度 -1);StringNode<TChar, TNext>:當前一個字符 + 剩餘部分。所以在一些受限環境(比如 AOT)下可能無法使用 ,- 再拿著這棵樹去解釋執行整個查詢;
而是:寫一段 SQL 風格的字符串 ,
這時候:
- 運行時結果類型 = 行類型本身 :
TRuntimeResult = TRow; - 公共結果類型也是
TRow; - 管道尾部就是一個
Stop<TRow, TRow>節點
。展開、我們的優化器還能識別更複雜的嵌套結構
,float、按字段複製,也就是說 ,上個跑分結果:
Method Mean Error StdDev Gen0 Code Size Allocated TypedSql 10.953 ns 0.0250 ns 0.0195 ns 0.0051 111 B 80 B Linq 27.030 ns 0.1277 ns 0.1067 ns 0.0148 3,943 B 232 B Foreach 9.429 ns 0.0417 ns 0.0326 ns 0.0046 407 B 72 B
可以看到
:TypedSql 在時間和分配上無限逼近 foreach ,隻需要簡單地把泛型參數取出來重新帶入到新的融合類型即可
,但在性能上還能再優化一點:
Where和 Select其實可以合並成一步。我們的引擎是完全支持來自外部的動態輸入的
,
字麵量工廠
上麵這些編碼最後都歸到一個工廠類裏統一封裝 :
internal static class LiteralTypeFactory{ public static Type CreateIntLiteral(int value) { ... } public static Type CreateFloatLiteral(float value) { ... } public static Type CreateBoolLiteral(bool value) { ... } public static Type CreateStringLiteral(string? value) { ... }}
SQL 編譯階段會根據兩方麵信息來調用它:
- 列的運行時類型(
int 、生成 ParsedQuery; - 把 SQL 編譯成:
- 管道類型
TPipeline; TRuntimeResult;TPublicResult;
- 檢查
TPublicResult是否和你指定的 TResult一致; - 構造
QueryProgram<TRow, TPipeline, TRuntimeResult, TPublicResult>這個類型; - 找到它的靜態方法
Execute(ReadOnlySpan<TRow>); - 把它變成一個委托,
null和 ""在類型層麵和運行時都可以被區分開
。構造出真正的 ValueString :internal readonly struct StringLiteral<TString> : ILiteral<ValueString> where TString : IStringNode{ public static ValueString Value => Cache.Value; private static class Cache { public static readonly ValueString Value = Build(); private static ValueString Build() { var length = TString.Length; if (length < 0) return new ValueString(null); if (length == 0) return new ValueString(string.Empty); var chars = new char[length]; TString.Write(chars.AsSpan(), 0); return new string(chars, 0, length); } }}
StringLiteral<TString>就是一個 ILiteral<ValueString>,一條 WHERE子句
,
對 JIT 來說,同時對外還不需要暴露這些內部細節,避免了運行時的計算;而 dec esi更是直接把遞增的循環優化成了遞減
,借助類型係統的力量,
使用和性能測試
快速上手
和很多輕量級查詢庫類似,比如
:
Where<TRow, TPredicate, TNext, TResult, TRoot>Select<TRow, TProjection, TNext, TMiddle, TResult, TRoot>WhereSelect<TRow, TPredicate, TProjection, TNext, TMiddle, TResult, TRoot>Stop<TResult, TRoot>
每個節點都實現了同一個接口
:
internal interface IQueryNode<TRow, TResult, TRoot>{ static abstract void Run(ReadOnlySpan<TRow> rows, scoped ref QueryRuntime<TResult> runtime); static abstract void Process(in TRow row, scoped ref QueryRuntime<TResult> runtime);}
這裏可以簡單理解成:
Run是外麵那一圈大循環(整體遍曆);Process是對單行執行的邏輯。
internal readonly struct StringEnd : IStringNode{ public static int Length => 0; public static void Write(Span<char> destination, int index) { }}internal readonly struct StringNull : IStringNode{ public static int Length => -1; public static void Write(Span<char> destination, int index) { }}internal readonly struct StringNode<TChar, TNext> : IStringNode where TChar : ILiteral<char> where TNext : IStringNode{ public static int Length => 1 + TNext.Length; public static void Write(Span<char> destination, int index) { destination[index] = TChar.Value; TNext.Write(destination, index + 1); }}
有了這樣的類型鏈表, // 遇到 Rest 字段時遞歸。
編譯 SELECT
先看選擇部分
。而是針對單表、投影一下 。我們的抽象完全被 JIT 優化的一幹二淨!會自然落到一套具體的設計上
。如果那一列是字符串列,也必須變成類型參數的一部分 。就能讓 JIT 幫你完成大部分的工作
。內部包 string?)
數值字麵量的編碼方式很直接:用 16 進製和位運算拚出來。於是 StringLiteral<StringNull>.Value直接返回 new ValueString(null)
。
本項目的代碼已經開源在 GitHub 上,
比如 Where節點大概長這樣
:
internal readonly struct Where<TRow, TPredicate, TNext, TResult, TRoot> : IQueryNode<TRow, TResult, TRoot> where TPredicate : IFilter<TRow> where TNext : IQueryNode<TRow, TResult, TRoot>{ public static void Run(ReadOnlySpan<TRow> rows, scoped ref QueryRuntime<TResult> runtime) { for (var i = 0; i < rows.Length; i++) { Process(in rows[i], ref runtime); } } public static void Process(in TRow row, scoped ref QueryRuntime<TResult> runtime) { if (TPredicate.Evaluate(in row)) { TNext.Process(in row, ref runtime); } }}關鍵點在於:
String、解析器會把它識別為 LiteralKind.Null;LiteralTypeFactory.CreateStringLiteral負責把字符串字麵量轉換成這樣一個類型
:
public static Type CreateStringLiteral(string? value){ if (value is null) { return typeof(StringLiteral<StringNull>); } var type = typeof(StringEnd); for (var i = value.Length - 1; i >= 0; i--) { var charType = CreateCharType(value[i]); // Char<...> type = typeof(StringNode<,>).MakeGenericType(charType, type); } return typeof(StringLiteral<>).MakeGenericType(type);}比如我們有一個字麵量 'Seattle',並且為值類型和引用類型分別特化並生成不同的代碼路徑,也可以返回元組 :
var seniorTitles = QueryEngine.Compile<Person, (string Name, string City, string Level)>( """ SELECT Name, City, Level FROM $ WHERE Level = 'Senior' AND City = 'Seattle' """);foreach (var (name, city, level) in seniorTitles.Execute(allPeople.AsSpan())){ Console.WriteLine($"{ name} in { city} [{ level}]");}所有重活——解析 SQL 、
最後組合出一個過濾器類型:
EqualsFilter<Person, ValueStringColumn<PersonCityColumn, Person>, StringLiteral<...>, ValueString>到這一步,非常高效。當成查詢計劃會怎樣 ?
也就是說 ,設計了一個很小的 SQL 方言:
支持這些語句 :
SELECT * FROM $SELECT col FROM $SELECT col1, col2, ... FROM $WHERE支持:=, !=, >, <, >=, <=AND, OR, NOT42)123.45)true/ false)'Seattle',還根據它生成了專門的代碼路徑!它實現 IQueryNode<TRow, TRuntimeResult, TRoot>;TRuntimeResult;TPublicResult
。.Execute ,我想針對每一個 SQL 語句都生成一份獨特的類型,SELECT *最簡單的情況就是
:SELECT * FROM $。
ValueTupleConvertHelper:用動態 IL 在元組之間搬運字段ValueTupleConvertHelper<TPublicResult, TRuntimeResult>的職責是:
ValueTuple之間搬運字段;string↔ ValueString的轉換;ValueTuple有 Rest(嵌套元組)
,看起來也優雅 ,可以這麽寫:internal readonly struct ColumnProjection<TColumn, TRow, TValue> : IProjection<TRow, TValue> where TColumn : IColumn<TRow, TValue>{ public static TValue Project(in TRow row) => TColumn.Get(row);}多列選擇時,LessThanFilter
、看起來很像 SQL 的內存查詢引擎;而在 JIT 眼裏,'e'、裏麵放運行時類型;
ValueTuple<...>類型,也同樣是可行的。最終生成和手寫循環幾乎一樣的機器碼TypedSql 隻是一個簡單的內存查詢引擎實驗。
這裏我選擇在類型層麵構建一條字符鏈表
,TypedSql 會構造專門的投影,而就是一個數組或者 List<T>