首页 > 其他分享 >.NET配置文件大揭秘:轻松读取JSON、XML、INI和环境变量

.NET配置文件大揭秘:轻松读取JSON、XML、INI和环境变量

时间:2024-02-20 09:05:35浏览次数:36  
标签:XML 文件 string 配置文件 JSON IConfigurationRoot config public 读取

 

概述:.NET中的IConfiguration接口提供了一种多源读取配置信息的灵活机制,包括JSON、XML、INI文件和环境变量。通过示例,清晰演示了从这些不同源中读取配置的方法,使配置获取变得方便且易于扩展。这种方式适用于不同场景,如API密钥、数据库连接等,为应用提供了高度可配置性。

在.NET中,IConfiguration接口提供了一种灵活的方式来管理和读取应用程序配置信息。这可以包括来自不同源的配置信息,如JSON、XML、INI文件以及环境变量。

读取JSON文件:

JSON文件通常用于保存结构化的配置信息,例如Web应用的设置、API密钥等。

JSON文件内容如下:

{
  "AppSettings": {
    "ApiKey": "your_api_key",
    "LogLevel": "Info"
  },
  "DatabaseSettings": {
    "ConnectionString": "your_connection_string",
    "TimeoutSeconds": 30
  }
}

实例描述:

using Microsoft.Extensions.Configuration;
using System;

public class JsonConfigReader
{
    public static IConfigurationRoot ReadJsonFile(string filePath)
    {
        try
        {
            // 创建ConfigurationBuilder
            var builder = new ConfigurationBuilder();

            // 添加Json文件作为配置源
            builder.AddJsonFile(filePath);

            // 构建IConfigurationRoot
            IConfigurationRoot config = builder.Build();

            return config;
        }
        catch (Exception ex)
        {
            Console.WriteLine($"读取JSON文件失败: {ex.Message}");
            return null;
        }
    }
}

使用示例:

public class Program
{
    public static void Main()
    {
        // 指定JSON文件路径
        string jsonFilePath = "appsettings.json";

        // 读取JSON文件内容
        IConfigurationRoot config = JsonConfigReader.ReadJsonFile(jsonFilePath);

        if (config != null)
        {
            // 获取配置项
            string apiKey = config["AppSettings:ApiKey"];
            string connectionStr = config["DatabaseSettings:ConnectionString"];

            Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
        }
    }
}

读取XML文件:

XML文件常用于保存包含大量元数据的配置信息,例如Windows应用程序配置。

XML文件内容如下:

<configuration>
  <AppSettings>
    <ApiKey>your_api_key</ApiKey>
    <LogLevel>Info</LogLevel>
  </AppSettings>
  <DatabaseSettings>
    <ConnectionString>your_connection_string</ConnectionString>
    <TimeoutSeconds>30</TimeoutSeconds>
  </DatabaseSettings>
</configuration>

实例描述:

using Microsoft.Extensions.Configuration;
using System;

public class XmlConfigReader
{
    public static IConfigurationRoot ReadXmlFile(string filePath)
    {
        try
        {
            // 创建ConfigurationBuilder
            var builder = new ConfigurationBuilder();

            // 添加Xml文件作为配置源
            builder.AddXmlFile(filePath);

            // 构建IConfigurationRoot
            IConfigurationRoot config = builder.Build();

            return config;
        }
        catch (Exception ex)
        {
            Console.WriteLine($"读取XML文件失败: {ex.Message}");
            return null;
        }
    }
}

使用示例:

public class Program
{
    public static void Main()
    {
        // 指定XML文件路径
        string xmlFilePath = "appsettings.xml";

        // 读取XML文件内容
        IConfigurationRoot config = XmlConfigReader.ReadXmlFile(xmlFilePath);

        if (config != null)
        {
            // 获取配置项
            string apiKey = config["AppSettings:ApiKey"];
            string connectionStr = config["DatabaseSettings:ConnectionString"];

            Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
        }
    }
}

读取INI文件:

INI文件是一种简单的配置文件格式,通常用于保存简单的键值对配置。

INI文件内容如下:

[AppSettings]
ApiKey=your_api_key
LogLevel=Info

[DatabaseSettings]
ConnectionString=your_connection_string
TimeoutSeconds=30

实例描述:

using Microsoft.Extensions.Configuration;
using System;

public class IniConfigReader
{
    public static IConfigurationRoot ReadIniFile(string filePath)
    {
        try
        {
            // 创建ConfigurationBuilder
            var builder = new ConfigurationBuilder();

            // 添加Ini文件作为配置源
            builder.AddIniFile(filePath);

            // 构建IConfigurationRoot
            IConfigurationRoot config = builder.Build();

            return config;
        }
        catch (Exception ex)
        {
            Console.WriteLine($"读取INI文件失败: {ex.Message}");
            return null;
        }
    }
}

使用示例:

public class Program
{
    public static void Main()
    {
        // 指定INI文件路径
        string iniFilePath = "appsettings.ini";

        // 读取INI文件内容
        IConfigurationRoot config = IniConfigReader.ReadIniFile(iniFilePath);

        if (config != null)
        {
            // 获取配置项
            string apiKey = config["AppSettings:ApiKey"];
            string connectionStr =

 config["DatabaseSettings:ConnectionString"];

            Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
        }
    }
}

