【C#编程最佳实践 四】XML配置文件编写与读取实践

简介: 【C#编程最佳实践 四】XML配置文件编写与读取实践

通过项目获取的新技能,之后写xml配置应该没什么问题,当然xml文件的使用形式多种多样,之后在持续更新。

配置文件编写实践

配置文件一般用xml来写,具体关于xml文件的特性见以下这篇引用的博客,很详细了。


这里我想说一下我学到的设计

xml文件编写

<?xml version="1.0" encoding="utf-8" ?>
<CheckMetaDataConfig majorVersion="1" minorVersion="208"
    //根节点
<DataBases>
  <DataBase Name="User">
    <TableConfigs>
      <TableConfig Name="dbo.userconfig"  ConditionCode="ID,Lable,Name">
  //ConditonCode为配置的组合特征,之后需要取出来切割并调用
        <Fields>
          <Field Name="ID"  Method="Mapping" Field>
   //method为我们的比较规则
          <Field Name="Lable"  Method="Equal"></Field>
          <Field Name="Name"  Method="TenanatReplace"></Field>
          <Field Name="Application"  Method="Equal"></Field>
        </Fields>
      </TableConfig>
    </TableConfigs>
  </DataBase>
</DataBases>
</CheckMetaDataConfig>

以上的结构为,一系列的库,一系列的表,一系列的字段,每一级都可以有很多个,每个又可以有自己的属性。为了对应xml,我们需要解析,还要考虑到我们会通过库来调用表,通过表来调用字段

解析xml文件的类的编写

