4

我正在尝试将一些代码从 Delphi 移植到 C#，并且我发现了一个我无法以合理的方式实现的结构，同时遵守 .NET Framework 设计指南（我在问题的结尾处解决了这个问题）。

显然 C#、Java、C++（和许多其他语言）提供了方法/构造函数重载的含义，但 Delphi 构造函数可以另外有多个名称。这样就可以编写直接代表意图的代码：

var
  Data, ParI, ParD, Locl: TDataElement;
begin
  Data := TDataElement.Create('Element');
  ParI := TDataElement.CreateParam('IntElement', 22);
  ParD := TDataElement.CreateParam('DblElement', 3.14);
  Locl := TDataElement.CreateLocal('LocalElement');
  // ... use the above objects ...
end;

简化代码如下：

unit DataManager;

interface

TDataElement = class
  FName: string;
  FPersistent: Boolean;
public
  constructor Create(AName: string);
  constructor CreateParam(AName: string; DefaultInt: Integer); overload;
  constructor CreateParam(AName: string; DefaultDouble: Double); overload;
  constructor CreateLocal(AName: string);
  property Name: string read FName;;
  property Persistent: Boolean read FPersistent;
end;

implementation

constructor TDataElement.Create(AName: string);
begin
  FName := AName;
  FPersistent := True;
  // ... other initialization ...
end;

constructor TDataElement.CreateParam(AName: string; DefaultDouble: Double);
begin
  Create(AName); 
  // ... use DefaultInt ...
end;

constructor TDataElement.CreateParam(AName: string; DefaultInt: Integer);
begin
  Create(AName); 
  // ... use DefaultDouble...
end;

constructor TDataElement.CreateLocal(AName: string);
begin
  Create(AName); 
  FPersistent := False;
  // ... other code for local (non-persistent) elements ...
end;

特别是在 C# 中，构造函数必须与类同名，所以首先我尝试用枚举来区分行为。唉，我偶然发现了几个问题：

  • 每个构造函数中的第一个参数是相同的类型（ElementKind）
  • 构造函数不像 Delphi 那样容易识别（Create vs. CreateParam vs. CreateLocal）
  • 在 DataElement 的子类中需要格外小心
  • 错误的可能性，例如指定 ElementKind.DoubleParam 和传递整数值
  • 需要一个额外的 bool 参数来处理本地元素

下面的第一次尝试：

public enum ElementKind
{
    Regular, IntParam, DoubleParam, Local
}

public class DataElement
{
    private string FName;
    public string Name { get { return FName; } }

    private bool FPersistent;
    public bool Persistent { get { return FPersistent; } }

    public DataElement(ElementKind kind, string name)
    {
        FName = name;
        // ugly switch :-(
        switch (kind)
        {
            case ElementKind.Regular:
            case ElementKind.IntParam:
            case ElementKind.DoubleParam:
                FPersistent = true;
                break;
            case ElementKind.Local:
                FPersistent = false;
                break;
        }
        // ... other initialization ...
    }

    public DataElement(ElementKind kind, string name, int defaultInt)
        : this(kind, name)
    {
        // ... use defaultInt ...
    }

    public DataElement(ElementKind kind, string name, double defaultDouble)
        : this(kind, name)
    {
        // ... use defaultDouble ...
    }

    // Redundant "bool local" parameter :-(
    public DataElement(ElementKind kind, string name, bool local)
        : this(kind, name)
    {
        // What to do when "local" is false ???

        // ... other code for local (non-persistent) elements ...
    }
}

public class Program
{
    public void Run()
    {
        DataElement data = new DataElement(ElementKind.Regular, "Element");
        DataElement parI = new DataElement(ElementKind.IntParam, "IntElement", 22);
        DataElement parD = new DataElement(ElementKind.DoubleParam, "DblElement", 3.14);
        DataElement locl = new DataElement(ElementKind.Local, "LocalElement");
    }
}

然后我尝试了更多面向对象的方法来按类型区分构造函数，同时在 Run() 方法中保持相同的初始化代码：

public class ElementKind
{
    public class RegularElement
    {
        internal RegularElement() { /* disallow direct creation */ }
    }
    public class IntParamElement
    {
        internal IntParamElement() { /* disallow direct creation */ }
    }
    public class DoubleParamElement
    {
        internal DoubleParamElement() { /* disallow direct creation */ }
    }
    public class LocalElement
    {
        internal LocalElement() { /* disallow direct creation */ }
    }

    public static readonly ElementKind.RegularElement Regular = new RegularElement();
    public static readonly ElementKind.IntParamElement IntParam = new IntParamElement();
    public static readonly ElementKind.DoubleParamElement DoubleParam = new DoubleParamElement();
    public static readonly ElementKind.LocalElement Local = new LocalElement();
}

