.NET कोर में कॉन्फ़िगरेशन कैसे काम करता है

चलो डीडीडी और प्रतिबिंब के बारे में थोड़ी देर के लिए बात करना बंद कर देते हैं। मैं आवेदन सेटिंग्स के संगठन के बारे में, सरल के बारे में बात करने का प्रस्ताव करता हूं।

अपने सहकर्मियों के बाद और मैंने .NET कोर पर स्विच करने का फैसला किया, यह प्रश्न उठता है कि नए वातावरण में कॉन्फ़िगरेशन फ़ाइलों को कैसे व्यवस्थित किया जाए, रूपांतरण कैसे करें, आदि। निम्नलिखित कोड कई उदाहरणों में पाया जाता है, और कई ने इसका सफलतापूर्वक उपयोग किया है।

public IConfiguration Configuration { get; set; } public IHostingEnvironment Environment { get; set; } public Startup(IConfiguration configuration, IHostingEnvironment environment) {   Environment = environment;   Configuration = new ConfigurationBuilder() .AddJsonFile("appsettings.json") .AddJsonFile($"appsettings.{Environment.EnvironmentName}.json") .Build(); } 

लेकिन आइए देखें कि कॉन्फ़िगरेशन कैसे काम करता है, और किन मामलों में इस दृष्टिकोण का उपयोग करना है, और जिसमें .NET कोर के डेवलपर्स पर भरोसा करना है। मैं बिल्ली माँगता हूँ।

जैसा पहले था

किसी भी कहानी की तरह, इस लेख में एक शुरुआत है। ASP.NET कोर पर स्विच करने के बाद पहले मुद्दों में से एक कॉन्फ़िगरेशन फ़ाइलों का परिवर्तन था।

लेकिन जैसा कि हम ASP.NET Core में जानते हैं, web.config फ़ाइल को appsettings.json द्वारा बदल दिया गया है और अब सामान्य परिवर्तन तंत्र नहीं है।

 public IConfiguration Configuration { get; set; } public IHostingEnvironment Environment { get; set; } public Startup(IConfiguration configuration, IHostingEnvironment environment) {  Environment = environment;  Configuration = new ConfigurationBuilder() .AddJsonFile("appsettings.json") .AddJsonFile($"appsettings.{Environment.EnvironmentName}.json") .Build(); } 

 public IConfiguration Configuration { get; set; } public IHostingEnvironment Environment { get; set; } public Startup(IConfiguration configuration, IHostingEnvironment environment) {  Environment = environment;  Configuration = new ConfigurationBuilder() .AddJsonFile($"appsettings.{Environment.EnvironmentName}.json") .Build(); } 

ये उत्तर अक्सर एसओ और अन्य कम लोकप्रिय संसाधनों पर पाए जाते हैं। लेकिन भावना नहीं छोड़ी। कि हम गलत हो रहे हैं। क्या होगा यदि मैं कॉन्फ़िगरेशन में पर्यावरण चर या कमांड लाइन तर्क का उपयोग करना चाहता हूं? मुझे हर प्रोजेक्ट में यह कोड लिखने की आवश्यकता क्यों है?

सत्य की खोज में, मुझे दस्तावेज़ और स्रोत कोड में गहराई से जाना पड़ा। और मैं इस लेख में प्राप्त ज्ञान को साझा करना चाहता हूं।

आइए देखते हैं कि कॉन्फ़िगरेशन .NET कोर में कैसे काम करता है।

विन्यास

.NET कोर में कॉन्फ़िगरेशन एक IConfiguration इंटरफ़ेस ऑब्जेक्ट द्वारा दर्शाया गया है।

 public interface IConfiguration {  string this[string key] { get; set; }  IConfigurationSection GetSection(string key);  IEnumerable<IConfigurationSection> GetChildren();  IChangeToken GetReloadToken(); } 

