การอ่านการตั้งค่าจาก app.config หรือ web.config ใน. NET

ฉันกำลังทำงานกับไลบรารีคลาส C # ที่ต้องสามารถอ่านการตั้งค่าจากweb.configหรือapp.configไฟล์ (ขึ้นอยู่กับว่า DLL นั้นถูกอ้างอิงจากแอปพลิเคชันเว็บ ASP.NET หรือแอปพลิเคชัน Windows Forms)

ฉันพบว่า

ConfigurationSettings.AppSettings.Get("MySetting")

ใช้งานได้ แต่รหัสนั้นถูกทำเครื่องหมายว่าไม่สนับสนุนโดย Microsoft

ฉันได้อ่านแล้วว่าควรใช้:

ConfigurationManager.AppSettings["MySetting"]

อย่างไรก็ตามSystem.Configuration.ConfigurationManagerดูเหมือนว่าคลาสจะไม่พร้อมใช้งานจากโครงการ C # Class Library

วิธีที่ดีที่สุดในการทำเช่นนี้คืออะไร?

คุณจะต้องเพิ่มการอ้างอิงไปSystem.Configurationในโครงการของคุณโฟลเดอร์อ้างอิง

คุณควรใช้สิ่งConfigurationManagerที่ล้าสมัยConfigurationSettingsอย่างแน่นอน

สำหรับตัวอย่างไฟล์ app.config ด้านล่าง:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="countoffiles" value="7" />
    <add key="logfilelocation" value="abc.txt" />
  </appSettings>
</configuration>

คุณอ่านการตั้งค่าแอปพลิเคชันด้านบนโดยใช้รหัสที่แสดงด้านล่าง

using System.Configuration;

คุณอาจต้องเพิ่มการอ้างอิงSystem.Configurationในโครงการของคุณหากยังไม่มีใครอ้างอิง จากนั้นคุณสามารถเข้าถึงค่าต่างๆดังนี้:

string configvalue1 = ConfigurationManager.AppSettings["countoffiles"];
string configvalue2 = ConfigurationManager.AppSettings["logfilelocation"];

การปรับปรุงสำหรับ. NET Framework 4.5 และ 4.6 ต่อไปนี้จะไม่ทำงานอีกต่อไป:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

ตอนนี้เข้าถึงคลาสการตั้งค่าผ่านคุณสมบัติ:

string keyvalue = Properties.Settings.Default.keyname;

ดูการจัดการการตั้งค่าแอปพลิเคชันสำหรับข้อมูลเพิ่มเติม

คลิกขวาที่ไลบรารีคลาสของคุณแล้วเลือกตัวเลือก "เพิ่มการอ้างอิง" จากเมนู

และจากแท็บ. NET เลือก System.Configuration ซึ่งรวมถึงไฟล์ System.Configuration DLL ในโครงการของคุณ

ฉันใช้สิ่งนี้และมันใช้งานได้ดีสำหรับฉัน:

textBox1.Text = ConfigurationManager.AppSettings["Name"];

อ่านจากการกำหนดค่า:

คุณจะต้องเพิ่มการอ้างอิงไปยังการกำหนดค่า:

1. เปิด "Properties" ในโครงการของคุณ
2. ไปที่แท็บ "การตั้งค่า"
3. เพิ่ม "ชื่อ" และ "ค่า"

4. รับค่าด้วยการใช้รหัสต่อไปนี้:

   string value = Properties.Settings.Default.keyname;

บันทึกลงในการกำหนดค่า:

   Properties.Settings.Default.keyName = value;
   Properties.Settings.Default.Save();

คุณต้องเพิ่มการอ้างอิงไปยังแอสเซมบลี System.Configuration ไปยังโครงการ

คุณอาจจะเพิ่มไฟล์ App.config ลงในไฟล์ DLL App.Config ใช้งานได้สำหรับโครงการที่ดำเนินการได้เนื่องจากไฟล์ DLL ทั้งหมดใช้การกำหนดค่าจากไฟล์การกำหนดค่าสำหรับไฟล์ EXE ที่กำลังดำเนินการ

