Apq
/
Apq.Cfg
mirror of https://gitee.com/apq/Apq.Cfg.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507
							<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Class CfgRootValidationExtensions | Apq.Cfg API </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Class CfgRootValidationExtensions | Apq.Cfg API ">
      
      <meta name="description" content="ICfgRoot 验证扩展方法">
      <link rel="icon" href="../favicon.svg">
      <link rel="stylesheet" href="../public/docfx.min.css">
      <link rel="stylesheet" href="../public/main.css">
      <meta name="docfx:navrel" content="../toc.html">
      <meta name="docfx:tocrel" content="toc.html">
      
      <meta name="docfx:rel" content="../">
      
      
      <meta name="loc:inThisArticle" content="In this article">
      <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
      <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
      <meta name="loc:tocFilter" content="Filter by title">
      <meta name="loc:nextArticle" content="Next">
      <meta name="loc:prevArticle" content="Previous">
      <meta name="loc:themeLight" content="Light">
      <meta name="loc:themeDark" content="Dark">
      <meta name="loc:themeAuto" content="Auto">
      <meta name="loc:changeTheme" content="Change theme">
      <meta name="loc:copy" content="Copy">
      <meta name="loc:downloadPdf" content="Download PDF">

      <script type="module" src="./../public/docfx.min.js"></script>

      <script>
        const theme = localStorage.getItem('theme') || 'auto'
        document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
      </script>

  </head>

  <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
    <header class="bg-body border-bottom">
      <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
        <div class="container-xxl flex-nowrap">
          <a class="navbar-brand" href="../index.html">
            <img id="logo" class="svg" src="../images/logo-small.svg" alt="Apq.Cfg">
            Apq.Cfg
          </a>
          <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
            <i class="bi bi-three-dots"></i>
          </button>
          <div class="collapse navbar-collapse" id="navpanel">
            <div id="navbar">
              <form class="search" role="search" id="search">
                <i class="bi bi-search"></i>
                <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
              </form>
            </div>
          </div>
        </div>
      </nav>
    </header>

    <main class="container-xxl">
      <div class="toc-offcanvas">
        <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
          <div class="offcanvas-header">
            <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
            <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
          </div>
          <div class="offcanvas-body">
            <nav class="toc" id="toc"></nav>
          </div>
        </div>
      </div>

      <div class="content">
        <div class="actionbar">
          <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
            <i class="bi bi-list"></i>
          </button>

          <nav id="breadcrumb"></nav>
        </div>

        <article data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions">


  <h1 id="Apq_Cfg_Validation_CfgRootValidationExtensions" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions" class="text-break">
Class CfgRootValidationExtensions  
  </h1>

  <div class="facts text-secondary">
    <dl><dt>Namespace</dt><dd><a class="xref" href="Apq.html">Apq</a>.<a class="xref" href="Apq.Cfg.html">Cfg</a>.<a class="xref" href="Apq.Cfg.Validation.html">Validation</a></dd></dl>
  <dl><dt>Assembly</dt><dd>Apq.Cfg.dll</dd></dl>
  </div>

  <div class="markdown summary"><p>ICfgRoot 验证扩展方法</p>
</div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static class CfgRootValidationExtensions</code></pre>
  </div>


  <dl class="typelist inheritance">
    <dt>Inheritance</dt>
    <dd>
      <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
      <div><span class="xref">CfgRootValidationExtensions</span></div>
    </dd>
  </dl>


  <dl class="typelist inheritedMembers">
    <dt>Inherited Members</dt>
    <dd>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
    </div>
  </dd></dl>


  <h2 class="section" id="methods">Methods