public class DataElement
{
    private string FName;
    public string Name { get { return FName; } }

    private bool FPersistent;
    public bool Persistent { get { return FPersistent; } }

    protected DataElement(string name)
    {
        FName = name;
        // ... other initialization ...
    }

    public DataElement(ElementKind.RegularElement kind, string name)
        : this(name)
    {
        FPersistent = true;
    }

    public DataElement(ElementKind.IntParamElement kind, string name, int defaultInt)
        : this(name)
    {
        FPersistent = true;
        // ... use defaultInt ...
    }

    public DataElement(ElementKind.DoubleParamElement kind, string name, double defaultDouble)
        : this(name)
    {
        FPersistent = true;
        // ... use defaultDouble ...
    }

    public DataElement(ElementKind.LocalElement kind, string name)
        : this(name)
    {
        FPersistent = false;

        // ... other code for "local" elements ...
    }
}

public class Program
{
    public void Run()
    {
        DataElement data = new DataElement(ElementKind.Regular, "Element");
        DataElement parI = new DataElement(ElementKind.IntParam, "IntElement", 22);
        DataElement parD = new DataElement(ElementKind.DoubleParam, "DblElement", 3.14);
        DataElement locl = new DataElement(ElementKind.Local, "LocalElement");
    }
}

一切都可以编译并且运行良好。那么我的问题是什么？.NET Framework 设计指南，以及一个名为Microsoft FxCop的工具。通过此工具运行最后一个代码后，我遇到了多个中断问题（见下文）。

问题是：如何设计我的类以符合 .NET 设计指南和最佳实践？

Breaking - 确定性 90% - 嵌套类型不可见 - ElementKind+RegularElement Breaking - 确定性 90% - 嵌套类型不可见 - ElementKind+IntParamElement Breaking - 确定性 90% - 嵌套类型不可见 - ElementKind+DoubleParamElement Breaking -确定性 90% - 嵌套类型不应可见 - ElementKind+LocalElement

Breaking - 确定性 90% - 静态持有者类型不应该有构造函数 - ElementKind

打破 - 确定性 75% - 标识符不应包含类型名称 - DataElement.#.ctor(ElementKind+IntParamElement,System.String,System.Int32)

打破 - 确定性 75% - 标识符不应包含类型名称 - DataElement.#.ctor(ElementKind+DoubleParamElement,System.String,System.Double)

Non Breaking - 确定性 25% - 不要声明只读可变引用类型 - ElementKind.#Regular

Non Breaking - 确定性 25% - 不要声明只读可变引用类型 - ElementKind.#IntParam

Non Breaking - 确定性 25% - 不要声明只读可变引用类型 - ElementKind.#DoubleParam

Non Breaking - 确定性 25% - 不要声明只读可变引用类型 - ElementKind.#Local

4

4 回答 4

7

对于初学者，我会将嵌套的“ElementKind”class替换为enum：

public enum ElementKind
{
    RegularElement,
    IntParamElement,
    DoubleParamElement,
    LocalElement
}

另外，我认为您的 Delphi 代码不需要映射到构造函数。使用返回DataElement. _ 例如：

public static DataElement Create(string name)
{
    return new DataElement(ElementKind.Regular, name);
}

public static DataElement CreateParam(string name, int defaultInt);
{
    return new DataElement(ElementKind.IntParam, name);
    // ... use defaultInt ... 
}

// similar to above
public static DataElement CreateParam(string name, double defaultDouble); 
public static DataElement CreateLocal(string name);

由于您使用工厂函数来创建 DataElement 对象，因此您应该将构造函数设为私有。

然后，您将更新 Run() 函数以使用这些函数，如下所示：

public void Run() 
{ 
    DataElement data = DataElement.Create("Element");
    DataElement parI = DataElement.CreateParam("IntElement", 22);
    DataElement parD = DataElement.CreateParam("DblElement", 3.14); 
    DataElement locl = DataElement.CreateLocal("LocalElement"); 
}

更新：我将建议的更改包含在您的Run()函数中并更正了基本Create()工厂方法（我相信它应该返回 "Regular" DataElement）。

于 2012-06-07T20:08:59.443 回答
1

您可以为此使用静态工厂方法：

public class TDataElement {
    private TDataElement(){}

    public static TDataElement Create(string name ) {  
        return new TDataElement {
                                   FName = name,
                                   FPersistent = true
                                   // ... other initialization ...
                                };
    }

    public static TDataElement CreateParam(string name, double defaultDouble){
         var element = Create(name);
         // ... use DefaultInt ...
         return element;
    }
//...    
}

你可以这样使用它：

Data = TDataElement.Create("Element");
ParI = TDataElement.CreateParam("IntElement", 22);

这是众所周知的做法。例如，您在Image.NET 框架的类中有一个工厂方法：var image = Image.FromFile("test.jpg");

