广告

扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > ASP.NET >.NetCore基础之读取配置文件详解
  • 294

0
分享到

.NetCore基础之读取配置文件详解

2024-04-02 19:04:59 294人浏览 泡泡鱼
摘要

目录涉及知识点安装插件读取JSON文件1. 准备数据2. 创建IConfiguration接口实例3. 通过索引器进行读取4. 通过GetValue<T>()方法进行读取

在应用程序开发中，配置文件是主要存储系统的初始配置信息，配置文件的读取虽然属于基础内容却又经常用到，所以百丈高楼平地起，学习.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文件

1. 准备数据

首先准备一个Json文件，如下所示：

{
  "Name": "Alan.hsiang",
  "Age": 20,
  "Sex": "male",
  "Like": ["basketball","football","swimming"],
  "Score": {
    "LandLit": 90,
    "Mathematics": 99,
    "English": 50
  }
}

2. 创建IConfiguration接口实例

在.Net Core中，读取配对文件是通过IConfiguration接口操作的，实例化接口对象如下所示：

IConfiguration configuration = new ConfigurationBuilder().SetBasePath(Environment.CurrentDirectory).AddJsonFile("student.json").Build();

3. 通过索引器进行读取

默认情况下，IConfiguration接口提供了索引器，以Key为参数进行读取，返回字符串对象，如下所示：

 var name = configuration["Name"]; //IConfiguration接口自带的索引器，只返回字符串类型。如：名字
 var like0 = configuration["Like:0"];//读取数组中第一个元素 如：第一个爱好
 var like2 = configuration["Like:2"];//读取数组中第三个元素 如：第三个爱好
 var landLit = configuration["Score:LandLit"];//获取字节点的属性值，如：语文成绩

注意：如果Json数据有层级关系，则通过冒号【:】进行表示。

4. 通过GetValue<T>()方法进行读取

通过索引器只能返回字符串类型的值，如果需要读取其他简单类型的对象，如：int,float等，则可以通过GetValue<T>()方法进行，具体如下所示：

 var age = configuration.GetValue<int>("Age");//获取其他数据类型，如：int，如：年龄

5. 读取数组

通过索引器和泛型方法，可以读取简单类型的对象，如果需要读取复杂对象【如：数组，列表等】，则需要使用绑定，如下所示：

 //获取整个数组，如：爱好
 var like = new List<string>();
 configuration.Bind("Like",like);

6. 整体对象绑定

以上示例都是对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}");

7. Json示例截图

读取XML文件

在应用程序开发中，XML文件也是比较常用的一种配置文件。对XML文件的读取操作和Json文件操作基本相似，具体如下所示：

1. 创建XML文件

首先创建一个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>

2. 简单读取

通过索引器和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中是三个节点。

3. 读取数组

读取XML中的数组列表，如下所示：

 //获取整个数组，如：爱好
 var like = new List<string>();
 configuration.Bind("Likes:Like", like);
 Console.WriteLine($"name={name},age={age},like= {string.Join(",", like)}");

4. 整体绑定对象

以上示例都是对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}");

5. 示例截图

注意：通过示例方向，读取XML和读取Json文件，存在细微的差异。

读取INI文件

ini文件在C#程序中，一般应用的不是很多，主要是键值对文件，主要用于存储简单的数据格式，如下所示：

1. 创建ini文件

一般情况下，ini文件包括以下几个部分：a. 注释 用分号做前缀，b. 节点用中括号表示，c. key=value表示内容。如下所示：

 ;此处表示注释 
 [student]
 Name=Alan.hsiang
 Age=20
 Grade=4

2. 创建配置并读取

在.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即可。

3. 示例截图

读取ini文件的示例截图如下所示：

 读取环境变量

环境变量（environment variables）一般是指在操作系统中用来指定操作系统运行环境的一些参数，如：临时文件夹位置和系统文件夹位置等。环境变量相当于给系统或用户应用程序设置的一些参数，具体起什么作用这当然和具体的环境变量相关。

1. 查看环境变量

在win10操作系统中，此电脑-->右键-->属性-->高级系统设置-->环境变量-->然后打开环境变量对话框。如下所示：

环境变量分为用户变量【当前用户】，和系统变量【全部用户】，如下所示：

2. 简单读取 

在.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}");
}

3. 示例截图

读取环境变量示例截图如下所示：

备注

以上是在.Net Core中读取几种常见数据的方式

到此这篇关于.netcore基础之读取配置文件详解的文章就介绍到这了,更多相关.Net Core 读取配置文件内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: .NetCore基础之读取配置文件详解