สมมติว่าคุณมีสองโครงการในโซลูชันของคุณ:

• SomeDll
• SomeExe

ปัญหาของคุณอาจเกี่ยวข้องกับความจริงที่ว่าคุณรวมไฟล์ app.config ไว้กับ SomeDLL และไม่ใช่ SomeExe SomeDll สามารถอ่านการกำหนดค่าจากโครงการ SomeExe

ลองสิ่งนี้:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

ในไฟล์web.configควรเป็นโครงสร้างต่อไปนี้:

<configuration>
<appSettings>
<add key="keyname" value="keyvalue" />
</appSettings>
</configuration>

ผมมีปัญหาเดียวกัน. เพียงแค่อ่านวิธีนี้: System.Configuration.ConfigurationSettings.AppSettings ["MySetting"]

web.configใช้กับเว็บแอปพลิเคชัน web.configโดยค่าเริ่มต้นมีการกำหนดค่าหลายอย่างที่จำเป็นสำหรับโปรแกรมประยุกต์บนเว็บ คุณสามารถมีweb.configสำหรับแต่ละโฟลเดอร์ภายใต้เว็บแอปพลิเคชันของคุณ

app.configใช้สำหรับแอปพลิเคชัน Windows เมื่อคุณสร้างแอปพลิเคชันใน Visual Studio มันจะถูกเปลี่ยนชื่อโดยอัตโนมัติ<appname>.exe.configและจะต้องส่งไฟล์นี้ไปพร้อมกับแอปพลิเคชันของคุณ

คุณสามารถใช้วิธีเดียวกันนี้ในการเรียกapp settingsค่าจากทั้งไฟล์การกำหนดค่า: System.Configuration.ConfigurationSettings.AppSettings ["Key"]

ในขณะที่ฉันพบวิธีที่ดีที่สุดในการเข้าถึงตัวแปรการตั้งค่าแอปพลิเคชันอย่างเป็นระบบโดยการทำให้คลาส wrapper ทับ System.Configuration ดังนี้

public class BaseConfiguration
{
    protected static object GetAppSetting(Type expectedType, string key)
    {
        string value = ConfigurationManager.AppSettings.Get(key);
        try
        {
            if (expectedType == typeof(int))
                return int.Parse(value);
            if (expectedType == typeof(string))
                return value;

            throw new Exception("Type not supported.");
        }
        catch (Exception ex)
        {
            throw new Exception(string.Format("Config key:{0} was expected to be of type {1} but was not.",
                key, expectedType), ex);
        }
    }
}

ตอนนี้เราสามารถเข้าถึงตัวแปรการตั้งค่าที่จำเป็นด้วยชื่อฮาร์ดโค้ดโดยใช้คลาสอื่นดังต่อไปนี้:

public class ConfigurationSettings:BaseConfiguration
{
    #region App setting

    public static string ApplicationName
    {
        get { return (string)GetAppSetting(typeof(string), "ApplicationName"); }
    }

    public static string MailBccAddress
    {
        get { return (string)GetAppSetting(typeof(string), "MailBccAddress"); }
    }

    public static string DefaultConnection
    {
        get { return (string)GetAppSetting(typeof(string), "DefaultConnection"); }
    }

    #endregion App setting

    #region global setting


    #endregion global setting
}

ฉันขอแนะนำให้คุณสร้างเสื้อคลุมสำหรับการโทรนี้ บางอย่างเช่น a ConfigurationReaderServiceและใช้การฉีดพึ่งพาเพื่อรับคลาสนี้ วิธีนี้คุณจะสามารถแยกไฟล์การกำหนดค่านี้เพื่อวัตถุประสงค์ในการทดสอบ

ดังนั้นใช้การConfigurationManager.AppSettings["something"];แนะนำและส่งกลับค่านี้ ด้วยวิธีนี้คุณสามารถสร้างการคืนค่าเริ่มต้นบางประเภทได้หากไม่มีคีย์ใด ๆ ในไฟล์. config

นอกจากนี้คุณสามารถใช้Formo :

