在不破坏封装的情况下公开对象数据

Question

良好的面向对象设计表明，对象不应暴露其内部结构。鉴于这种情况，显示数据的最佳方式是什么？

例如，在控制台应用程序中调用 DoSomethingToData 后，您将如何显示数据字段？

public class Foo {
    string data;

    public void DoSomethingToData(string someParam) {
        .....
    }
}

class Program {
    static void Main(string[] items) {
        var foo = new Foo();
        foo.DoSomethingToData("blah");
        ..... // how do we write data field to console without breaking encapsulation?
    }
}

更新： 我认为维护封装的最佳方法是使用观察者模式（事件），但没有人提到它。这是比公开属性或方法结果更好的解决方案吗？

Answer 1

这取决于;

• 如果该值仅与方法相关，则将其作为该方法的返回值
• 如果该值与对象相关，则通过属性公开它

我怀疑是后者，所以：

 public string Data { get { return data; } }

这只是一个访问器 - 相当于getData()。这不会公开字段，但最终您的对象应该向信息公开某些 API。这并不意味着是一个完全的秘密。

Answer 2

您可以添加 ToString 方法（或类似方法）来提供适合登录到控制台的字符串表示形式。

public class Foo
{
    private string data;

    public void DoSomethingToData(string someParam) {
        .....
    }

    public override string ToString()
    {
        return string.Format("Foo data: {0}", data);
    }
}

这使类的客户端清楚地知道，除了调试/日志记录之外，数据字段的内容不打算在类外部使用。

---

或者，您可以私有一个公共 getter 属性，该属性允许直接（只读）访问私有字符串，但请注意，以这种方式提供此类属性可能会导致该类的客户端使用 Data 字段用于除日志记录之外的更一般目的。

public string Data { get { return data; } }

---

最后一个选项是使用自动实现的属性并完全删除该字段（自动实现的属性将使用其自己的支持字段）：

public string Data { get; private set; }

Answer 3

一些常见的方法：

• 重写 ToString() 以获取实例的某些通用文本表示形式（这可能反映您想要的内部数据或不反映您想要的内部数据，取决于细节和上下文）
• 如果计算是根据某些特定的内部数据执行的，则公开方法
• 将 getter 公开为不可变暴露内部数据
• 如果您只需要在调试时检查内部行为，请使用调试器并“监视”类实例

Answer 4

在 Foo 类中创建属性

    public string Data
    {
        get{return data;}
        set{data = value;}
    }

Answer 5

将数据视为属性。数据是一种属性，不需要按照分配的方式存储。可以通过从/到其后备存储的转换来获取/存储属性。通过对私有存储变量的内部结构进行转换的组合可以获得多个属性。

private double booTheBackingStore;
private int myfactor;

public String data{
  get{
    return "<data>"+booTheBackingStore*booTheBackingStore+"</data>";
  }

  set{
    String boo = parselTheXml(value);
    double booger;
    Double.tryParse(boo, out booger);
    booTheBackingStore = Math.sqrt(booger);
  }
}


public double dada{
  get{
    return exoTransform(booTheBackingStore, myfactor);
  }
  set{
    booTheBackingStore = endoTransform(value, myfactor);
  }
}

更多信息：

假设您的类是一个网页视图，它具有编辑、浏览、插入、删除模式。对于每种模式，您的视图都必须重新实例化/重新排列小部件。此外，您还必须重新应用样式。

从 MVP 的角度来看，您需要将您的演示文稿与您的视图解耦。该视图需要在公共属性方面暴露自己。因此，设置/获取模式属性将封装需要在 UI 上执行的所有内部结构。演示者不应该关心视图如何自行排列。并且视图不应该有任何流程或数据控制逻辑。

公共属性是促进封装的重要组成部分，以便仅公开视图和呈现者之间的契约。

健壮的 UI 设计将具有服务器端状态机，它与客户端状态机进行通信，客户端状态机依次对表示代理进行排序，而表示代理又要求显示 UI-View 属性。您的服务器根本不应该直接访问客户端视图。您的客户端状态机也不应该。您的演示者根据客户端的状态来提出 UI 视图的要求。演示者仅发出对例如编辑模式的需求。它不会干扰 UI-View 编辑模式的实现方式。 UI-View 不应该维护 UI 的状态。

这种解耦是为了促进单元测试，最重要的是，促进组件的模块化交换。这样，在您将浏览器 UI 更换为移动设备 UI 后，您的演示序列也能正常工作。由于移动 UI 会以不同于浏览器 UI 的方式实现各种模式。或者桌面用户界面。

您需要进一步阅读基于组件的设计和“封装”的概念。