</h2>


  <a id="Apq_Cfg_Validation_CfgRootValidationExtensions_TryValidate_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.TryValidate*"></a>

  <h3 id="Apq_Cfg_Validation_CfgRootValidationExtensions_TryValidate_Apq_Cfg_ICfgRoot_Apq_Cfg_Validation_IConfigValidator_Apq_Cfg_Validation_ValidationResult__" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.TryValidate(Apq.Cfg.ICfgRoot,Apq.Cfg.Validation.IConfigValidator,Apq.Cfg.Validation.ValidationResult@)">
  TryValidate(ICfgRoot, IConfigValidator, out ValidationResult)
  
  </h3>

  <div class="markdown level1 summary"><p>尝试验证配置</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static bool TryValidate(this ICfgRoot cfg, IConfigValidator validator, out ValidationResult result)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>cfg</code> <a class="xref" href="Apq.Cfg.ICfgRoot.html">ICfgRoot</a></dt>
    <dd><p>配置根</p>
</dd>
    <dt><code>validator</code> <a class="xref" href="Apq.Cfg.Validation.IConfigValidator.html">IConfigValidator</a></dt>
    <dd><p>验证器</p>
</dd>
    <dt><code>result</code> <a class="xref" href="Apq.Cfg.Validation.ValidationResult.html">ValidationResult</a></dt>
    <dd><p>验证结果</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p>验证是否通过</p>
</dd>
  </dl>


  <h4 class="section" id="Apq_Cfg_Validation_CfgRootValidationExtensions_TryValidate_Apq_Cfg_ICfgRoot_Apq_Cfg_Validation_IConfigValidator_Apq_Cfg_Validation_ValidationResult___examples">Examples</h4>
  <pre><code class="lang-csharp">if (cfg.TryValidate(validator, out var result))
{
    Console.WriteLine("配置验证通过");
}
else
{
    Console.WriteLine($"配置验证失败，共 {result.ErrorCount} 个错误");
}</code></pre>


  <a id="Apq_Cfg_Validation_CfgRootValidationExtensions_TryValidate_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.TryValidate*"></a>

  <h3 id="Apq_Cfg_Validation_CfgRootValidationExtensions_TryValidate_Apq_Cfg_ICfgRoot_System_Action_Apq_Cfg_Validation_ConfigValidationBuilder__Apq_Cfg_Validation_ValidationResult__" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.TryValidate(Apq.Cfg.ICfgRoot,System.Action{Apq.Cfg.Validation.ConfigValidationBuilder},Apq.Cfg.Validation.ValidationResult@)">
  TryValidate(ICfgRoot, Action&lt;ConfigValidationBuilder&gt;, out ValidationResult)
  
  </h3>

  <div class="markdown level1 summary"><p>尝试验证配置</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static bool TryValidate(this ICfgRoot cfg, Action&lt;ConfigValidationBuilder&gt; configure, out ValidationResult result)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>cfg</code> <a class="xref" href="Apq.Cfg.ICfgRoot.html">ICfgRoot</a></dt>
    <dd><p>配置根</p>
</dd>
    <dt><code>configure</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="Apq.Cfg.Validation.ConfigValidationBuilder.html">ConfigValidationBuilder</a>&gt;</dt>
    <dd><p>验证规则配置委托</p>
</dd>
    <dt><code>result</code> <a class="xref" href="Apq.Cfg.Validation.ValidationResult.html">ValidationResult</a></dt>
    <dd><p>验证结果</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p>验证是否通过</p>
</dd>
  </dl>


  <h4 class="section" id="Apq_Cfg_Validation_CfgRootValidationExtensions_TryValidate_Apq_Cfg_ICfgRoot_System_Action_Apq_Cfg_Validation_ConfigValidationBuilder__Apq_Cfg_Validation_ValidationResult___examples">Examples</h4>
  <pre><code class="lang-csharp">if (cfg.TryValidate(v =&gt; v.Required("Database:ConnectionString"), out var result))
{
    Console.WriteLine("配置验证通过");
}
else
{
    Console.WriteLine($"配置验证失败，共 {result.ErrorCount} 个错误");
}</code></pre>


  <a id="Apq_Cfg_Validation_CfgRootValidationExtensions_Validate_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.Validate*"></a>

  <h3 id="Apq_Cfg_Validation_CfgRootValidationExtensions_Validate_Apq_Cfg_ICfgRoot_Apq_Cfg_Validation_IConfigValidator_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.Validate(Apq.Cfg.ICfgRoot,Apq.Cfg.Validation.IConfigValidator)">
  Validate(ICfgRoot, IConfigValidator)
  
  </h3>

  <div class="markdown level1 summary"><p>使用指定的验证器验证配置</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static ValidationResult Validate(this ICfgRoot cfg, IConfigValidator validator)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>cfg</code> <a class="xref" href="Apq.Cfg.ICfgRoot.html">ICfgRoot</a></dt>
    <dd><p>配置根</p>