using User.Configuration;
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
namespace User
{
    //=============================对应根节点的类==========================================
    #region 对应根节点的类
    /// <summary>
    /// 类:对应根节点的类
    /// </summary>
    [XmlRoot("CheckMetaDataConfig")]
    public class CheckMetaDataConfig : BaseConfig<CheckMetaDataConfig>
    {
        private static readonly object LockThis = new object(); //获取锁对象
        //=============================================属性部分====================================
        [XmlArray("DataBases")]
        [XmlArrayItem("DataBase")]
        public DataBase[] DataBases { get; set; }
        //=============================================字段部分====================================
        private Dictionary<string, DataBase> _databasedic; //设置字段的字典类
        //=============================================方法部分====================================
        /// <summary>
        /// 公有方法:获取指定名称数据库的xml实例
        /// </summary>
        /// <param name="dataBaseName"></param>
        /// <returns></returns>
        public DataBase FindDatabase(string dataBaseName)
        {
            dataBaseName = dataBaseName.ToLower();
            if (_databasedic == null)
            {
                InitDatabaseDic();
            }
            return _databasedic != null && _databasedic.ContainsKey(dataBaseName) ? _databasedic[dataBaseName] : null;
        }
        /// <summary>
        /// 私有方法:初始化数据库
        /// </summary>
        private void InitDatabaseDic()
        {
            lock (LockThis)
            {
                if (_databasedic == null) //如果字典为null,则初始化字典类
                {
                    var dic = new Dictionary<String, DataBase>(); //新建一个字典类
                    foreach (var app in Instance.DataBases) //遍历该数据库
                    {
                        app.Name = app.Name.ToLower(); //将数据库名全部转为大写
                        if (string.IsNullOrEmpty(app.Name)) continue; //如果该配置文件里的数据库名字存在,则中止,进入下一个
                        if (!dic.ContainsKey(app.Name)) //如果字段名字典里不包括该实例里的数据库的名字,添加进去
                        {
                            dic.Add(app.Name, app); //把数据库名字和数据库实例以字典对的形式添加进去
                        }
                    }
                    _databasedic = dic; //把处理好的dic赋给字典,全新的字典诞生
                }
            }
        }
    }
}
#endregion 对应根节点的类
//=============================对应数据库节点的类==========================================
#region 对应数据库节点的类
/// <summary>
/// 类:数据库节点类
/// </summary>
public class DataBase
{
    private static readonly object LockThis = new object(); //获取锁对象
    //=============================================属性部分====================================
    [XmlAttribute("Name")]
    public string Name { get; set; }
    [XmlArray("TableConfigs")]
    [XmlArrayItem("TableConfig")]
    public TableConfig[] TableConfigs { get; set; }
    //=============================================字段部分====================================
    private Dictionary<string, TableConfig> _tableDic;
    //=============================================方法部分====================================
    /// <summary>
    ///公有方法: 获取指定名称的数据表
    /// </summary>
    /// <param name="tableName"></param>
    /// <returns></returns>
    public TableConfig FindTable(string tableName)
    {
        tableName = tableName.ToLower();
        if (_tableDic == null)
        {
            InitTableDic();
        }
        return _tableDic != null && _tableDic.ContainsKey(tableName) ? _tableDic[tableName] : null;
    }
    /// <summary>
    /// 私有方法:初始化数据表的信息
    /// </summary>
    private void InitTableDic()
    {
        lock (LockThis)
        {
            if (_tableDic == null) //如果字典为null,则初始化字典类
            {
                var dic = new Dictionary<String, TableConfig>(); //新建一个字典类
                foreach (var app in TableConfigs) //遍历该表集合
                {
                    app.Name = app.Name.ToLower(); //将数据表名全部转为大写
                    if (string.IsNullOrEmpty(app.Name)) continue; //如果该配置文件里的数据库名字存在,则中止,进入下一个
                    if (!dic.ContainsKey(app.Name)) //如果字段名字典里不包括该实例里的数据表的名字,添加进去
                    {
                        dic.Add(app.Name, app); //把数据表名字和数据表实例以字典对的形式添加进去
                    }
                }
                _tableDic = dic; //把处理好的dic赋给字典,全新的字典诞生
            }
        }
    }
}
#endregion 对应数据库节点的类
//=============================对应数据表节点的类==========================================
#region 对应数据表节点的类
/// <summary>
/// 类:数据表节点类
/// </summary>
public class TableConfig
{
    private static readonly object LockThis = new object(); //获取锁对象
    //=============================================属性部分====================================
    [XmlAttribute("Name")]
    public string Name { get; set; }
    [XmlAttribute("ConditionCode")]
    public string ConditionCode { get; set; }
    [XmlArray("Fields")]
    [XmlArrayItem("Field")]
    public Field[] Fields { get; set; }
    //=============================================字段部分====================================
    private Dictionary<String, string> _conditionCodDic;
    //=============================================方法部分====================================
    /// <summary>
    /// 公有方法:获取特征码
    /// </summary>
    /// <returns></returns>
    public Dictionary<String, string> GetConditionCodeDic()
    {
        if (_conditionCodDic == null)
        {
            InitConditionCodeDic();
        }
        return _conditionCodDic;
    }
    /// <summary>
    /// 私有方法: 初始化特征码
    /// </summary>
    private void InitConditionCodeDic()
    {
        lock (LockThis)
        {
            if (_conditionCodDic == null) //如果字典为null,则初始化字典类
            {
                var dic = new Dictionary<string, string>(); //新建一个字典类
                var strs = ConditionCode.Split(new[] { "," }, StringSplitOptions.RemoveEmptyEntries);
                //不保留空元素,获取到特征值字段集合
                foreach (var s in strs)
                {
                    dic.Add(s, null);
                }
                _conditionCodDic = dic; //把处理好的dic赋给字典,全新的字典诞生
            }
        }
    }
}
#endregion 对应数据表节点的类
//=============================对应字段节点的类==========================================
#region 对应字段节点的类
/// <summary>
/// 类: 字段类
/// </summary>
public class Field
{
    //=============================================属性部分====================================
    [XmlAttribute("Name")]
    public string Name { get; set; }
    [XmlAttribute("Method")]
    public string Method { get; set; }
}
#endregion 对应字段节点的类

以上代码类似InitTableDic用到的初始化方式可以大大减少访问次数,如果存在就不需要再次获取

调用xml文件类

var dataDaseConfig = CheckMetaDataConfig.Instance.FindDatabase(MetaDataBaseName);  //获取一个配置文件中数据库节点实例

踩过的坑

1,xml解析类编写的时候,字典类的访问修饰符必须是private:private Dictionary<String, string> _conditionCodDic;

