Asp.Net Core 3.1學習-讀取、監聽json配置文件（7）

2020 年 5 月 14 日
筆記
Asp.Net Core, json, xml, 配置文件

1、前言

文件配置提供程式默認的給我們提供了ini、json、Xml等。都是讀取不同格式的文件。文件配置提供程式支援文件可尋、必選、文件變更的監視。

2、讀取配置文件

主要運用的包：需要Ini、xml的添加相關包就行。

這次依然使用 Core3.1 WebApi項目，在啟動程式介面裡面讀取json配置文件，先看看json文件的格式。裡面有跟多嵌套的子元素。

{
    "Name": "wyy",
    "Age": 18,
    "QQ": "30119459",
    "CardInfo": {
        "Name": "wyy",
        "Card": "5303231999XXX",
        "Birthday": "2001-02-28",
        "Address": {
            "Provience": "雲南省",
            "City": "XX市",
            "Country": "XX縣"
        }
    },
    "IsMarry": true
}

我們在WeatherForecastController中修改get方法來讀取配置文件

[HttpGet]
        public int Get()
        {
            var builder = new ConfigurationBuilder();
            //參數 文件路徑       optional：文件不錯在就會報錯（默認false）    reloadOnChange：文件變更了讀取新的文件（默認true）
            builder.AddJsonFile("config.json",optional:false,reloadOnChange:true);
            var configRoot = builder.Build().GetSection("CardInfo").GetSection("Address");
            var city = $"City:{configRoot["City"]}";
            Console.WriteLine(city);
            return 1;
        }

這裡需要注意的是，如果有很多層就挨個的GetSection 下去，現在讀取到的就是Address裡面的資訊。這裡讀取就跟MVC裡面的一樣的直接configRoot[“節點名”]；

3、使用實體類來接收配置文件

新增一個實體類configDto，裡面的資訊要跟配置文件對應，數據類型也要對應，這裡的原理就跟JsonConvert序列化一樣不對應的就接收不到值

 public class ConfigDto
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public string QQ { get; set; }
        public CardInfo CardInfo { get; set; }
        public bool IsMarry { get; set; }

    }
    public class CardInfo
    {
        public string Name { get; set; }
        public string Card { get; set; }
        public string Birthday { get; set; }
        public Address Address { get; set; }

    }
    public class Address
    {
        public string Provience { get; set; }
        public string City { get; set; }
        public string Country { get; set; }
    }

調用的程式碼

[HttpGet]
        public int Get()
        {
            var builder = new ConfigurationBuilder();
            //參數 文件路徑       optional：文件不錯在就會報錯（默認true）    reloadOnChange：文件變更了讀取新的文件（默認true）
            builder.AddJsonFile("config.json",optional:true,reloadOnChange:true);
            ConfigDto conf = new ConfigDto();
            var configRoot = builder.Build();
                configRoot.Bind(conf);
            return 1;
        }

運行項目打上斷點添加監視可以Dto也獲取到值了，這樣強類型的調用起來豈不是跟方便。

4、監視文件的變更

[HttpGet]
        public int Get()
        {
            var builder = new ConfigurationBuilder();
            //參數 文件路徑       optional：文件不錯在就會報錯（默認false）    reloadOnChange：文件變更了讀取新的文件（默認true）
            builder.AddJsonFile("config.json",optional:false,reloadOnChange:true);
        
            ConfigDto conf = new ConfigDto();
            var configRoot = builder.Build();
                configRoot.Bind(conf);
            //監視文件變更
            IChangeToken token = configRoot.GetReloadToken();
            ChangeToken.OnChange(() => configRoot.GetReloadToken(), () =>
            {
                //做你想做的事  業務邏輯
                Console.WriteLine("文件修改了");
            });
            return 1;
        }

修改文件可以看到保存的時候就會出現，不知道為何會出現兩次下來研究研究；

5、總結

這裡主要弄了文件的讀取、監視、強類型接收等操作、關於配置文件的程式修改下來慢慢研究。關於實體類型是否能設置私有有待考證。學無止境。

每日一句心靈雞湯：其實一個人也是可以活得漂亮，自己笑給自己看，自己哭給自己聽。懂得讓步的人是聰明的，這是把決定事態走向的主動權握在了自己手上。感情對抗中，贏了面子就輸了情分。往往死撐到底的人，都成孤家寡人。彎腰不是認輸，只是為了拾起丟掉的幸福。

Tags: Asp.Net Core json xml 配置文件