物理文件是我们最常用到的原始配置的载体,最佳的配置文件格式主要由三种,它们分别是JSON、XML和INI,对应的配置源类型分别是JsonConfigurationSource、XmlConfigurationSource和IniConfigurationSource。但是对于.NET Core的配置系统来说,我们习以为常的XML反倒不是理想的配置源,至少和JSON比较起来,它具有一个先天不足的劣势,那就是针对集合数据结构的支持不如人意。[ 本文已经同步到《ASP.NET Core框架揭秘》之中]
一、为什么针对集合的配置难以通过优雅的XML来表示
在《配置模型设计详解》一文中我们对配置模型的设计和实现进行了详细介绍。在此文中我们说应用中的配置体现为一种树形化的层次结构,所我将它称为“配置树”,具体的配置数据通过配置树的“叶子节点”承载。当配置数据从不同的来源加载之后都会转换成一个字典,我将其称为“配置字典”。为了让“配置字典”能够存储“配置树”的所有数据和自身结构,我们需要在配置字典中存储所有叶子节点,叶子节点的路径和值将直接作为字典元素的Key和Value。由于字典的Key是唯一的,这就要求配置树中的每一个节点必须具有唯一的路径。XmlConfigurationSource/XmlConfigurationProvider不能很好地支持集合数据结构的问题就出现在这里。
1: public class Profile
2: {
3: public Gender Gender { get; set; }
4: int Age { get; set; }
5: public ContactInfo ContactInfo { get; set; }
6: }
7:
8: class ContactInfo
9: {
10: string EmailAddress { get; set; }
11: string PhoneNo { get; set; }
12: }
13:
14: enum Gender
15: {
16: Male,
17: Female
18: }
举个简单的例子,假设需要采用XML来表示一个Profile对象的集合(Profile的类型具有如上所示的定义),那么我们很自然地会采用如下的结构。
class ExtendedXmlConfigurationProvider : XmlConfigurationProvider
4: {}
override void Load(Stream stream)
8: //加载源文件并创建一个XmlDocument
10: sourceDoc.Load(stream);
12: //添加索引
14:
16: XmlDocument newDoc = 17: XmlElement documentElement = newDoc.CreateElement(sourceDoc.DocumentElement.Name);
19:
20: foreach (XmlElement element in sourceDoc.DocumentElement.ChildNodes)
21: {
22: this.Rebuild(element,documentElement,1)'> 23: name => newDoc.CreateElement(name));
24: }
25:
26: //根据新的XmlDocument初始化配置字典
27: using (Stream newStream = new MemoryStream())
28: {
29: using (XmlWriter writer = XmlWriter.Create(newStream))
30: {
31: newDoc.WriteTo(writer);
32: }
33: newStream.Position = 0;
34: base.Load(newStream);
35: }
36: }
37:
38: private void AddIndexes(XmlElement element)
39: {
40: if (element.ChildNodes.OfType<XmlElement>().Count() > 1)
41: {
42: if (element.ChildNodes.OfType<XmlElement>().GroupBy(it => it.Name).Count() == 1)
43: {
44: int index = 0;
45: foreach (XmlElement subElement in element.ChildNodes)
46: {
47: subElement.SetAttribute("append_index",(index++).ToString());
48: AddIndexes(subElement);
49: }
50: }
51: }
52: }
53:
54: void Rebuild(XmlElement source,XmlElement destParent,Func<string,XmlElement> creator)
55: {
56: string index = source.GetAttribute("append_index");
57: string elementName = string.IsNullOrEmpty(index) ? source.Name : $"{source.Name}_index_{index}";
58: XmlElement element = creator(elementName);
59: destParent.AppendChild(element);
60: foreach (XmlAttribute attribute in source.Attributes)
61: {
62: if (attribute.Name != "append_index")
63: {
64: element.SetAttribute(attribute.Name,attribute.Value);
65: }
66: }
67:
68: in source.ChildNodes)
69: {
70: Rebuild(subElement,element,creator);
71: }
72: }
73: }
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。