• [स्ट्रिंग कुंजी] इंडेक्सर, जो कुंजी द्वारा कॉन्फ़िगरेशन पैरामीटर के मूल्य को प्राप्त करने की अनुमति देता है
• GetSection (स्ट्रिंग कुंजी) कॉन्फ़िगरेशन कुंजी देता है जो मुख्य कुंजी से मेल खाती है
• GetChildren () वर्तमान कॉन्फ़िगरेशन अनुभाग का एक उपधारा सेट लौटाता है
• GetReloadToken () IChangeToken का एक उदाहरण देता है जिसका उपयोग कॉन्फ़िगरेशन बदलने पर सूचनाएं प्राप्त करने के लिए किया जा सकता है

एक कॉन्फ़िगरेशन कुंजी-मूल्य जोड़े का एक संग्रह है। कॉन्फ़िगरेशन स्रोत (फ़ाइल, पर्यावरण चर) से पढ़ते समय, पदानुक्रमित डेटा एक फ्लैट संरचना में कम हो जाता है। उदाहरण के लिए, json फॉर्म का एक ऑब्जेक्ट है

 { "Settings": { "Key": "I am options" } } 

एक समतल दृश्य में घटाया जाएगा:

 Settings:Key = I am options 

यहां, कुंजी सेटिंग्स है: कुंजी , और मूल्य I विकल्प हैं ।
कॉन्फ़िगरेशन को कॉन्फ़िगर करने के लिए कॉन्फ़िगरेशन प्रदाताओं का उपयोग किया जाता है।

कॉन्फ़िगरेशन प्रदाता

एक इंटरफ़ेस ऑब्जेक्ट कॉन्फ़िगरेशन स्रोत से डेटा पढ़ने के लिए जिम्मेदार है।
IConfigurationProvider :

 public interface IConfigurationProvider {  bool TryGet(string key, out string value);  void Set(string key, string value);  IChangeToken GetReloadToken();  void Load();  IEnumerable<string> GetChildKeys(IEnumerable<string> earlierKeys, string parentPath); } 

• TryGet (string key, out string value) कुंजी द्वारा कॉन्फ़िगरेशन पैरामीटर का मान प्राप्त करने की अनुमति देता है
• सेट (स्ट्रिंग कुंजी, स्ट्रिंग मान) का उपयोग कॉन्फ़िगरेशन पैरामीटर के मूल्य को सेट करने के लिए किया जाता है
• GetReloadToken () IChangeToken का एक उदाहरण देता है जिसका उपयोग कॉन्फ़िगरेशन के परिवर्तन होने पर सूचनाएं प्राप्त करने के लिए किया जा सकता है
• लोड () विधि जो कॉन्फ़िगरेशन स्रोत को पढ़ने के लिए ज़िम्मेदार है
• GetChildKeys (IEnumerable <string> इससे पहले केके, स्ट्रिंग पैरेंटपैथ) आपको उन सभी कुंजियों की एक सूची प्राप्त करने की अनुमति देता है जो यह कॉन्फ़िगरेशन प्रदाता प्रदान करता है

निम्नलिखित प्रदाता बॉक्स से उपलब्ध हैं:

• Json
• आरं
• Xml
• पर्यावरण चर
• InMemory
• नीला
• कस्टम कॉन्फ़िगरेशन प्रदाता

कॉन्फ़िगरेशन प्रदाताओं का उपयोग करने के लिए निम्नलिखित सम्मेलनों को स्वीकार किया जाता है।

1. कॉन्फ़िगरेशन स्रोतों को उस क्रम में पढ़ा जाता है जिसमें उन्हें निर्दिष्ट किया गया था।
2. यदि समान कुंजी विभिन्न कॉन्फ़िगरेशन स्रोतों में मौजूद हैं (तुलना संवेदनशील नहीं है), तो अंतिम जोड़ा गया मान का उपयोग किया जाता है।

यदि हम CreateDefaultBuilder का उपयोग करके वेब सर्वर का एक उदाहरण बनाते हैं, तो निम्न कॉन्फ़िगरेशन प्रदाता डिफ़ॉल्ट रूप से जुड़े होते हैं:

• ChainedConfigurationProvider इस प्रदाता के माध्यम से आप उन मूल्यों और कॉन्फ़िगरेशन कुंजियों को प्राप्त कर सकते हैं जिन्हें अन्य कॉन्फ़िगरेशन प्रदाताओं द्वारा जोड़ा गया है
• JsonConfigurationProvider कॉन्फ़िगरेशन स्रोत के रूप में json फ़ाइलों का उपयोग करता है। जैसा कि आप देख सकते हैं, इस प्रकार के तीन प्रदाताओं को प्रदाताओं की सूची में जोड़ा जाता है। पहला स्रोत के रूप में appsettings.json का उपयोग करता है, दूसरा appsettings का उपयोग करता है। {पर्यावरण} .json तीसरा राज़ से डेटा पढ़ता है। यदि आप रिलीज़ कॉन्फ़िगरेशन में अनुप्रयोग बनाते हैं, तो तीसरा प्रदाता कनेक्ट नहीं किया जाएगा, क्योंकि यह उत्पादन वातावरण में रहस्यों का उपयोग करने के लिए अनुशंसित नहीं है
• EnvironmentVariablesConfigurationProvider पर्यावरण चर से कॉन्फ़िगरेशन पैरामीटर प्राप्त करता है
• CommandLineConfigurationProvider कॉन्फ़िगरेशन में कमांड लाइन तर्क जोड़ने की अनुमति देता है

चूंकि कॉन्फ़िगरेशन को एक शब्दकोश के रूप में संग्रहीत किया जाता है, यह कुंजी की विशिष्टता सुनिश्चित करने के लिए आवश्यक है। डिफ़ॉल्ट रूप से, यह इस तरह काम करता है।

यदि CommandLineConfigurationProvider प्रदाता में कुंजी कुंजी के साथ एक तत्व है और JsonConfigurationProvider प्रदाता के पास कुंजी के साथ एक तत्व है, तो JsonConfigurationProvider के तत्व को CommandLineConfigurationProvider से तत्व द्वारा प्रतिस्थापित किया जाएगा क्योंकि यह अंतिम पंजीकृत है और उच्च प्राथमिकता है।

 public IConfiguration Configuration { get; set; } public IHostingEnvironment Environment { get; set; } public Startup(IConfiguration configuration, IHostingEnvironment environment) {  Environment = environment;  Configuration = new ConfigurationBuilder() .AddJsonFile("appsettings.json") .AddJsonFile($"appsettings.{Environment.EnvironmentName}.json") .Build(); } 

कस्टम कॉन्फ़िगरेशन प्रदाता

अपने कॉन्फ़िगरेशन प्रदाता को लिखने के लिए, आपको IConfigurationProvider और IConfigurationSource इंटरफेस को लागू करना होगा । IConfigurationSource एक नया इंटरफ़ेस है जिसे हमने अभी तक इस लेख में नहीं माना है।

 public interface IConfigurationSource { IConfigurationProvider Build(IConfigurationBuilder builder); } 

इंटरफ़ेस में एक एकल बिल्ड विधि शामिल होती है जो IConfigurationBuilder को एक पैरामीटर के रूप में लेती है और IConfigurationProvider का एक नया उदाहरण देता है।

हमारे कॉन्फ़िगरेशन प्रदाताओं को लागू करने के लिए, अमूर्त वर्ग कॉन्फ़िगरेशनप्रोवाइडर और फ़ाइल कॉनफिगरेशनप्रॉइडर हमें उपलब्ध हैं। इन वर्गों में, TryGet , Set , GetReloadToken , GetChildKeys विधियों का तर्क पहले से ही लागू है और यह केवल लोड पद्धति को लागू करने के लिए बना हुआ है।

आइए एक उदाहरण देखें। यमल फ़ाइल से कॉन्फ़िगरेशन पढ़ना लागू करना आवश्यक है, और यह भी आवश्यक है कि हम अपने एप्लिकेशन को पुनरारंभ किए बिना कॉन्फ़िगरेशन को बदल सकते हैं।

YamlConfigurationProvider वर्ग बनाएं और इसे FileConfigurationProvider का उत्तराधिकारी बनाएं ।

 public class YamlConfigurationProvider : FileConfigurationProvider { private readonly string _filePath; public YamlConfigurationProvider(FileConfigurationSource source) : base(source) { } public override void Load(Stream stream) { throw new NotImplementedException(); } } 