2,xml解析类尽量不要出现子类,要写为同级的

3,注意xml文件名必须和xml解析类必须同名

相关文章
|
6月前
|
XML 前端开发 C#
C#编程实践:解析HTML文档并执行元素匹配
通过上述步骤,可以在C#中有效地解析HTML文档并执行元素匹配。HtmlAgilityPack提供了一个强大而灵活的工具集,可以处理各种HTML解析任务。
323 19
|
12月前
|
存储 Java 文件存储
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— logback.xml 配置文件解析
本文解析了 `logback.xml` 配置文件的详细内容,包括日志输出格式、存储路径、控制台输出及日志级别等关键配置。通过定义 `LOG_PATTERN` 和 `FILE_PATH`,设置日志格式与存储路径;利用 `&lt;appender&gt;` 节点配置控制台和文件输出,支持日志滚动策略(如文件大小限制和保存时长);最后通过 `&lt;logger&gt;` 和 `&lt;root&gt;` 定义日志级别与输出方式。此配置适用于精细化管理日志输出,满足不同场景需求。
2877 1
|
7月前
|
监控 算法 C#
C#与Halcon联合编程实现鼠标控制图像缩放、拖动及ROI绘制
C#与Halcon联合编程实现鼠标控制图像缩放、拖动及ROI绘制
1354 0
|
XML Java 数据格式
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
|
存储 安全 编译器
学懂C#编程:属性(Property)的概念定义及使用详解
通过深入理解和使用C#的属性,可以编写更清晰、简洁和高效的代码,为开发高质量的应用程序奠定基础。
1169 12
|
设计模式 C# 图形学
Unity 游戏引擎 C# 编程:一分钟浅谈
本文介绍了在 Unity 游戏开发中使用 C# 的基础知识和常见问题。从 `MonoBehavior` 类的基础用法,到变量和属性的管理,再到空引用异常、资源管理和性能优化等常见问题的解决方法。文章还探讨了单例模式、事件系统和数据持久化等高级话题,旨在帮助开发者避免常见错误,提升游戏开发效率。
629 4
|
开发框架 前端开发 .NET
C#编程与Web开发
【4月更文挑战第21天】本文探讨了C#在Web开发中的应用,包括使用ASP.NET框架、MVC模式、Web API和Entity Framework。C#作为.NET框架的主要语言,结合这些工具,能创建动态、高效的Web应用。实际案例涉及企业级应用、电子商务和社交媒体平台。尽管面临竞争和挑战,但C#在Web开发领域的前景将持续拓展。
603 3
|
SQL 开发框架 安全
C#编程与多线程处理
【4月更文挑战第21天】探索C#多线程处理,提升程序性能与响应性。了解C#中的Thread、Task类及Async/Await关键字,掌握线程同步与安全,实践并发计算、网络服务及UI优化。跟随未来发展趋势,利用C#打造高效应用。
442 3
|
C# 开发者
C# 一分钟浅谈:Code Contracts 与契约编程
【10月更文挑战第26天】本文介绍了 C# 中的 Code Contracts,这是一个强大的工具,用于通过契约编程增强代码的健壮性和可维护性。文章从基本概念入手,详细讲解了前置条件、后置条件和对象不变量的使用方法,并通过具体代码示例进行了说明。同时,文章还探讨了常见的问题和易错点,如忘记启用静态检查、过度依赖契约和性能影响,并提供了相应的解决建议。希望读者能通过本文更好地理解和应用 Code Contracts。
350 3
|
安全 程序员 编译器
C#一分钟浅谈:泛型编程基础
在现代软件开发中,泛型编程是一项关键技能,它使开发者能够编写类型安全且可重用的代码。C# 自 2.0 版本起支持泛型编程,本文将从基础概念入手,逐步深入探讨 C# 中的泛型,并通过具体实例帮助理解常见问题及其解决方法。泛型通过类型参数替代具体类型,提高了代码复用性和类型安全性,减少了运行时性能开销。文章详细介绍了如何定义泛型类和方法,并讨论了常见的易错点及解决方案,帮助读者更好地掌握这一技术。
317 11

相关课程

更多