การกำหนดค่า:

<appSettings>
    <add key="RetryAttempts" value="5" />
    <add key="ApplicationBuildDate" value="11/4/1999 6:23 AM" />
</appSettings>

รหัส:

dynamic config = new Configuration();
var retryAttempts1 = config.RetryAttempts;                 // Returns 5 as a string
var retryAttempts2 = config.RetryAttempts(10);             // Returns 5 if found in config, else 10
var retryAttempts3 = config.RetryAttempts(userInput, 10);  // Returns 5 if it exists in config, else userInput if not null, else 10
var appBuildDate = config.ApplicationBuildDate<DateTime>();

เพียงเพื่อความสมบูรณ์มีตัวเลือกอื่นสำหรับเว็บโครงการเท่านั้น: System.Web.Configuration.WebConfigurationManager.AppSettings ["MySetting"]

ประโยชน์ของสิ่งนี้คือมันไม่จำเป็นต้องมีการอ้างอิงเพิ่มเติมเพื่อเพิ่มดังนั้นจึงอาจเป็นที่นิยมสำหรับบางคน

ขั้นตอนที่ 1: คลิกขวาที่แท็บการอ้างอิงเพื่อเพิ่มการอ้างอิง

ขั้นตอนที่ 2: คลิกที่แท็บชุดประกอบ

ขั้นตอนที่ 3: ค้นหา 'System.Configuration'

ขั้นตอนที่ 4: คลิกตกลง

จากนั้นมันจะทำงาน

 string value = System.Configuration.ConfigurationManager.AppSettings["keyname"];

ฉันมักจะสร้างอินเทอร์เฟซ IConfig พร้อมคุณสมบัติ typesafe ที่ประกาศสำหรับค่าการตั้งค่าทั้งหมด จากนั้นคลาสการปรับใช้ Config จะตัดการเรียกไปที่ System.Configuration การเรียกใช้ System.Configuration ทั้งหมดของคุณอยู่ในที่เดียวและมันง่ายขึ้นและสะอาดยิ่งขึ้นในการดูแลและติดตามว่ามีการใช้ฟิลด์ใดและประกาศค่าเริ่มต้น ฉันเขียนชุดวิธีผู้ช่วยส่วนตัวเพื่ออ่านและแยกประเภทข้อมูลทั่วไป

การใช้เฟรมเวิร์กIoCคุณสามารถเข้าถึงฟิลด์ IConfig ได้ทุกที่ในแอปพลิเคชันของคุณโดยเพียงแค่ส่งอินเตอร์เฟสไปยังตัวสร้างคลาส จากนั้นคุณยังสามารถสร้างการประยุกต์ใช้จำลองของอินเทอร์เฟซ IConfig ในการทดสอบหน่วยของคุณเพื่อให้คุณสามารถทดสอบค่าการกำหนดค่าและชุดค่าต่างๆโดยไม่จำเป็นต้องแตะไฟล์ App.config หรือ Web.config ของคุณ

ทางออกที่เป็นไปได้อื่น:

var MyReader = new System.Configuration.AppSettingsReader();
string keyvalue = MyReader.GetValue("keyalue",typeof(string)).ToString();

ฉันพยายามค้นหาวิธีแก้ไขปัญหาเดียวกันนี้มาสองสามวันแล้ว ฉันสามารถแก้ไขปัญหานี้ได้ด้วยการเพิ่มคีย์ภายในแท็ก appsettings ในไฟล์web.config สิ่งนี้ควรแทนที่ไฟล์. dll เมื่อใช้ตัวช่วย

<configuration>
    <appSettings>
        <add key="loginUrl" value="~/RedirectValue.cshtml" />
        <add key="autoFormsAuthentication" value="false"/>
    </appSettings>
</configuration>

คุณสามารถใช้บรรทัดด้านล่าง ในกรณีของฉันมันทำงาน: System.Configuration.ConfigurationSettings.AppSettings ["yourKeyName"]