</dd>
    <dt><code>validator</code> <a class="xref" href="Apq.Cfg.Validation.IConfigValidator.html">IConfigValidator</a></dt>
    <dd><p>验证器</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Apq.Cfg.Validation.ValidationResult.html">ValidationResult</a></dt>
    <dd><p>验证结果</p>
</dd>
  </dl>


  <h4 class="section" id="Apq_Cfg_Validation_CfgRootValidationExtensions_Validate_Apq_Cfg_ICfgRoot_Apq_Cfg_Validation_IConfigValidator__examples">Examples</h4>
  <pre><code class="lang-csharp">var validator = new ConfigValidationBuilder()
    .Required("Database:ConnectionString")
    .Range("Database:Port", 1, 65535)
    .Build();

var result = cfg.Validate(validator);
if (!result.IsValid)
{
    foreach (var error in result.Errors)
    {
        Console.WriteLine($"配置错误: {error}");
    }
}</code></pre>


  <a id="Apq_Cfg_Validation_CfgRootValidationExtensions_Validate_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.Validate*"></a>

  <h3 id="Apq_Cfg_Validation_CfgRootValidationExtensions_Validate_Apq_Cfg_ICfgRoot_System_Action_Apq_Cfg_Validation_ConfigValidationBuilder__" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.Validate(Apq.Cfg.ICfgRoot,System.Action{Apq.Cfg.Validation.ConfigValidationBuilder})">
  Validate(ICfgRoot, Action&lt;ConfigValidationBuilder&gt;)
  
  </h3>

  <div class="markdown level1 summary"><p>使用配置委托验证配置</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static ValidationResult Validate(this ICfgRoot cfg, Action&lt;ConfigValidationBuilder&gt; configure)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>cfg</code> <a class="xref" href="Apq.Cfg.ICfgRoot.html">ICfgRoot</a></dt>
    <dd><p>配置根</p>
</dd>
    <dt><code>configure</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="Apq.Cfg.Validation.ConfigValidationBuilder.html">ConfigValidationBuilder</a>&gt;</dt>
    <dd><p>验证规则配置委托</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Apq.Cfg.Validation.ValidationResult.html">ValidationResult</a></dt>
    <dd><p>验证结果</p>
</dd>
  </dl>


  <h4 class="section" id="Apq_Cfg_Validation_CfgRootValidationExtensions_Validate_Apq_Cfg_ICfgRoot_System_Action_Apq_Cfg_Validation_ConfigValidationBuilder___examples">Examples</h4>
  <pre><code class="lang-csharp">var result = cfg.Validate(v =&gt; v
    .Required("Database:ConnectionString")
    .Range("Database:Port", 1, 65535)
    .Regex("App:Email", @"^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$"));

if (!result.IsValid)
{
    foreach (var error in result.Errors)
    {
        Console.WriteLine($"配置错误: {error}");
    }
}</code></pre>


  <a id="Apq_Cfg_Validation_CfgRootValidationExtensions_ValidateAndThrow_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.ValidateAndThrow*"></a>

  <h3 id="Apq_Cfg_Validation_CfgRootValidationExtensions_ValidateAndThrow_Apq_Cfg_ICfgRoot_Apq_Cfg_Validation_IConfigValidator_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.ValidateAndThrow(Apq.Cfg.ICfgRoot,Apq.Cfg.Validation.IConfigValidator)">
  ValidateAndThrow(ICfgRoot, IConfigValidator)
  
  </h3>

  <div class="markdown level1 summary"><p>验证配置并在失败时抛出异常</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static void ValidateAndThrow(this ICfgRoot cfg, IConfigValidator validator)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>cfg</code> <a class="xref" href="Apq.Cfg.ICfgRoot.html">ICfgRoot</a></dt>
    <dd><p>配置根</p>
