您好,登录后才能下订单哦!
小编给大家分享一下.NetCore中如何读取配置文件,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!
在应用程序开发中,配置文件是主要存储系统的初始配置信息,配置文件的读取虽然属于基础内容却又经常用到,所以百丈高楼平地起,学习.Net Core,就从学习配置文件开始。在.net framework时代,配置文件主要是xml格式【web.config,app.config】,且每次修改,需要重启,但是在.Net Core中,由于跨平台的关系,配置文件多以json【appsetting.json】的形式存在,且可以进行热加载。本文以一些简单的小例子,简述如何在.Net Core中进行配置文件【Json,xml,ini,环境变量等】的读取,仅供学习分享使用,如有不足之处,还请指正。
在本例中,主要进行.Net Core开发环境下的配置文件读取,涉及知识点如下:
IConfiguration:.Net Core中应用程序配置的操作接口,主要提供了对Json,xml,ini ,环境变量,内存数据等的读取功能。
ConfigurationBuilder:用于构建应用程序配置接口的构建器工具类。
在.Net Core中,要实现配置文件的读取,需要依赖以下几个插件包,可以通过Nuget进行安装。具体如下所示:
注意:.Net Core对不同文件的解析,在不同的插件库中,可以根据实际项目需要分别进行安装。此处也体现了面向对象的设计思想【如:开闭原则,单一职责原则】。
首先准备一个Json文件,如下所示:
{ "Name": "Alan.hsiang", "Age": 20, "Sex": "male", "Like": ["basketball","football","swimming"], "Score": { "LandLit": 90, "Mathematics": 99, "English": 50 } }
在.Net Core中,读取配对文件是通过IConfiguration接口操作的,实例化接口对象如下所示:
IConfiguration configuration = new ConfigurationBuilder().SetBasePath(Environment.CurrentDirectory).AddJsonFile("student.json").Build();
默认情况下,IConfiguration接口提供了索引器,以Key为参数进行读取,返回字符串对象,如下所示:
var name = configuration["Name"]; //IConfiguration接口自带的索引器,只返回字符串类型。如:名字 var like0 = configuration["Like:0"];//读取数组中第一个元素 如:第一个爱好 var like2 = configuration["Like:2"];//读取数组中第三个元素 如:第三个爱好 var landLit = configuration["Score:LandLit"];//获取字节点的属性值,如:语文成绩
注意:如果Json数据有层级关系,则通过冒号【:】进行表示。
通过索引器只能返回字符串类型的值,如果需要读取其他简单类型的对象,如:int,float等,则可以通过GetValue<T>()方法进行,具体如下所示:
var age = configuration.GetValue<int>("Age");//获取其他数据类型,如:int,如:年龄
通过索引器和泛型方法,可以读取简单类型的对象,如果需要读取复杂对象【如:数组,列表等】,则需要使用绑定,如下所示:
//获取整个数组,如:爱好 var like = new List<string>(); configuration.Bind("Like",like);
以上示例都是对Json文件局部数据的读取,那么可以将整个文件转换为对象吗?这样直接操作对象将对很方便快捷。具体如下所示:
首先复制整个Json文件的内容,然后依次点击【编辑-->选择性粘贴-->将JSON粘贴为类】菜单,如下所示:
默认生成的类名为RootObject,然后修改为Student,具体如下所示:
namespace DemoCore { public class Student { public string Name { get; set; } public int Age { get; set; } public string Sex { get; set; } public string[] Like { get; set; } public Score Score { get; set; } } public class Score { public int LandLit { get; set; } public int Mathematics { get; set; } public int English { get; set; } } }
将Student类和配置对象进行绑定,如下所示:
//2. 复杂读取 var student = new Student(); configuration.Bind(student); Console.WriteLine($"name={student.Name},age={student.Age},like= {string.Join(",", student.Like)},score={student.Score.English}");
在应用程序开发中,XML文件也是比较常用的一种配置文件。对XML文件的读取操作和Json文件操作基本相似,具体如下所示:
首先创建一个XML文件,如下所示:
<?xml version="1.0" encoding="utf-8" ?> <Student> <Name>Alan.hsiang</Name> <Age>20</Age> <Sex>male</Sex> <Likes> <Like>basketball</Like> <Like>football</Like> <Like>swimming</Like> </Likes> <Score> <LandLit>90</LandLit> <Mathematics>98</Mathematics> <English>60</English> </Score> </Student>
通过索引器和GetValue可以进行读取,如下所示:
//1. 基础读取 var age = configuration.GetValue<int>("Age");//获取其他数据类型,如:int,如:年龄 var name = configuration["Name"]; //IConfiguration接口自带的索引器,只返回字符串类型。如:名字 var like0 = configuration["Likes:Like:0"];//读取数组中第一个元素 如:第一个爱好 var like2 = configuration["Likes:Like:2"];//读取数组中第三个元素 如:第三个爱好 var landLit = configuration["Score:LandLit"];//获取字节点的属性值,如:语文成绩
注意:读取数组中的元素时,和json读取不同,因为json中是一个节点,但是在xml中是三个节点。
读取XML中的数组列表,如下所示:
//获取整个数组,如:爱好 var like = new List<string>(); configuration.Bind("Likes:Like", like); Console.WriteLine($"name={name},age={age},like= {string.Join(",", like)}");
以上示例都是对XML文件局部数据的读取,那么可以将整个文件转换为对象吗?这样直接操作对象将对很方便快捷。具体如下所示:
首先复制整个XML文件的内容,然后依次点击【编辑-->选择性粘贴-->将XML粘贴为类】菜单,如下所示:
默认生成的类,类名与XML的根节点保持一致,如下所示:
namespace DemoCore { // 注意: 生成的代码可能至少需要 .NET Framework 4.5 或 .NET Core/Standard 2.0。 /// <remarks/> [System.SerializableAttribute()] [System.ComponentModel.DesignerCategoryAttribute("code")] [System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)] [System.Xml.Serialization.XmlRootAttribute(Namespace = "", IsNullable = false)] public partial class Student { private string nameField; private byte ageField; private string sexField; private string[] likesField; private StudentScore scoreField; /// <remarks/> public string Name { get { return this.nameField; } set { this.nameField = value; } } /// <remarks/> public byte Age { get { return this.ageField; } set { this.ageField = value; } } /// <remarks/> public string Sex { get { return this.sexField; } set { this.sexField = value; } } /// <remarks/> [System.Xml.Serialization.XmlArrayItemAttribute("Like", IsNullable = false)] public string[] Likes { get { return this.likesField; } set { this.likesField = value; } } /// <remarks/> public StudentScore Score { get { return this.scoreField; } set { this.scoreField = value; } } } /// <remarks/> [System.SerializableAttribute()] [System.ComponentModel.DesignerCategoryAttribute("code")] [System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)] public partial class StudentScore { private byte landLitField; private byte mathematicsField; private byte englishField; /// <remarks/> public byte LandLit { get { return this.landLitField; } set { this.landLitField = value; } } /// <remarks/> public byte Mathematics { get { return this.mathematicsField; } set { this.mathematicsField = value; } } /// <remarks/> public byte English { get { return this.englishField; } set { this.englishField = value; } } } }
但是默认生成的类,在转换成数组时存在问题,所以需要细微调整,如下所示:
namespace DemoCore { // 注意: 生成的代码可能至少需要 .NET Framework 4.5 或 .NET Core/Standard 2.0。 /// <remarks/> [System.SerializableAttribute()] [System.ComponentModel.DesignerCategoryAttribute("code")] [System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)] [System.Xml.Serialization.XmlRootAttribute(Namespace = "", IsNullable = false)] public partial class Student { private string nameField; private byte ageField; private string sexField; private LikesLike likesField; private StudentScore scoreField; /// <remarks/> public string Name { get { return this.nameField; } set { this.nameField = value; } } /// <remarks/> public byte Age { get { return this.ageField; } set { this.ageField = value; } } /// <remarks/> public string Sex { get { return this.sexField; } set { this.sexField = value; } } /// <remarks/> [System.Xml.Serialization.XmlArrayItemAttribute("Like", IsNullable = false)] public LikesLike Likes { get { return this.likesField; } set { this.likesField = value; } } /// <remarks/> public StudentScore Score { get { return this.scoreField; } set { this.scoreField = value; } } } /// <remarks/> [System.SerializableAttribute()] [System.ComponentModel.DesignerCategoryAttribute("code")] [System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)] public partial class StudentScore { private byte landLitField; private byte mathematicsField; private byte englishField; /// <remarks/> public byte LandLit { get { return this.landLitField; } set { this.landLitField = value; } } /// <remarks/> public byte Mathematics { get { return this.mathematicsField; } set { this.mathematicsField = value; } } /// <remarks/> public byte English { get { return this.englishField; } set { this.englishField = value; } } } public partial class LikesLike { public string[] Like { get; set; } } }
然后在读取时,进行整体绑定,如下所示:
//2. 复杂读取 var student = new Student(); configuration.Bind(student); Console.WriteLine($"name={student.Name},age={student.Age},like= {string.Join(",", student.Likes.Like)},score={student.Score.English}");
注意:通过示例方向,读取XML和读取Json文件,存在细微的差异。
ini文件在C#程序中,一般应用的不是很多,主要是键值对文件,主要用于存储简单的数据格式,如下所示:
一般情况下,ini文件包括以下几个部分:a. 注释 用分号做前缀,b. 节点用中括号表示,c. key=value表示内容。如下所示:
;此处表示注释 [student] Name=Alan.hsiang Age=20 Grade=4
在.Net Core中读取ini文件的步骤,非常简单,如下所示:
private static void ReadIni() { IConfiguration configuration = new ConfigurationBuilder().SetBasePath(Environment.CurrentDirectory).AddIniFile("student.ini").Build(); string name = configuration["student:Name"];//如果没有节点,则直接用key进行获取即可 var age = configuration.GetValue<int>("student:Age"); var grade = configuration.GetValue<int>("student:Grade"); Console.WriteLine($"name={name},age={age},grade= {string.Join(",", grade)}"); }
注意:由于ini文件不涉及复杂的数据结构,所以直接通过索引器和GetValue即可。
读取ini文件的示例截图如下所示:
环境变量(environment variables)一般是指在操作系统中用来指定操作系统运行环境的一些参数,如:临时文件夹位置和系统文件夹位置等。环境变量相当于给系统或用户应用程序设置的一些参数,具体起什么作用这当然和具体的环境变量相关。
在win10操作系统中,此电脑-->右键-->属性-->高级系统设置-->环境变量-->然后打开环境变量对话框。如下所示:
环境变量分为用户变量【当前用户】,和系统变量【全部用户】,如下所示:
在.NetCore中读取环境变量的值,如下所示:
private static void ReadEnvironmentVariable() { IConfiguration configuration = new ConfigurationBuilder().SetBasePath(Environment.CurrentDirectory).AddEnvironmentVariables().Build(); var path = configuration["Path"]; var temp = configuration["TEMP"]; var os = configuration["OS"]; var arr = path.Split(";"); Console.WriteLine("path:"); foreach (var a in arr) { Console.WriteLine(a); } Console.WriteLine($"temp={temp}\n os= {os}"); }
读取环境变量示例截图如下所示:
看完了这篇文章,相信你对“.NetCore中如何读取配置文件”有了一定的了解,如果想了解更多相关知识,欢迎关注亿速云行业资讯频道,感谢各位的阅读!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。