可变类型的不可变视图

时间:2010-11-12 19:36:02

标签: c# .net interface immutability mutability

我有一个项目,我需要在执行流程之前构建大量的配置数据。在配置阶段,将数据变为可变非常方便。但是,一旦配置完成,我想将该数据的不可变视图传递给功能过程,因为该过程将依赖于其许多计算的配置不变性(例如,基于预先计算事物的能力)初步配置。)我已经提出了一个可能的解决方案,使用接口来公开只读视图,但我想知道是否有人遇到过这种方法的问题,或者是否有其他建议如何解决这个问题。

我正在使用的模式的一个例子:

public interface IConfiguration
{
    string Version { get; }

    string VersionTag { get; }

    IEnumerable<IDeviceDescriptor> Devices { get; }

    IEnumerable<ICommandDescriptor> Commands { get; }
}

[DataContract]
public sealed class Configuration : IConfiguration
{
    [DataMember]
    public string Version { get; set; }

    [DataMember]
    public string VersionTag { get; set; }

    [DataMember]
    public List<DeviceDescriptor> Devices { get; private set; }

    [DataMember]
    public List<CommandDescriptor> Commands { get; private set; }

    IEnumerable<IDeviceDescriptor> IConfiguration.Devices
    {
        get { return Devices.Cast<IDeviceDescriptor>(); }
    }

    IEnumerable<ICommandDescriptor> IConfiguration.Commands
    {
        get { return Commands.Cast<ICommandDescriptor>(); }
    }

    public Configuration()
    {
        Devices = new List<DeviceDescriptor>();
        Commands = new List<CommandDescriptor>();
    }
}

修改

根据Lippert先生和cdhowie的意见,我将以下内容放在一起(删除了一些属性以简化):

[DataContract]
public sealed class Configuration
{
    private const string InstanceFrozen = "Instance is frozen";

    private Data _data = new Data();
    private bool _frozen;

    [DataMember]
    public string Version
    {
        get { return _data.Version; }
        set
        {
            if (_frozen) throw new InvalidOperationException(InstanceFrozen);
            _data.Version = value;
        }
    }

    [DataMember]
    public IList<DeviceDescriptor> Devices
    {
        get { return _data.Devices; }
        private set { _data.Devices.AddRange(value); }
    }

    public IConfiguration Freeze()
    {
        if (!_frozen)
        {
            _frozen = true;
            _data.Devices.Freeze();
            foreach (var device in _data.Devices)
                device.Freeze();
        }
        return _data;
    }

    [OnDeserializing]
    private void OnDeserializing(StreamingContext context)
    {
        _data = new Data();
    }

    private sealed class Data : IConfiguration
    {
        private readonly FreezableList<DeviceDescriptor> _devices = new FreezableList<DeviceDescriptor>();

        public string Version { get; set; }

        public FreezableList<DeviceDescriptor> Devices
        {
            get { return _devices; }
        }

        IEnumerable<IDeviceDescriptor> IConfiguration.Devices
        {
            get { return _devices.Select(d => d.Freeze()); }
        }
    }
}
正如您所料,

FreezableList<T>IList<T>的可冻结实现。这会带来一些额外的复杂性,从而获得绝缘效益。

5 个答案:

答案 0 :(得分:13)

如果“客户端”(接口的使用者)和“服务器”(类的提供者)达成共识,那么您描述的方法很有效:

  • 客户端将是礼貌的,而不是试图利用服务器的实现细节
  • 服务器将是礼貌的,并且在客户端引用它之后不会改变对象。

如果你在编写客户的人和编写服务器的人之间没有良好的工作关系,那么很快就会形成梨形。一个粗鲁的客户端当然可以通过强制转换为公共配置类型来“抛弃”不变性。粗鲁的服务器可以分发不可变的视图,然后在客户端最不期望的时候改变对象。

一个很好的方法是防止客户端看到可变类型:

public interface IReadOnly { ... }
public abstract class Frobber : IReadOnly
{
    private Frobber() {}
    public class sealed FrobBuilder
    {
        private bool valid = true;
        private RealFrobber real = new RealFrobber();
        public void Mutate(...) { if (!valid) throw ... }
        public IReadOnly Complete { valid = false; return real; }
    }
    private sealed class RealFrobber : Frobber { ... }
}

现在,如果你想创建和改变Frobber,你可以制作一个Frobber.FrobBuilder。当你完成突变时,你会调用Complete并获得一个只读界面。 (然后构建器变得无效。)由于所有可变性实现细节都隐藏在私有嵌套类中,因此您不能将IReadOnly接口“抛弃”到RealFrobber,而只能“抛弃”Frobber,它没有公共方法!

敌对客户也不能创建自己的Frobber,因为Frobber是抽象的并且有私人构造函数。制作Frobber的唯一方法是通过建造者。

答案 1 :(得分:3)

这样可行,但“恶意”方法可能会尝试将IConfiguration强制转换为Configuration,从而绕过界面强加的限制。如果你不担心,那么你的方法就可以了。

我通常做这样的事情:

public class Foo {
    private bool frozen = false;

    private string something;

    public string Something {
        get { return something; }
        set {
            if (frozen)
                throw new InvalidOperationException("Object is frozen.");

            // validate value

            something = value;
        }
    }

    public void Freeze() {
        frozen = true;
    }
}

或者,您可以将可变类深度克隆到不可变类中。

答案 2 :(得分:2)

为什么不能提供对象的单独不可变视图?

public class ImmutableConfiguration {
    private Configuration _config;
    public ImmutableConfiguration(Configuration config) { _config = config; }
    public string Version { get { return _config.Version; } }
}

或者如果您不喜欢额外输入,请将集合成员设置为内部而非公共 - 可以在程序集中访问,但不能由客户端访问?

答案 3 :(得分:1)

我经常使用一个基于COM的大型框架(ESRI的ArcGIS Engine),在某些情况下处理修改的方式非常相似:有“默认”IFoo接口用于只读访问,{ {1}}接口(如适用)进行修改。

这个框架是众所周知的,我不知道有任何关于这背后的特定设计决定的普遍抱怨。

最后,我认为在决定哪个“视角”成为默认视角时,绝对值得一些额外的思考:只读视角或完全访问视角。我个人会将只读视图设为默认视图。

答案 4 :(得分:0)

怎么样:

struct Readonly<T>
{
    private T _value;
    private bool _hasValue;

    public T Value
    {
        get
        {
            if (!_hasValue)
                throw new InvalidOperationException();
            return _value;
        }
        set
        {
            if (_hasValue)
                throw new InvalidOperationException();
            _value = value;
        }
    }
}


[DataContract]
public sealed class Configuration
{
    private Readonly<string> _version;

    [DataMember]
    public string Version
    {
        get { return _version.Value; }
        set { _version.Value = value; }
    }
}

我称之为Readonly,但我不确定这是否是最佳名称。