</dd>
    <dt><code>validator</code> <a class="xref" href="Apq.Cfg.Validation.IConfigValidator.html">IConfigValidator</a></dt>
    <dd><p>验证器</p>
</dd>
  </dl>


  <h4 class="section" id="Apq_Cfg_Validation_CfgRootValidationExtensions_ValidateAndThrow_Apq_Cfg_ICfgRoot_Apq_Cfg_Validation_IConfigValidator__examples">Examples</h4>
  <pre><code class="lang-csharp">try
{
    cfg.ValidateAndThrow(validator);
}
catch (ConfigValidationException ex)
{
    Console.WriteLine($"配置验证失败: {ex.Message}");
}</code></pre>


  <h4 class="section">Exceptions</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Apq.Cfg.Validation.ConfigValidationException.html">ConfigValidationException</a></dt>
    <dd><p>验证失败时抛出</p>
</dd>
  </dl>


  <a id="Apq_Cfg_Validation_CfgRootValidationExtensions_ValidateAndThrow_" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.ValidateAndThrow*"></a>

  <h3 id="Apq_Cfg_Validation_CfgRootValidationExtensions_ValidateAndThrow_Apq_Cfg_ICfgRoot_System_Action_Apq_Cfg_Validation_ConfigValidationBuilder__" data-uid="Apq.Cfg.Validation.CfgRootValidationExtensions.ValidateAndThrow(Apq.Cfg.ICfgRoot,System.Action{Apq.Cfg.Validation.ConfigValidationBuilder})">
  ValidateAndThrow(ICfgRoot, Action&lt;ConfigValidationBuilder&gt;)
  
  </h3>

  <div class="markdown level1 summary"><p>验证配置并在失败时抛出异常</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static void ValidateAndThrow(this ICfgRoot cfg, Action&lt;ConfigValidationBuilder&gt; configure)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>cfg</code> <a class="xref" href="Apq.Cfg.ICfgRoot.html">ICfgRoot</a></dt>
    <dd><p>配置根</p>
</dd>
    <dt><code>configure</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="Apq.Cfg.Validation.ConfigValidationBuilder.html">ConfigValidationBuilder</a>&gt;</dt>
    <dd><p>验证规则配置委托</p>
</dd>
  </dl>


  <h4 class="section" id="Apq_Cfg_Validation_CfgRootValidationExtensions_ValidateAndThrow_Apq_Cfg_ICfgRoot_System_Action_Apq_Cfg_Validation_ConfigValidationBuilder___examples">Examples</h4>
  <pre><code class="lang-csharp">try
{
    cfg.ValidateAndThrow(v =&gt; v
        .Required("Database:ConnectionString")
        .Range("Database:Port", 1, 65535));
}
catch (ConfigValidationException ex)
{
    Console.WriteLine($"配置验证失败: {ex.Message}");
}</code></pre>


  <h4 class="section">Exceptions</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Apq.Cfg.Validation.ConfigValidationException.html">ConfigValidationException</a></dt>
    <dd><p>验证失败时抛出</p>
</dd>
  </dl>


</article>


      </div>

      <div class="affix">
        <nav id="affix"></nav>
      </div>
    </main>

    <div class="container-xxl search-results" id="search-results"></div>

    <footer class="border-top text-secondary">
      <div class="container-xxl">
        <div class="flex-fill">
          Apq.Cfg - .NET 统一配置组件库 (基于 .NET 10.0，兼容 .NET 8.0)
        </div>
      </div>
    </footer>
  </body>
</html>