Apq.Cfg.CfgSourceLevels.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Class CfgSourceLevels | Apq.Cfg API </title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="title" content="Class CfgSourceLevels | Apq.Cfg API ">
  8. <meta name="description" content="配置源默认层级常量">
  9. <link rel="icon" href="../favicon.svg">
  10. <link rel="stylesheet" href="../public/docfx.min.css">
  11. <link rel="stylesheet" href="../public/main.css">
  12. <meta name="docfx:navrel" content="../toc.html">
  13. <meta name="docfx:tocrel" content="toc.html">
  14. <meta name="docfx:rel" content="../">
  15. <meta name="loc:inThisArticle" content="In this article">
  16. <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
  17. <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
  18. <meta name="loc:tocFilter" content="Filter by title">
  19. <meta name="loc:nextArticle" content="Next">
  20. <meta name="loc:prevArticle" content="Previous">
  21. <meta name="loc:themeLight" content="Light">
  22. <meta name="loc:themeDark" content="Dark">
  23. <meta name="loc:themeAuto" content="Auto">
  24. <meta name="loc:changeTheme" content="Change theme">
  25. <meta name="loc:copy" content="Copy">
  26. <meta name="loc:downloadPdf" content="Download PDF">
  27. <script type="module" src="./../public/docfx.min.js"></script>
  28. <script>
  29. const theme = localStorage.getItem('theme') || 'auto'
  30. document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
  31. </script>
  32. </head>
  33. <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
  34. <header class="bg-body border-bottom">
  35. <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
  36. <div class="container-xxl flex-nowrap">
  37. <a class="navbar-brand" href="../index.html">
  38. <img id="logo" class="svg" src="../images/logo-small.svg" alt="Apq.Cfg">
  39. Apq.Cfg
  40. </a>
  41. <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">
  42. <i class="bi bi-three-dots"></i>
  43. </button>
  44. <div class="collapse navbar-collapse" id="navpanel">
  45. <div id="navbar">
  46. <form class="search" role="search" id="search">
  47. <i class="bi bi-search"></i>
  48. <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
  49. </form>
  50. </div>
  51. </div>
  52. </div>
  53. </nav>
  54. </header>
  55. <main class="container-xxl">
  56. <div class="toc-offcanvas">
  57. <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
  58. <div class="offcanvas-header">
  59. <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
  60. <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
  61. </div>
  62. <div class="offcanvas-body">
  63. <nav class="toc" id="toc"></nav>
  64. </div>
  65. </div>
  66. </div>
  67. <div class="content">
  68. <div class="actionbar">
  69. <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">
  70. <i class="bi bi-list"></i>
  71. </button>
  72. <nav id="breadcrumb"></nav>
  73. </div>
  74. <article data-uid="Apq.Cfg.CfgSourceLevels">
  75. <h1 id="Apq_Cfg_CfgSourceLevels" data-uid="Apq.Cfg.CfgSourceLevels" class="text-break">
  76. Class CfgSourceLevels
  77. </h1>
  78. <div class="facts text-secondary">
  79. <dl><dt>Namespace</dt><dd><a class="xref" href="Apq.html">Apq</a>.<a class="xref" href="Apq.Cfg.html">Cfg</a></dd></dl>
  80. <dl><dt>Assembly</dt><dd>Apq.Cfg.dll</dd></dl>
  81. </div>
  82. <div class="markdown summary"><p>配置源默认层级常量</p>
  83. </div>
  84. <div class="markdown conceptual"></div>
  85. <div class="codewrapper">
  86. <pre><code class="lang-csharp hljs">public static class CfgSourceLevels</code></pre>
  87. </div>
  88. <dl class="typelist inheritance">
  89. <dt>Inheritance</dt>
  90. <dd>
  91. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  92. <div><span class="xref">CfgSourceLevels</span></div>
  93. </dd>
  94. </dl>
  95. <dl class="typelist inheritedMembers">
  96. <dt>Inherited Members</dt>
  97. <dd>
  98. <div>
  99. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  100. </div>
  101. <div>
  102. <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>
  103. </div>
  104. <div>
  105. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
  118. </div>
  119. </dd></dl>
  120. <h2 id="Apq_Cfg_CfgSourceLevels_remarks">Remarks</h2>
  121. <div class="markdown level0 remarks"><p>层级规划原则:数值越大优先级越高,高层级覆盖低层级</p>
  122. <p>
  123. | 层级范围 | 用途 | 配置源 |
  124. |----------|------|--------|
  125. | 0 | 基础配置文件 | Json, Ini, Xml, Yaml, Toml |
  126. | 100 | 远程存储 | Redis, Database |
  127. | 200 | 配置中心 | Consul, Etcd, Nacos, Apollo, Zookeeper |
  128. | 300 | 密钥管理 | Vault |
  129. | 400 | 环境相关 | .env, EnvironmentVariables(最高优先级覆盖) |
  130. </p>
  131. </div>
  132. <h2 class="section" id="fields">Fields
  133. </h2>
  134. <h3 id="Apq_Cfg_CfgSourceLevels_Apollo" data-uid="Apq.Cfg.CfgSourceLevels.Apollo">
  135. Apollo
  136. </h3>
  137. <div class="markdown level1 summary"><p>Apollo 配置中心默认层级 (200)</p>
  138. </div>
  139. <div class="markdown level1 conceptual"></div>
  140. <div class="codewrapper">
  141. <pre><code class="lang-csharp hljs">public const int Apollo = 200</code></pre>
  142. </div>
  143. <h4 class="section">Field Value</h4>
  144. <dl class="parameters">
  145. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  146. <dd></dd>
  147. </dl>
  148. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Apollo_remarks">Remarks</h4>
  149. <div class="markdown level1 remarks"><p>配置中心,优先级高于远程存储</p>
  150. </div>
  151. <h3 id="Apq_Cfg_CfgSourceLevels_Consul" data-uid="Apq.Cfg.CfgSourceLevels.Consul">
  152. Consul
  153. </h3>
  154. <div class="markdown level1 summary"><p>Consul 配置中心默认层级 (200)</p>
  155. </div>
  156. <div class="markdown level1 conceptual"></div>
  157. <div class="codewrapper">
  158. <pre><code class="lang-csharp hljs">public const int Consul = 200</code></pre>
  159. </div>
  160. <h4 class="section">Field Value</h4>
  161. <dl class="parameters">
  162. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  163. <dd></dd>
  164. </dl>
  165. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Consul_remarks">Remarks</h4>
  166. <div class="markdown level1 remarks"><p>配置中心,优先级高于远程存储</p>
  167. </div>
  168. <h3 id="Apq_Cfg_CfgSourceLevels_Database" data-uid="Apq.Cfg.CfgSourceLevels.Database">
  169. Database
  170. </h3>
  171. <div class="markdown level1 summary"><p>数据库配置源默认层级 (100)</p>
  172. </div>
  173. <div class="markdown level1 conceptual"></div>
  174. <div class="codewrapper">
  175. <pre><code class="lang-csharp hljs">public const int Database = 100</code></pre>
  176. </div>
  177. <h4 class="section">Field Value</h4>
  178. <dl class="parameters">
  179. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  180. <dd></dd>
  181. </dl>
  182. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Database_remarks">Remarks</h4>
  183. <div class="markdown level1 remarks"><p>远程存储配置源,优先级高于本地文件</p>
  184. </div>
  185. <h3 id="Apq_Cfg_CfgSourceLevels_Env" data-uid="Apq.Cfg.CfgSourceLevels.Env">
  186. Env
  187. </h3>
  188. <div class="markdown level1 summary"><p>.env 文件默认层级 (400)</p>
  189. </div>
  190. <div class="markdown level1 conceptual"></div>
  191. <div class="codewrapper">
  192. <pre><code class="lang-csharp hljs">public const int Env = 400</code></pre>
  193. </div>
  194. <h4 class="section">Field Value</h4>
  195. <dl class="parameters">
  196. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  197. <dd></dd>
  198. </dl>
  199. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Env_remarks">Remarks</h4>
  200. <div class="markdown level1 remarks"><p>.env 文件用于环境特定配置,与环境变量同级。
  201. 当 setEnvironmentVariables=true 时,.env 内容会写入系统环境变量。</p>
  202. </div>
  203. <h3 id="Apq_Cfg_CfgSourceLevels_EnvironmentVariables" data-uid="Apq.Cfg.CfgSourceLevels.EnvironmentVariables">
  204. EnvironmentVariables
  205. </h3>
  206. <div class="markdown level1 summary"><p>环境变量默认层级 (400)</p>
  207. </div>
  208. <div class="markdown level1 conceptual"></div>
  209. <div class="codewrapper">
  210. <pre><code class="lang-csharp hljs">public const int EnvironmentVariables = 400</code></pre>
  211. </div>
  212. <h4 class="section">Field Value</h4>
  213. <dl class="parameters">
  214. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  215. <dd></dd>
  216. </dl>
  217. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_EnvironmentVariables_remarks">Remarks</h4>
  218. <div class="markdown level1 remarks"><p>环境变量具有最高优先级,用于运行时覆盖</p>
  219. </div>
  220. <h3 id="Apq_Cfg_CfgSourceLevels_Etcd" data-uid="Apq.Cfg.CfgSourceLevels.Etcd">
  221. Etcd
  222. </h3>
  223. <div class="markdown level1 summary"><p>Etcd 配置中心默认层级 (200)</p>
  224. </div>
  225. <div class="markdown level1 conceptual"></div>
  226. <div class="codewrapper">
  227. <pre><code class="lang-csharp hljs">public const int Etcd = 200</code></pre>
  228. </div>
  229. <h4 class="section">Field Value</h4>
  230. <dl class="parameters">
  231. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  232. <dd></dd>
  233. </dl>
  234. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Etcd_remarks">Remarks</h4>
  235. <div class="markdown level1 remarks"><p>配置中心,优先级高于远程存储</p>
  236. </div>
  237. <h3 id="Apq_Cfg_CfgSourceLevels_Ini" data-uid="Apq.Cfg.CfgSourceLevels.Ini">
  238. Ini
  239. </h3>
  240. <div class="markdown level1 summary"><p>INI 文件默认层级 (0)</p>
  241. </div>
  242. <div class="markdown level1 conceptual"></div>
  243. <div class="codewrapper">
  244. <pre><code class="lang-csharp hljs">public const int Ini = 0</code></pre>
  245. </div>
  246. <h4 class="section">Field Value</h4>
  247. <dl class="parameters">
  248. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  249. <dd></dd>
  250. </dl>
  251. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Ini_remarks">Remarks</h4>
  252. <div class="markdown level1 remarks"><p>基础配置文件</p>
  253. </div>
  254. <h3 id="Apq_Cfg_CfgSourceLevels_Json" data-uid="Apq.Cfg.CfgSourceLevels.Json">
  255. Json
  256. </h3>
  257. <div class="markdown level1 summary"><p>JSON 文件默认层级 (0)</p>
  258. </div>
  259. <div class="markdown level1 conceptual"></div>
  260. <div class="codewrapper">
  261. <pre><code class="lang-csharp hljs">public const int Json = 0</code></pre>
  262. </div>
  263. <h4 class="section">Field Value</h4>
  264. <dl class="parameters">
  265. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  266. <dd></dd>
  267. </dl>
  268. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Json_remarks">Remarks</h4>
  269. <div class="markdown level1 remarks"><p>基础配置文件,通常作为应用程序的默认配置</p>
  270. </div>
  271. <h3 id="Apq_Cfg_CfgSourceLevels_Nacos" data-uid="Apq.Cfg.CfgSourceLevels.Nacos">
  272. Nacos
  273. </h3>
  274. <div class="markdown level1 summary"><p>Nacos 配置中心默认层级 (200)</p>
  275. </div>
  276. <div class="markdown level1 conceptual"></div>
  277. <div class="codewrapper">
  278. <pre><code class="lang-csharp hljs">public const int Nacos = 200</code></pre>
  279. </div>
  280. <h4 class="section">Field Value</h4>
  281. <dl class="parameters">
  282. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  283. <dd></dd>
  284. </dl>
  285. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Nacos_remarks">Remarks</h4>
  286. <div class="markdown level1 remarks"><p>配置中心,优先级高于远程存储</p>
  287. </div>
  288. <h3 id="Apq_Cfg_CfgSourceLevels_Redis" data-uid="Apq.Cfg.CfgSourceLevels.Redis">
  289. Redis
  290. </h3>
  291. <div class="markdown level1 summary"><p>Redis 配置源默认层级 (100)</p>
  292. </div>
  293. <div class="markdown level1 conceptual"></div>
  294. <div class="codewrapper">
  295. <pre><code class="lang-csharp hljs">public const int Redis = 100</code></pre>
  296. </div>
  297. <h4 class="section">Field Value</h4>
  298. <dl class="parameters">
  299. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  300. <dd></dd>
  301. </dl>
  302. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Redis_remarks">Remarks</h4>
  303. <div class="markdown level1 remarks"><p>远程存储配置源,优先级高于本地文件</p>
  304. </div>
  305. <h3 id="Apq_Cfg_CfgSourceLevels_Toml" data-uid="Apq.Cfg.CfgSourceLevels.Toml">
  306. Toml
  307. </h3>
  308. <div class="markdown level1 summary"><p>TOML 文件默认层级 (0)</p>
  309. </div>
  310. <div class="markdown level1 conceptual"></div>
  311. <div class="codewrapper">
  312. <pre><code class="lang-csharp hljs">public const int Toml = 0</code></pre>
  313. </div>
  314. <h4 class="section">Field Value</h4>
  315. <dl class="parameters">
  316. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  317. <dd></dd>
  318. </dl>
  319. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Toml_remarks">Remarks</h4>
  320. <div class="markdown level1 remarks"><p>基础配置文件</p>
  321. </div>
  322. <h3 id="Apq_Cfg_CfgSourceLevels_Vault" data-uid="Apq.Cfg.CfgSourceLevels.Vault">
  323. Vault
  324. </h3>
  325. <div class="markdown level1 summary"><p>HashiCorp Vault 密钥管理默认层级 (300)</p>
  326. </div>
  327. <div class="markdown level1 conceptual"></div>
  328. <div class="codewrapper">
  329. <pre><code class="lang-csharp hljs">public const int Vault = 300</code></pre>
  330. </div>
  331. <h4 class="section">Field Value</h4>
  332. <dl class="parameters">
  333. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  334. <dd></dd>
  335. </dl>
  336. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Vault_remarks">Remarks</h4>
  337. <div class="markdown level1 remarks"><p>密钥管理,优先级高于配置中心,用于敏感配置</p>
  338. </div>
  339. <h3 id="Apq_Cfg_CfgSourceLevels_Xml" data-uid="Apq.Cfg.CfgSourceLevels.Xml">
  340. Xml
  341. </h3>
  342. <div class="markdown level1 summary"><p>XML 文件默认层级 (0)</p>
  343. </div>
  344. <div class="markdown level1 conceptual"></div>
  345. <div class="codewrapper">
  346. <pre><code class="lang-csharp hljs">public const int Xml = 0</code></pre>
  347. </div>
  348. <h4 class="section">Field Value</h4>
  349. <dl class="parameters">
  350. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  351. <dd></dd>
  352. </dl>
  353. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Xml_remarks">Remarks</h4>
  354. <div class="markdown level1 remarks"><p>基础配置文件</p>
  355. </div>
  356. <h3 id="Apq_Cfg_CfgSourceLevels_Yaml" data-uid="Apq.Cfg.CfgSourceLevels.Yaml">
  357. Yaml
  358. </h3>
  359. <div class="markdown level1 summary"><p>YAML 文件默认层级 (0)</p>
  360. </div>
  361. <div class="markdown level1 conceptual"></div>
  362. <div class="codewrapper">
  363. <pre><code class="lang-csharp hljs">public const int Yaml = 0</code></pre>
  364. </div>
  365. <h4 class="section">Field Value</h4>
  366. <dl class="parameters">
  367. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  368. <dd></dd>
  369. </dl>
  370. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Yaml_remarks">Remarks</h4>
  371. <div class="markdown level1 remarks"><p>基础配置文件</p>
  372. </div>
  373. <h3 id="Apq_Cfg_CfgSourceLevels_Zookeeper" data-uid="Apq.Cfg.CfgSourceLevels.Zookeeper">
  374. Zookeeper
  375. </h3>
  376. <div class="markdown level1 summary"><p>Zookeeper 配置中心默认层级 (200)</p>
  377. </div>
  378. <div class="markdown level1 conceptual"></div>
  379. <div class="codewrapper">
  380. <pre><code class="lang-csharp hljs">public const int Zookeeper = 200</code></pre>
  381. </div>
  382. <h4 class="section">Field Value</h4>
  383. <dl class="parameters">
  384. <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
  385. <dd></dd>
  386. </dl>
  387. <h4 class="section" id="Apq_Cfg_CfgSourceLevels_Zookeeper_remarks">Remarks</h4>
  388. <div class="markdown level1 remarks"><p>配置中心,优先级高于远程存储</p>
  389. </div>
  390. </article>
  391. </div>
  392. <div class="affix">
  393. <nav id="affix"></nav>
  394. </div>
  395. </main>
  396. <div class="container-xxl search-results" id="search-results"></div>
  397. <footer class="border-top text-secondary">
  398. <div class="container-xxl">
  399. <div class="flex-fill">
  400. Apq.Cfg - .NET 统一配置组件库 (基于 .NET 10.0,兼容 .NET 8.0)
  401. </div>
  402. </div>
  403. </footer>
  404. </body>
  405. </html>