S0DimDefinition.cs 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. using System.Text.RegularExpressions;
  2. namespace Admin.NET.Plugin.AiDOP.DataPlatform.S0Dim;
  3. /// <summary>
  4. /// 一个 S0 主数据维度的完整声明:源表 → staging → dim 的全部映射与身份口径。
  5. ///
  6. /// 本类型是**唯一的业务知识落点**:<see cref="S0DimMaterializer"/> / <see cref="S0DimReconciler"/>
  7. /// 中不得出现任何 <c>if (key == "WORK_CENTER")</c> 之类的分支。
  8. /// </summary>
  9. /// <param name="Key">对外标识(refresh/{key}),大写下划线。</param>
  10. /// <param name="EntityCode"><c>mdp_entity.entity_code</c>。</param>
  11. /// <param name="SourceTable">源物理表名;同时是 staging 的 <c>source_table</c> 过滤值。</param>
  12. /// <param name="SourceSystem"><c>mdp_source.source_code</c>;同时是 staging 的 <c>source_system</c> 过滤值。</param>
  13. /// <param name="StagingTable">贴源表名(可被同模块多个 definition 共用,靠 SourceTable 区分)。</param>
  14. /// <param name="DimTable">维度表名。**必须由本 definition 独占**(FULL Replace 按 tenant 整体删除该表)。</param>
  15. /// <param name="BusinessKeyColumns">dim 侧业务键列,首列必须是 <c>tenant_id</c>。</param>
  16. /// <param name="SourceBizKeyColumns">源侧业务键**物理列**,须与 <c>mdp_entity.biz_key_expr</c> 逐字一致(不含 tenant)。</param>
  17. /// <param name="Columns">列映射。</param>
  18. /// <param name="MirrorUniqueColumns">额外唯一性断言(镜像源 UK,用于抗源侧索引口径变化)。</param>
  19. /// <param name="ParentDimTable">父维度表(子维度专用)。</param>
  20. /// <param name="ParentKeyColumns">父引用列(同时存在于本 dim 与父 dim)。</param>
  21. public sealed record S0DimDefinition(
  22. string Key,
  23. string EntityCode,
  24. string SourceTable,
  25. string SourceSystem,
  26. string StagingTable,
  27. string DimTable,
  28. IReadOnlyList<string> BusinessKeyColumns,
  29. IReadOnlyList<string> SourceBizKeyColumns,
  30. IReadOnlyList<S0DimColumn> Columns,
  31. IReadOnlyList<string>? MirrorUniqueColumns = null,
  32. string? ParentDimTable = null,
  33. IReadOnlyList<string>? ParentKeyColumns = null)
  34. {
  35. /// <summary>标识符白名单:表名 / 列名 / JsonPath 一律只允许字母数字下划线。</summary>
  36. // 用 \A…\z 而非 ^…$:.NET 的 $(无 Multiline)也匹配「字符串末尾的 \n 之前」,
  37. // 于是 "Domain\n" 能通过 ^…$。虽不可利用(产物是非法 JSON path / 不存在的表名,只会报错),
  38. // 但标识符白名单不该留任何可通过的畸形输入。
  39. internal static readonly Regex IdentifierRe = new(@"\A[A-Za-z0-9_]+\z", RegexOptions.Compiled);
  40. /// <summary>租户列名(dim 与 staging 两侧同名)。</summary>
  41. public const string TenantColumn = "tenant_id";
  42. /// <summary>
  43. /// 声明自洽性校验。
  44. ///
  45. /// <para><b>实际调用点(无启动期钩子,勿误读)</b>:
  46. /// <c>S0DimRefreshService.RefreshAsync / ReconcileAsync</c> 与控制器的 <c>catalog</c> 端点,
  47. /// 以及每个 SQL 生成入口(<c>BuildInsertSql</c> 等)自身。
  48. /// 本项目**没有**在 Startup 注册对 <c>S0DimCatalog.ValidateAll()</c> 的调用,
  49. /// 因此声明错误不会在应用启动时暴露,而是在**首次刷新时**暴露。</para>
  50. ///
  51. /// <para>安全性不受影响:校验在任何数据被触碰之前完成(purge / pull / 物化都在其后),
  52. /// 失败即整批 FAILED 且 DB 零写入。但「启动即 fail-fast」这个更强的保证目前并不存在。</para>
  53. /// </summary>
  54. public void Validate()
  55. {
  56. void Ident(string? v, string what)
  57. {
  58. if (string.IsNullOrWhiteSpace(v) || !IdentifierRe.IsMatch(v))
  59. throw new InvalidOperationException($"[{Key}] 非法标识符({what}):{v}");
  60. }
  61. Ident(Key, nameof(Key));
  62. Ident(EntityCode, nameof(EntityCode));
  63. Ident(SourceTable, nameof(SourceTable));
  64. Ident(SourceSystem, nameof(SourceSystem));
  65. Ident(StagingTable, nameof(StagingTable));
  66. Ident(DimTable, nameof(DimTable));
  67. if (Columns is null || Columns.Count == 0)
  68. throw new InvalidOperationException($"[{Key}] Columns 为空");
  69. var targets = new HashSet<string>(StringComparer.Ordinal);
  70. var tenantCols = 0;
  71. foreach (var c in Columns)
  72. {
  73. Ident(c.TargetColumn, "TargetColumn");
  74. if (!targets.Add(c.TargetColumn))
  75. throw new InvalidOperationException($"[{Key}] TargetColumn 重复:{c.TargetColumn}");
  76. if (c.Kind == S0DimValueKind.TenantIdColumn)
  77. {
  78. tenantCols++;
  79. if (c.JsonPath is not null)
  80. throw new InvalidOperationException($"[{Key}] TenantIdColumn 不得声明 JsonPath:{c.TargetColumn}");
  81. if (!string.Equals(c.TargetColumn, TenantColumn, StringComparison.Ordinal))
  82. throw new InvalidOperationException($"[{Key}] TenantIdColumn 的目标列必须是 {TenantColumn}");
  83. }
  84. else
  85. {
  86. // 🔴 这条是 F-16 的编译期护栏:JsonPath 必须显式给出,不允许由 TargetColumn 推导
  87. if (string.IsNullOrWhiteSpace(c.JsonPath))
  88. throw new InvalidOperationException(
  89. $"[{Key}] 列 {c.TargetColumn} 缺少 JsonPath —— raw_data 的键是源表物理列名,禁止由列名推导");
  90. Ident(c.JsonPath, "JsonPath");
  91. }
  92. if (c.Kind == S0DimValueKind.Dec && (c.Precision <= 0 || c.Scale < 0 || c.Scale > c.Precision))
  93. throw new InvalidOperationException($"[{Key}] 列 {c.TargetColumn} 的 DECIMAL 精度非法");
  94. }
  95. if (tenantCols != 1)
  96. throw new InvalidOperationException($"[{Key}] 必须且只能声明一个 TenantIdColumn,当前 {tenantCols} 个");
  97. if (BusinessKeyColumns is null || BusinessKeyColumns.Count < 2)
  98. throw new InvalidOperationException($"[{Key}] BusinessKeyColumns 至少需要 tenant_id + 1 列");
  99. if (!string.Equals(BusinessKeyColumns[0], TenantColumn, StringComparison.Ordinal))
  100. throw new InvalidOperationException($"[{Key}] BusinessKeyColumns 首列必须是 {TenantColumn}");
  101. foreach (var bk in BusinessKeyColumns)
  102. {
  103. if (!targets.Contains(bk))
  104. throw new InvalidOperationException($"[{Key}] 业务键列未在 Columns 中声明:{bk}");
  105. var col = Columns.First(x => x.TargetColumn == bk);
  106. if (col.Kind != S0DimValueKind.TenantIdColumn && !col.Required)
  107. throw new InvalidOperationException($"[{Key}] 业务键列必须 Required=true:{bk}");
  108. if (col.Kind is S0DimValueKind.BoolTrue or S0DimValueKind.Dec)
  109. throw new InvalidOperationException($"[{Key}] 业务键列不得为布尔/小数:{bk}");
  110. }
  111. if (SourceBizKeyColumns is null || SourceBizKeyColumns.Count != BusinessKeyColumns.Count - 1)
  112. throw new InvalidOperationException(
  113. $"[{Key}] SourceBizKeyColumns 必须与 BusinessKeyColumns(去掉 tenant_id)一一对应");
  114. foreach (var s in SourceBizKeyColumns) Ident(s, "SourceBizKeyColumns");
  115. // 源侧业务键物理列必须正是 dim 业务键列所映射的 JsonPath,且顺序一致 ——
  116. // 否则 stg.source_biz_key(由 mdp_entity.biz_key_expr 生成)与 dim 业务键无法对账
  117. for (var i = 1; i < BusinessKeyColumns.Count; i++)
  118. {
  119. var expected = Columns.First(x => x.TargetColumn == BusinessKeyColumns[i]).JsonPath;
  120. if (!string.Equals(expected, SourceBizKeyColumns[i - 1], StringComparison.Ordinal))
  121. throw new InvalidOperationException(
  122. $"[{Key}] 业务键顺序不一致:dim 列 {BusinessKeyColumns[i]} 映射 {expected}," +
  123. $"但 SourceBizKeyColumns[{i - 1}] = {SourceBizKeyColumns[i - 1]}");
  124. }
  125. if (MirrorUniqueColumns is { Count: > 0 })
  126. {
  127. foreach (var m in MirrorUniqueColumns)
  128. if (!targets.Contains(m))
  129. throw new InvalidOperationException($"[{Key}] MirrorUniqueColumns 未在 Columns 中声明:{m}");
  130. }
  131. if ((ParentDimTable is null) != (ParentKeyColumns is null or { Count: 0 }))
  132. throw new InvalidOperationException($"[{Key}] ParentDimTable 与 ParentKeyColumns 必须同时提供或同时省略");
  133. if (ParentDimTable is not null)
  134. {
  135. Ident(ParentDimTable, nameof(ParentDimTable));
  136. foreach (var p in ParentKeyColumns!)
  137. if (!targets.Contains(p))
  138. throw new InvalidOperationException($"[{Key}] ParentKeyColumns 未在 Columns 中声明:{p}");
  139. }
  140. }
  141. }