คุณต้องระวังว่าโค้ดข้างต้นเป็นเวอร์ชั่นเก่าและเลิกใช้แล้วในไลบรารีใหม่

ConfigurationManager ไม่ใช่สิ่งที่คุณต้องการในการเข้าถึงการตั้งค่าของคุณเอง

เมื่อต้องการทำเช่นนี้คุณควรใช้

{YourAppName}.Properties.Settings.{settingName}

ฉันสามารถรับวิธีการทำงานด้านล่างสำหรับโครงการ. NET Core:

ขั้นตอน:

1. สร้าง appsettings.json (รูปแบบที่ระบุด้านล่าง) ในโครงการของคุณ
2. ถัดไปสร้างคลาสการกำหนดค่า รูปแบบที่ให้ไว้ด้านล่าง

3. ฉันได้สร้างวิธีการลงชื่อเข้าใช้ () เพื่อแสดงการใช้งานคลาสการกำหนดค่า

   สร้าง appsettings.json ในโครงการของคุณด้วยเนื้อหา:

   {
     "Environments": {
       "QA": {
         "Url": "somevalue",
    "Username": "someuser",
         "Password": "somepwd"
     },
     "BrowserConfig": {
       "Browser": "Chrome",
       "Headless": "true"
     },
     "EnvironmentSelected": {
       "Environment": "QA"
     }
   }
   
   public static class Configuration
   {
       private static IConfiguration _configuration;
   
       static Configuration()
       {
           var builder = new ConfigurationBuilder()
               .AddJsonFile($"appsettings.json");
   
           _configuration = builder.Build();
   
       }
       public static Browser GetBrowser()
       {
   
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "Firefox")
           {
               return Browser.Firefox;
           }
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "Edge")
           {
               return Browser.Edge;
           }
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "IE")
           {
               return Browser.InternetExplorer;
           }
           return Browser.Chrome;
       }
   
       public static bool IsHeadless()
       {
           return _configuration.GetSection("BrowserConfig:Headless").Value == "true";
       }
   
       public static string GetEnvironment()
       {
           return _configuration.GetSection("EnvironmentSelected")["Environment"];
       }
       public static IConfigurationSection EnvironmentInfo()
       {
           var env = GetEnvironment();
           return _configuration.GetSection($@"Environments:{env}");
       }
   
   }
   
   
   public void Login()
   {
       var environment = Configuration.EnvironmentInfo();
       Email.SendKeys(environment["username"]);
       Password.SendKeys(environment["password"]);
       WaitForElementToBeClickableAndClick(_driver, SignIn);
   }

หากคุณต้องการ / ต้องการใช้ConfigurationManagerคลาส ...

คุณอาจต้องโหลดSystem.Configuration.ConfigurationManagerโดย Microsoft ผ่านทางNuGet Package Manager

เครื่องมือ -> ตัวจัดการแพ็คเกจ NuGet-> จัดการแพคเกจ NuGet สำหรับโซลูชัน ...

เอกสาร Microsoft

สิ่งหนึ่งที่น่าสังเกตจากเอกสาร ...

หากแอปพลิเคชันของคุณต้องการเข้าถึงการกำหนดค่าของตัวเองแบบอ่านอย่างเดียวเราขอแนะนำให้คุณใช้เมธอด GetSection (String) วิธีนี้ให้การเข้าถึงค่าการกำหนดค่าที่แคชไว้สำหรับแอปพลิเคชันปัจจุบันซึ่งมีประสิทธิภาพที่ดีกว่าคลาสการกำหนดค่า

กรุณาตรวจสอบเวอร์ชั่น. NET ที่คุณใช้งานอยู่ มันควรจะสูงกว่า 4 และคุณต้องเพิ่มไลบรารีระบบ System.Configuration ไปยังแอปพลิเคชันของคุณ

นี่คือตัวอย่าง: App.config

<applicationSettings>
    <MyApp.My.MySettings>
        <setting name="Printer" serializeAs="String">
            <value>1234 </value>
        </setting>
    </MyApp.My.MySettings>
</applicationSettings>

Dim strPrinterName as string = My.settings.Printer