读取环境变量:

环境变量通常用于存储敏感信息,如API密钥或数据库连接字符串。

实例描述:

using Microsoft.Extensions.Configuration;
using System;

public class EnvConfigReader
{
    public static IConfigurationRoot ReadEnvironmentVariables()
    {
        try
        {
            // 创建ConfigurationBuilder
            var builder = new ConfigurationBuilder();

            // 添加环境变量作为配置源
            builder.AddEnvironmentVariables();

            // 构建IConfigurationRoot
            IConfigurationRoot config = builder.Build();

            return config;
        }
        catch (Exception ex)
        {
            Console.WriteLine($"读取环境变量失败: {ex.Message}");
            return null;
        }
    }
}

使用示例:

public class Program
{
    public static void Main()
    {
        // 读取环境变量内容
        IConfigurationRoot config = EnvConfigReader.ReadEnvironmentVariables();

        if (config != null)
        {
            // 获取配置项
            string apiKey = config["AppSettings:ApiKey"];
            string connectionStr = config["DatabaseSettings:ConnectionString"];

            Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
        }
    }
}

以上代码提供了使用IConfiguration读取JSON、XML、INI文件以及环境变量的通用方法,使得配置信息的获取更加灵活和便捷。

 

标签:XML,文件,string,配置文件,JSON,IConfigurationRoot,config,public,读取
From: https://www.cnblogs.com/hanbing81868164/p/18022302

相关文章

  • 解决MyBatis Mapper 的XML文件SQL语句无法自动提示问题
    一、问题1.问题场景IDEA中MyBatis编写mapper的SQL语句的时候无法提示SQL和数据库2.问题描述无法正常方便的使用IDEA的提示功能,更准确无误的编写代码3.本解决方案优势亲测可用,一劳永逸(IDEA版本IntelliJIDEA2021.1.3 )目的在于对Mybatis的Mapper.XML中sql语句进行提示......
  • Json 递归解析算法笔记
    需求:最近需要处理包含多层的Json字符串解析的问题,比如需要将所有的键值对的值替换,或者将键值对的键替换,包括嵌套对象里面的。大致知道需要使用递归来操作,先记录大致步骤吧。思路:写好一个固定的函数专门处理替换步骤;在这个函数内分别判断值是数组,还是对象,还是值(值走上面的递......
  • FastJSON学习
    第一节:JSON数据格式回顾 JSON的数组格式:运行:结果:  JSON的对象格式:运行: 结果: ......
  • nvm list available 命令执行异常 Could not retrieve https://npm.taobao.org/mirror
    异常:无法连接镜像地址 解决方法在nvm的安装位置找到文件settings.txt,修改镜像地址修改前 修改后保存再次运行命令 ......
  • 【c&c++】cJSON详解
    一、JSON概述1.1JSON介绍JSON:JavaScript对象表示法(JavaScriptObjectNotation)。是一种轻量级的数据交换格式。它基于ECMAScript的一个子集。JSON采用完全独立于语言的文本格式,但是也使用了类似C语音家族的习惯(包括C、C++、C#、Java、JavaScript、Perl、Python等)。这些特性使JSON......
  • 生成离线的XML
    之前遇到了一个需求,原本的一个XML打开时需要依赖于多个文件,现在想要将这个文件做成一个离线可用文件我的第一反应是将XML以及依赖文件打个包,下载包后,用浏览器打开XML文件,依赖文件与XML文件在同一个目录,应该就可以了XML中引用的xsl代码如下:但万万没想到,用浏览器打开本地XML文件......
  • odoo jsonrpc
    importjsonimportpprintimportrandomimporturllib.requestHOST='192.168.2.21'PORT=8069DB='wywr17'#数据库名称USER=''#登录用户名PASS=''#登录密码defjson_rpc(url,method,params):data={"......
  • JSON相关注解的使用
    1.@JsonInclude当使用json进行序列化时,往往会遇到某个实体对象的属性为null,可以使用如下类注解使得属性值为null的时候Java Bean不参与序列化可以作用在类上,也可以作用在字段上@JsonInclude(JsonInclude.Include.NON_NULL)     其他常量值包括:Include.Include.ALWAYS   ......
  • MyBatis-Plus--在xml中使用wrapper的方法
    原文网址:​​MyBatis-Plus--在xml中使用wrapper的方法_IT利刃出鞘的博客-CSDN博客​​简介本文介绍MyBatis-Plus如何在xml中使用wrapper。分享Java技术星球(自学精灵):​​https://learn.skyofit.com​​ServiceQueryWrapper<T>wrapper=newQueryWrapper<T>();wrapper.eq("......
  • Debug: tf-distribute-strategy-worker: json.decoder.JSONDecodeError: Expecting pr
    [ERROR:json.decoder.JSONDecodeError:Expectingpropertynameenclosedindoublequotes:line1column182]#infilepipeline.yaml-name:TF_CONFIGvalue:"{\"cluster\":{\"worker\":[\"dist-s......