उपरोक्त कोड स्निपेट में, आप FileConfigurationProvider वर्ग की कुछ विशेषताओं को देख सकते हैं। कंस्ट्रक्टर FileConfigurationSource का एक उदाहरण स्वीकार करता है, जिसमें IFileProvider होता है। IFileProvider एक फ़ाइल को पढ़ने के लिए, और एक फ़ाइल परिवर्तन घटना के लिए सदस्यता के लिए प्रयोग किया जाता है। आप यह भी देख सकते हैं कि लोड विधि एक स्ट्रीम स्वीकार करती है जिसमें कॉन्फ़िगरेशन फ़ाइल पढ़ने के लिए खुली है। यह FileConfigurationProvider वर्ग का एक तरीका है और IConfigurationProvider इंटरफ़ेस में नहीं है।

एक साधारण कार्यान्वयन जोड़ें जो हमें यमल फ़ाइल पढ़ने की अनुमति देता है। फ़ाइल को पढ़ने के लिए, मैं YamlDotNet पैकेज का उपयोग करूंगा ।

  public class YamlConfigurationProvider : FileConfigurationProvider { private readonly string _filePath; public YamlConfigurationProvider(FileConfigurationSource source) : base(source) { } public override void Load(Stream stream) { if (stream.CanSeek) { stream.Seek(0L, SeekOrigin.Begin); using (StreamReader streamReader = new StreamReader(stream)) { var fileContent = streamReader.ReadToEnd(); var yamlObject = new DeserializerBuilder() .Build() .Deserialize(new StringReader(fileContent)) as IDictionary<object, object>; Data = new Dictionary<string, string>(); foreach (var pair in yamlObject) { FillData(String.Empty, pair); } } } } private void FillData(string prefix, KeyValuePair<object, object> pair) { var key = String.IsNullOrEmpty(prefix) ? pair.Key.ToString() : $"{prefix}:{pair.Key}"; switch (pair.Value) { case string value: Data.Add(key, value); break; case IDictionary<object, object> section: { foreach (var sectionPair in section) FillData(pair.Key.ToString(), sectionPair); break; } } } } 

हमारे कॉन्फ़िगरेशन प्रदाता का एक उदाहरण बनाने के लिए, आपको FileConfigurationSource को लागू करना होगा।

 public class YamlConfigurationSource : FileConfigurationSource { public YamlConfigurationSource(string fileName) { Path = fileName; ReloadOnChange = true; } public override IConfigurationProvider Build(IConfigurationBuilder builder) { this.EnsureDefaults(builder); return new YamlConfigurationProvider(this); } } 

अनुप्रयोग में एक कस्टम कॉन्फ़िगरेशन प्रदाता को पंजीकृत करने के लिए, आपको IConfigurationBuilder में प्रदाता का उदाहरण जोड़ना होगा। आप IConfigurationBuilder से ऐड मेथड को कॉल कर सकते हैं, लेकिन मैं तुरंत विस्तार विधि में यमलकोनफिगरेशनपॉइडर इनिशियलाइज़ेशन लॉजिक को बाहर कर दूँगा ।

 public static class YamlConfigurationExtensions { public static IConfigurationBuilder AddYaml( this IConfigurationBuilder builder, string filePath) { if (builder == null) throw new ArgumentNullException(nameof(builder)); if (string.IsNullOrEmpty(filePath)) throw new ArgumentNullException(nameof(filePath)); return builder .Add(new YamlConfigurationSource(filePath)); } } 

 public class Program { public static void Main(string[] args) { CreateWebHostBuilder(args).Build().Run(); } public static IWebHostBuilder CreateWebHostBuilder(string[] args) => WebHost.CreateDefaultBuilder(args) .ConfigureAppConfiguration((context, builder) => { builder.AddYaml("appsettings.yaml"); }) .UseStartup<Startup>(); } 

ट्रैकिंग बदलें

नए एपीआई कॉन्फ़िगरेशन में, जब यह बदल जाता है तो कॉन्फ़िगरेशन स्रोत को फिर से पढ़ना संभव हो गया। उसी समय, एप्लिकेशन पुनरारंभ नहीं होता है।
यह कैसे काम करता है:

• कॉन्फ़िगरेशन प्रदाता कॉन्फ़िगरेशन स्रोत परिवर्तनों की निगरानी करता है
• यदि कॉन्फ़िगरेशन परिवर्तन होता है, तो एक नया IChangeToken बनाया जाता है ।
• जब IChangeToken को बदल दिया जाता है , तो कॉन्फ़िगरेशन पुनः लोड कहा जाता है

चलिए देखते हैं कि FileConfigurationProvider में ट्रैकिंग कैसे लागू होती है ।

 ChangeToken.OnChange( //producer () => Source.FileProvider.Watch(Source.Path), //consumer () => { Thread.Sleep(Source.ReloadDelay); Load(reload: true); }); 

चेंजटॉकन स्टेटिक क्लास के ऑनचेंज मेथड में दो पैरामीटर पास किए जाते हैं। पहला पैरामीटर एक फ़ंक्शन है जो एक नया IChangeToken देता है जब कॉन्फ़िगरेशन स्रोत (इस मामले में फ़ाइल) बदलता है, यह तथाकथित निर्माता है । दूसरा पैरामीटर कॉलबैक (या उपभोक्ता ) फ़ंक्शन है, जिसे कॉन्फ़िगरेशन स्रोत बदलने पर कॉल किया जाएगा।
ChangeToken वर्ग के बारे में अधिक जानें।

सभी कॉन्फ़िगरेशन प्रदाता परिवर्तन ट्रैकिंग लागू नहीं करते हैं। यह तंत्र FileConfigurationProvider और AzureKeyVaultConfiguration.rovider के वंशजों के लिए उपलब्ध है।

निष्कर्ष

.NET कोर में, हमारे पास एप्लिकेशन सेटिंग्स को प्रबंधित करने के लिए एक आसान, सुविधाजनक तंत्र है। कई ऐड-ऑन बॉक्स उपलब्ध हैं, कई चीजें डिफ़ॉल्ट रूप से उपयोग की जाती हैं।
बेशक, प्रत्येक व्यक्ति यह तय करता है कि किस तरीके का उपयोग करना है, लेकिन मैं इस तथ्य के लिए हूं कि लोग अपने उपकरणों को जानते हैं।

इस लेख में केवल मूल बातें शामिल हैं। मूल बातें, IOptions, पोस्ट-कॉन्फ़िगरेशन स्क्रिप्ट के अलावा, सेटिंग्स सत्यापन, और बहुत कुछ हमारे लिए उपलब्ध हैं। लेकिन वह एक और कहानी है।

आप इस लेख के उदाहरणों के साथ आवेदन परियोजना को जीथब पर भंडार में पा सकते हैं।
टिप्पणियों में साझा करें कि कौन से कॉन्फ़िगरेशन प्रबंधन दृष्टिकोण का उपयोग करता है?
आपका ध्यान के लिए धन्यवाद।

अद्यतन ।: जैसा कि AdAbsurdum ने सही ढंग से सुझाव दिया है, जब सरणियों के साथ काम करते हैं, तो तत्वों को हमेशा दो स्रोतों से कॉन्फ़िगरेशन को मर्ज करते समय प्रतिस्थापित नहीं किया जाएगा।
एक उदाहरण पर विचार करें। जब हम appsettings.json से एक सरणी पढ़ते हैं तो हमें यह सपाट दृश्य मिलता है:

 array:0=valueA 

जब appsettings.Development.json से पढ़ रहे हैं:

 array:0=valueB array:1=value 

नतीजतन, विन्यास होगा:

 array:0=valueB array:1=value 

अद्वितीय सूचकांकों (उदाहरण में 1 ) वाले सभी तत्व परिणामी सरणी में जोड़े जाएंगे। विभिन्न विन्यास स्रोतों से तत्व, लेकिन एक ही सूचकांक (उदाहरण में 0 ) होने से विलय हो जाएगा, और अंतिम जोड़ा गया तत्व का उपयोग किया जाएगा।