本文链接: https://www.lsjlt.com/news/141503.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档
去做题
猜你喜欢
  • .NetCore基础之读取配置文件详解
    目录涉及知识点安装插件读取Json文件1. 准备数据2. 创建IConfiguration接口实例3. 通过索引器进行读取4. 通过GetValue<T>()方法进行读取...
    99+
    2022-11-13
  • .NETCore读取配置文件
    1. 说明 默认情况下读取配置Configuration的默认优先级：ConfigureAppConfiguration(自定义读取)>CommandLine(命令行参数)&g...
    99+
    2022-11-13
  • .NetCore中如何读取配置文件
    小编给大家分享一下.NetCore中如何读取配置文件，希望大家阅读完这篇文章之后都有所收获，下面让我们一起去探讨吧！在应用程序开发中，配置文件是主要存储系统的初始配置信息，配置文件的读取虽然属于基础内容却又经常用到，所以百丈高楼平地起，学习...
    99+
    2023-06-29
  • SpringBootyml配置文件读取方法详解
    目录yaml介绍yaml语法规则yaml数据读取Environment读取yaml全部属性数据自定义对象封装指定数据yaml介绍 YAML（YAML Ain't Markup...
    99+
    2022-11-13
    SpringBoot读取yml配置 SpringBoot yml读取
  • 详解Python读取配置文件模块ConfigParser
    1，ConfigParser模块简介 假设有如下配置文件，需要在Pyhton程序中读取 $ cat config.ini [db] db_port = 3306 db_user = root db_h...
    99+
    2022-06-04
    配置文件 详解 模块
  • Python数据分析基础之文件的读取
    目录一·Numpy库中操作文件1.操作csv文件2.在pycharm中操作csv文件3.其他情况(.npy类型文件)二·Pandas库中操作文件1.操作csv文件2.从剪贴板上复制数...
    99+
    2022-11-12
  • python学习之读取配置文件
    前言： 最近在接触利用python来写测试框架，本人也是个刚接触python，所以是个小菜鸟，今天开始，一点点的记录学习中的积累，方便以后的学习以及回顾，也希望能帮助跟我一样的小菜鸟...
    99+
    2022-11-10
  • Android读取properties配置文件的实例详解
    Android读取properties配置文件的实例详解因为一些配置信息，多处用到的。且以后可能变更的，我想写个.prorperties配置文件给管理起来。我把配置文件放在了assets文件夹下appConfig.properties：se...
    99+
    2023-05-30
    android properties roi
  • go学习笔记读取consul配置文件详解
    目录新建yaml文件读取远程配置新建yaml文件 在上文我们的 go学习笔记:使用 consul 做服务发现和配置共享 这里我们单独来用viper实现读取consul的配置...
    99+
    2022-11-13
  • python基础教程之csv文件的写入与读取
    目录csv的简单介绍csv的写入第一种写入方法(通过创建writer对象)第二种写入方法(使用DictWriter可以使用字典的方式将数据写入)csv的读取通过reader()读取通...
    99+
    2022-11-11
  • 一文详解Spring是怎么读取配置Xml文件的
    目录Spring读取配置文件DocumentElementDocumentDefaultsDefinitionSpring读取配置文件Document 在XmlBeanDefinit...
    99+
    2022-11-13
  • Python学习之文件的读取详解
    目录文件读取的模式文件对象的读取方法使用 read() 函数一次性读取文件全部内容使用 readlines() 函数 读取文件内容使用 readline() 函数 逐行读取文件内容m...
    99+
    2022-11-13
  • 详解SpringBoot读取Yml配置文件的3种方法
    目录简述：1.基础用法，使用注解@Autowired注入Environment类2.基础用法，使用@Value注解直接注入配置信息3.进阶方法简述： 项目开发中难免要读取配置文件，本...
    99+
    2023-05-14
    SpringBoot读取Yml配置文件 SpringBoot读取Yml
  • shell读取配置文件的方式sed命令详解
    在编写启动脚本时，涉及到读取配置文件，特地记录下shell脚本读取启动文件的方式。主要提供两种格式的读取方式，方式一配置文件采用“[]”进行分区，方式二配置文件中需要有唯一的配置项名称。 配置文件...
    99+
    2023-04-14
    shell读取配置文件 shell sed命令
  • Spring中xml配置文件的基础使用方式详解
    目录1. xml配置文件的读取1.1 通过类路径读取配置文件1.2 通过文件系统绝对路径读取配置文件1.3使用BeanFactory接口读取配置文件2.带参构造对象的创建(const...
    99+
    2022-11-13
  • Python学习之yaml文件的读取详解
    目录yaml 文件的应用场景与格式介绍yaml 文件的应用场景yaml 文件的格式第三方包 - pyyaml读取 yaml 文件的方法yaml文件读取演示案例yaml 文件的应用场景...
    99+
    2022-11-13
  • python数据分析之文件读取详解
    目录前言：一·Numpy库中操作文件二·Pandas库中操作文件三·补充总结前言： 如果你使用的是Anaconda中的Jupyter，则不需要下载Pands和Numpy库；如果你使用...
    99+
    2022-11-12
  • python基础教程之csv格式文件的写入与读取
    目录csv的简单介绍csv的写入第一种写入方法(通过创建writer对象)第二种写入方法(使用DictWriter可以使用字典的方式将数据写入)csv的读取通过reader()读取通...
    99+
    2022-11-13
  • SpringBoot 常用读取配置文件的三种方法详解
    目录前言一、使用 @Value 读取配置文件二、使用 @ConfigurationProperties 读取配置文件1、类上添加@Configuration注解2、使用@Enable...
    99+
    2022-11-13
  • MySQL之my.cnf配置文件图文详解
    目录引言问题1.mysql.server，mysqld，mysqld_safe的区别mysql.servermysql_safe问题2.mysql的三种启动方式:问题3.socket...
    99+
    2022-11-13
软考高级职称资格查询
软考职称历年真题下载
软考职称资料下载
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作