封装一个配置解析方法，快速打造你的 .NET FrameWork 配置系统

代码掌控者

于 2025-02-27 17:43:23 发布

阅读量713

点赞数 15

分类专栏： C# 文章标签： .net c# 编程技巧配置系统

本文链接：https://blog.youkuaiyun.com/yangshuquan/article/details/145909915

版权

C# 专栏收录该内容

118 篇文章

订阅专栏

Coding-73

前言

嘿，各位程序员小伙伴们！

在我们实际的项目开发中，配置管理就像是系统的“心脏”，不能或缺。

一个系统要能够很好地运转，离不开各种各样的配置参数，比如数据库连接字符串等等。

那么，如何高效地管理这些配置参数呢？

当然，我们不能直接将它们硬编码在代码里，因为那样会给后期维护带来麻烦。

最佳实践是将这些配置信息存放在外部文件中，比如 XML 文件或 JSON 文件，甚至是数据库中，这样不仅便于维护，还能提高程序的灵活性和扩展性。

在 .NET Core 中，我们有着强大的配置功能，可以轻松处理这些任务。

然而，对于 .NET Framework 来说，默认的配置功能就显得有些“拧巴”了，仅能简单地读取 Key-Value 数据。

为此，本文将教你如何基于 XML 文件，快速构建一个适用于 .NET Framework 的自定义配置系统。

话不多说，我们开始吧！

封装方法

封装一个方法，用于读取、解析和反序列化配置文件，留意代码注释

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Xml.Serialization;

namespace Common.Util
{
    /// <summary>
    /// 配置文件序列化/反序列化工具类
    /// </summary>
    public static class ConfigUtil
    {
        /// <summary>
        /// 反序化化 XML 为指定类型
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="configfilePath">配置文件路径</param>
        /// <returns></returns>
        /// <exception cref="FileNotFoundException"></exception>
        public static T Deserialize<T>(string configfilePath)
        {
            // 记录配置文件的路径，有问题帮助定位
            // Logger.DEFAULT.InfoFormat("The config file path is [{0}]", configfilePath);

            // 1. 判断配置文件是否存在
            if (!File.Exists(configfilePath))
            {
                throw new FileNotFoundException(string.Format("[{0}] does not exists!", configfilePath));
            }

            // 2. 读取配置文件内容并反序列化
            using (Stream fStream = new FileStream(configfilePath, FileMode.Open, FileAccess.Read))
            {
                // 定位文件流在起始点
                fStream.Position = 0;
                XmlSerializer xmlFormat = new XmlSerializer(typeof(T));
                return (T)xmlFormat.Deserialize(fStream);
            }
        }
    }
}

Step By Step 详细例子

1. 创建项目

首先，创建一个 .NET FrameWork 控制台应用程序项目，命名为 ConfigMgrDemo

2. 创建配置文件

接下来，需要创建一个配置文件如 democfg.config，用于存储相关配置信息，假设内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <Host>
        <URL>192.168.0.120</URL>
        <LoginUser>Jacky</LoginUser>
        <Password>+6nkUhDs5lmcfMYS/qe7Qw==</Password>
    </Host>
    <AdminUser>Admin</AdminUser>
</configuration>

3. 创建配置文件实体类

接着，创建一个配置文件实体类 CfgModel，确保实体成员与配置文件中的节点一致，留意代码注释

using System.Xml.Serialization;

namespace ConfigMgrDemo
{
    /// <summary>
    /// 配置文档根节点相应的实体
    /// 使用 XmlRoot 将实体与配置文档根节点关联
    /// </summary>
    [XmlRoot("configuration")]
    public class CfgModel
    {
        /// <summary>
        /// Host 信息
        /// 如果属性名称跟配置文档节点名称不一致，使用 XmlElement 映射属性到文档节点名称
        /// </summary>
        [XmlElement("Host")]
        public HostSetting Host { get; set; }

        /// <summary>
        /// 管理员
        /// 如果属性名称跟配置文档节点名称一致，可不使用 XmlElement
        /// </summary>
        public string AdminUser { get; set; }
    }

    /// <summary>
    /// 配置文档中的 Host 节点元素实体类
    /// </summary>
    public class HostSetting
    {
        /// <summary>
        /// 服务器 URL
        /// </summary>
        public string URL { get; set; }

        /// <summary>
        /// 登录账号
        /// </summary>
        public string LoginUser { get; set; }

        /// <summary>
        /// 登录密码
        /// </summary>
        public string Password { get; set; }
    }
}

4. 应用封装方法

在 Program.cs 中使用这个封装方法来读取配置文件

using Common.Util;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConfigMgrDemo
{
    public class Program
    {
        static void Main(string[] args)
        {
            string configfilePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "democfg.config");
            var result = ConfigUtil.Deserialize<CfgModel>(configfilePath);
            Console.WriteLine($"Host URL is [{result.Host.URL}]");
            Console.WriteLine($"AdminUser is [{result.AdminUser}]");
        }
    }
}