是否可以在C#中限制公共枚举值?

时间:2017-07-19 14:54:14

标签: c# enums private encapsulation public

我目前正在编写一个由展览组成的旅游软件程序。展览对象在任何给定点都处于四种状态之一,由ExhibitStates枚举定义:

private enum ExhibitState { Ready, Active, Complete, Inactive };

对于将要设置展品的开发人员,只有两个"开始"说我希望他们能够选择:

public enum StartingExhibitState { Ready, Inactive };

目前,我已将其设置为在初始化时,展览将立即将其状态设置为与其起始状态相匹配,如下所示:

        switch (startingState) {
            case StartingExhibitState.Ready:
                SetState(ExhibitState.Ready);
                break;
            case StartingExhibitState.Inactive:
                SetState(ExhibitState.Inactive);
                break;
        }

我发现自己今天想知道这是不是最好的做法。有没有更好的方法来限制哪些枚举选项是公开的,哪些是私有的?或者最好是简单地使用两个单独的枚举?

非常感谢您的时间。

2 个答案:

答案 0 :(得分:4)

如果您创建第二个枚举 - 您的意图将通过设置方法的签名非常清楚地解释

public enum ExhibitState 
{ 
    Inactive = 0,
    Active = 1,
    Ready = 2,
    Complete = 3
};

public enum InitialStates 
{ 
    Inactive = ExhibitState.Inactive,
    Ready = ExhibitState.Ready
};

public void SetInitial(InitialStates state)
{
    SetState((ExhibitState)state);
}

如果你更进一步,你可以添加编译器帮助,以防止将错误的值传递给方法。

public sealed class InitialState
{
    public static readonly InitialState Initial = new InitialState(ExhibitState.Initial);

    public static readonly InitialState Ready = new InitialState(ExhibitState.Ready);

    public ExhibitState State { get; }            

    private InitialState(ExhibitState state)
    {
        State = state;
    }
}

构造函数使private阻止从其他地方实例化类 标记为sealed的类,以防止导出和更改其行为。

然后你的方法看起来像

public void SetInitial(InitialState start)
{
    SetState(start.State);
}  

// use it
SetInitial(InitialState.Initial);
SetInitial(InitialState.Ready);

在更改InitialState类的代码之前,不能传递任何其他内容。

答案 1 :(得分:2)

您可以使用基于类的方法,而不是使用枚举(或其中两个):

public abstract class ExhibitState 
{
    public static ExhibitInitialState Ready { get { return new ExhibitReadyState(); } }
    public static ExhibitInitialState Inactive { get { return new ExhibitInactiveState(); } }
    public static ExhibitState Complete { get { return new ExhibitCompleteState(); } }
    public static ExhibitState Active { get { return new ExhibitActiveState(); } }

    private class ExhibitReadyState : ExhibitInitialState {}
    private class ExhibitInactiveState : ExhibitInitialState {}
    private class ExhibitCompleteState : ExhibitState {}
    private class ExhibitActiveState : ExhibitState {}
}

public abstract class ExhibitInitialState : ExhibitState {}

以上示例显示了一种简单的方法。通常,您不会在get方法中创建新的状态实例,而是使用静态实例,以便比较更容易。

与枚举类似,您仍然可以键入ExhibitState.Ready或其他状态。此外,基类ExhibitInitialState允许您限制最初可以设置的状态:

public void SetInitial(ExhibitInitialState initState) { ... }

与@Fabio提出的方法相比,您可以获得无法混淆价值的好处。此外,尤其与州相关:非常普遍的是,行为也应该针对特定国家而改变。使用这种基于类的方法,您可以在特定的ExhibitState实现中实现此行为,并避免使用基于枚举的方法中可能存在的大量switch语句。