mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
e40703c202
- 实现了 YAML 配置与 JSON Schema 的运行时校验功能 - 支持嵌套对象、对象数组、标量数组的递归校验 - 集成了 enum 和引用约束的深度校验机制 - 实现了 multipleOf、uniqueItems 等扩展约束规则 - 添加了跨表引用收集和校验能力 - 提供了异步和同步两种加载校验接口 - 支持 minContains/maxContains 数组匹配计数规则 - 实现了 minProperties/maxProperties 对象属性数量校验 - 集成了日期时间、邮箱、URI 等字符串格式校验 - 提供了详细的错误诊断信息和定位功能
52 lines
2.8 KiB
C#
52 lines
2.8 KiB
C#
namespace GFramework.Game.Config;
|
|
|
|
/// <summary>
|
|
/// 提供面向宿主的 YAML 文本校验入口，使保存前校验可以复用运行时同一套 schema 规则。
|
|
/// </summary>
|
|
public static class YamlConfigTextValidator
|
|
{
|
|
/// <summary>
|
|
/// 使用指定 schema 文件同步校验 YAML 文本。
|
|
/// </summary>
|
|
/// <param name="tableName">所属配置表名称。</param>
|
|
/// <param name="schemaPath">Schema 文件绝对路径。</param>
|
|
/// <param name="yamlPath">YAML 文件路径，仅用于诊断信息。</param>
|
|
/// <param name="yamlText">待校验的 YAML 文本。</param>
|
|
/// <exception cref="ArgumentException">当 <paramref name="tableName" /> 或 <paramref name="schemaPath" /> 为空白时抛出。</exception>
|
|
/// <exception cref="ArgumentNullException">当 <paramref name="yamlPath" /> 或 <paramref name="yamlText" /> 为 <see langword="null" /> 时抛出。</exception>
|
|
/// <exception cref="GFramework.Game.Abstractions.Config.ConfigLoadException">当 schema 文件不可用，或 YAML 内容与 schema 不匹配时抛出。</exception>
|
|
public static void Validate(
|
|
string tableName,
|
|
string schemaPath,
|
|
string yamlPath,
|
|
string yamlText)
|
|
{
|
|
var schema = YamlConfigSchemaValidator.Load(tableName, schemaPath);
|
|
YamlConfigSchemaValidator.Validate(tableName, schema, yamlPath, yamlText);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 使用指定 schema 文件异步校验 YAML 文本。
|
|
/// </summary>
|
|
/// <param name="tableName">所属配置表名称。</param>
|
|
/// <param name="schemaPath">Schema 文件绝对路径。</param>
|
|
/// <param name="yamlPath">YAML 文件路径，仅用于诊断信息。</param>
|
|
/// <param name="yamlText">待校验的 YAML 文本。</param>
|
|
/// <param name="cancellationToken">取消令牌。</param>
|
|
/// <returns>表示异步校验操作的任务。</returns>
|
|
/// <exception cref="ArgumentException">当 <paramref name="tableName" /> 或 <paramref name="schemaPath" /> 为空白时抛出。</exception>
|
|
/// <exception cref="ArgumentNullException">当 <paramref name="yamlPath" /> 或 <paramref name="yamlText" /> 为 <see langword="null" /> 时抛出。</exception>
|
|
/// <exception cref="GFramework.Game.Abstractions.Config.ConfigLoadException">当 schema 文件不可用，或 YAML 内容与 schema 不匹配时抛出。</exception>
|
|
public static async Task ValidateAsync(
|
|
string tableName,
|
|
string schemaPath,
|
|
string yamlPath,
|
|
string yamlText,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
var schema = await YamlConfigSchemaValidator.LoadAsync(tableName, schemaPath, cancellationToken)
|
|
.ConfigureAwait(false);
|
|
YamlConfigSchemaValidator.Validate(tableName, schema, yamlPath, yamlText);
|
|
}
|
|
}
|