于 2012-06-07T20:13:42.583 回答
0

最后，感谢@JonSenchyna 的想法和@Dennis 的建议，我想出了以下通用实现。

作为一个额外的功能，我IElementFactory在组合中添加了接口，以表达实现子类以拥有所有InitXyz()方法的要求——这在原始 Delphi 代码中是不存在的。

在这个设计中我唯一不喜欢的是要求将默认构造函数DataElement()和ByteElement()公共（来自new()约束）以及InitXyz()方法（因为它们是公共IElementFactory接口的一部分）。

public enum ElementKind
{
    RegularElement,
    IntParamElement,
    DoubleParamElement,
    LocalElement
}

public interface IElementFactory<TElement>
{
    void InitElement(string name);
    void InitParam(string name, int defaultValue);
    void InitParam(string name, double defaultValue);
    void InitLocal(string name);
}

public class DataElement<TElement>
    where TElement : class, IElementFactory<TElement>, new()
{
    private ElementKind FKind;
    public ElementKind Kind { get { return FKind; } }

    private string FName;
    public string Name { get { return FName; } }

    private int FDefaultInt;
    protected int DefaultInt
    {
        get { return FDefaultInt; }
        set { FDefaultInt = value; }
    }

    private double FDefaultDouble;
    protected double DefaultDouble
    {
        get { return FDefaultDouble; }
        set { FDefaultDouble = value; }
    }

    protected DataElement()
    {
    }

    public virtual void InitElement(ElementKind kind, string name)
    {
        FKind = kind;
        FName = name;
    }

    public static TElement Create(string name)
    {
        TElement obj = new TElement();
        obj.InitElement(name);
        return obj;
    }

    public static TElement CreateParam(string name, int defaultValue)
    {
        TElement obj = new TElement();
        obj.InitParam(name, defaultValue);
        return obj;
    }

    public static TElement CreateParam(string name, double defaultValue)
    {
        TElement obj = new TElement();
        obj.InitParam(name, defaultValue);
        return obj;
    }

    public static TElement CreateLocal(string name)
    {
        TElement obj = new TElement();
        obj.InitLocal(name);
        return obj;
    }
}

public class ByteElement : DataElement<ByteElement>, IElementFactory<ByteElement>
{
    public ByteElement()
    {
    }

    public void InitElement(string name)
    {
        base.InitElement(ElementKind.RegularElement, name);
    }

    public void InitParam(string name, int defaultValue)
    {
        base.InitElement(ElementKind.IntParamElement, name);
        // Range checking
        if ((defaultValue >= Byte.MinValue) && (defaultValue <= Byte.MaxValue))
        {
            DefaultInt = defaultValue;
        }
    }

    public void InitParam(string name, double defaultValue)
    {
        base.InitElement(ElementKind.DoubleParamElement, name);
        // Range checking
        if ((defaultValue >= Byte.MinValue) && (defaultValue <= Byte.MaxValue))
        {
            DefaultDouble = defaultValue;
        }
    }

    public void InitLocal(string name)
    {
        base.InitElement(ElementKind.LocalElement, name);
    }

}

Program.Run()看看重构的方法是多么漂亮、善意和类似于 Delphi 代码（！） ：

public class Program
{
    public static void Run()
    {
        ByteElement data = ByteElement.Create("Element");
        ByteElement parI = ByteElement.CreateParam("IntElement", 22);
        ByteElement parD = ByteElement.CreateParam("DblElement", 3.14);
        ByteElement locl = ByteElement.CreateLocal("LocalElement");
    }
}

现在 FxCop 只抱怨四种工厂方法，但我想我可以忍受：

打破 - 确定性 95% - 不要在泛型类型上声明静态成员 - DataElement`1.#Create(System.String)

打破 - 确定性 95% - 不要在泛型类型上声明静态成员 - DataElement`1.#CreateParam(System.String,System.Int32)

打破 - 确定性 95% - 不要在泛型类型上声明静态成员 - DataElement`1.#CreateParam(System.String,System.Double)

打破 - 确定性 95% - 不要在泛型类型上声明静态成员 - DataElement`1.#CreateLocal(System.String)

于 2012-06-13T08:19:07.017 回答
0

我认为，这个 Delphi 代码是 C# 中通用的好候选：

class DataElement
{
  public string Name { get; set; }
  public bool Persistent { get; set; }

  public DataElement(/* ctor params */)
  {
  }
}

class DataElement<T> : DataElement
{
  public DataElement(string name, T defaultValue /* other ctor params */)
    : base(/* base ctor params */)
  {
  }
}

class IntElement : DataElement<int> {}
class DoubleElement : DataElement<double> {}

有关 TDataElement 的更多详细信息将很有用。

于 2012-06-07T20:14:46.760 回答