序列化集合并遵守代码分析

Question

在现有项目上运行代码分析时，我遇到了消息不要公开通用列表和集合属性应该是只读的。 但是，该类用于读取/写入 xml 配置文件。 是否有可能使这个类符合CA1002 和CA2227 或者我必须为 XML 相关类禁止这些规则（项目中有很多）？

编辑

将 List<string> 更改为 Collection<string> 解决了 CA1002。 仍然不知道如何解决 CA2227 并且仍然能够（反）序列化整个事情。

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Xml.Serialization;

/// <summary>
/// Class containing the Configuration Storage
/// </summary>
[XmlRoot("Configuration")]
public class ConfigurationStorage
{
    /// <summary>
    /// Gets or sets the list of executers.
    /// </summary>
    [XmlArray("Executers")]
    [XmlArrayItem("Executer")]
    public Collection<string> Executers { get; set; }

    /// <summary>
    /// Gets or sets the list of IPG prefixes.
    /// </summary>
    [XmlArray("IpgPrefixes")]
    [XmlArrayItem("IpgPrefix")]
    public Collection<string> IpgPrefixes { get; set; }

}

读取 xml 文件：

    public static ConfigurationStorage LoadConfiguration()
    {
        if (File.Exists(ConfigFile))
        {
            try
            {
                using (TextReader r = new StreamReader(ConfigFile))
                {
                    var s = new XmlSerializer(typeof(ConfigurationStorage));
                    var config = (ConfigurationStorage)s.Deserialize(r);
                    return config;
                }
            }
            catch (InvalidOperationException invalidOperationException)
            {
                throw new StorageException(
                    "An error occurred while deserializing the configuration XML file.", invalidOperationException);
            }
        }
    }

Answer 1

怎么样：

/// <summary>
/// Class containing the Configuration Storage
/// </summary>
[XmlRoot("Configuration")]
public class ConfigurationStorage {
  /// <summary>
  /// Gets or sets the list of executers.
  /// </summary>
  [XmlArray("Executers")]
  [XmlArrayItem("Executer")]
  public Collection<string> Executers { get; private set; }

  /// <summary>
  /// Gets or sets the list of IPG prefixes.
  /// </summary>
  [XmlArray("IpgPrefixes")]
  [XmlArrayItem("IpgPrefix")]
  public Collection<string> IpgPrefixes { get; private set; }

  public ConfigurationStorage() {
    Executers = new Collection<string>();
    IpgPrefixes = new Collection<string>();
  }
}

这仍然适用于 xml 序列化/反序列化。

Answer 2

如果您阅读documentation on MSDN，您会看到一条注释：

XmlSerializer 对实现的类给予特殊处理 IEnumerable 或 ICollection。实现 IEnumerable 的类必须 实现一个采用单个参数的公共 Add 方法。添加 方法的参数必须与从 从 GetEnumerator 返回的值的当前属性，或其中之一 该类型的基础。实现 ICollection 的类（如 CollectionBase) 除了 IEnumerable 还必须有一个 public Item 采用整数的索引属性（C# 中的索引器），它必须 具有整数类型的公共 Count 属性。添加的参数 方法必须与从 Item 属性返回的类型相同，或者 该类型的基地之一。对于实现 ICollection 的类， 要序列化的值是从索引的 Item 属性中检索的， 不是通过调用 GetEnumerator。

所以，我认为，如果您符合这种特殊处理，您将拥有更好的代码，可以与 XmlSerializer 一起使用，不使用旧命名空间，并以正确的方式满足代码分析警告，而不是而不是利用规则中的疏忽。

using System;
using System.Collections.Generic;
using System.Xml.Serialization;

/// <summary>
/// Class containing the Configuration Storage
/// </summary>
[XmlRoot("Configuration")]
public class ConfigurationStorage
{
    // The executers.
    private readonly ICollection<string> executers = new List<string>();

    // The IPG prefixes.
    private readonly ICollection<string> ipgPrefixes = new List<string>();

    /// <summary>
    /// Gets the list of executers.
    /// </summary>
    [XmlArray("Executers")]
    [XmlArrayItem("Executer")]
    public ICollection<string> Executers
    { 
        get
        {
            return this.executers;
        }
    }

    /// <summary>
    /// Gets the list of IPG prefixes.
    /// </summary>
    [XmlArray("IpgPrefixes")]
    [XmlArrayItem("IpgPrefix")]
    public ICollection<string> IpgPrefixes
    { 
        get
        {
            return this.ipgPrefixes;
        }
    }
}