OO 设计建议 - toString

Question

所以我得到了 Address 类：

class Address 
{
    private String streetAddress;
    private int number;
    private String postalCode;
    private City city;
    private State state;
    private Country country;
}

我想获得它的可读版本，比如说，显示在网格列中。

实现此目的的最佳且简洁的方法是什么？

1. 中的 toString 方法（我个人不喜欢这种方法，因为“toString”与地址不直接相关）
2. Address类 代码>ReadableAddressFormatter
   • ReadableAddressFormatter(地址 addressToFormat)
   • public String getFormatted()
3. 上一类，但 getFormmated< /code> 将是静态的，接收 Address 实例并返回字符串
4. Other?请提出建议。

我正在寻找一个好的设计，同时关注干净的代码、解耦和可维护性。

Answer 1

所有这些方法都已被使用，并且没有办法提供“上下文无关”的最佳实践。软件工程中的最佳答案通常是“视情况而定”。也就是说，让我们逐一分析：

1. KISS 方法的最佳状态。我为所有基本的“打印到控制台，确保一切正常”之类的事情执行此操作。如果您有特定的地址格式，那么这是唾手可得的解决方案/轻松获胜的解决方案。您始终可以覆盖此设置或在一次性情况下以不同方式打印出对象。
2. 这是最可扩展的解决方案，因为它将很好地允许本地化和自定义格式。它是否合适取决于您期望地址以不同格式显示的频率。您是否真的需要死星来击落一只苍蝇，或者更改为全部大写或在语言之间更改的能力对您的应用程序至关重要吗？
3. 我不建议这种方法，因为它通常开始将“视图级别”逻辑渗透到域中，这通常最好由其他层处理（在类 MVC 方法中）。有人可能会说 toString() 做了同样的事情，但 toString() 也可以被认为是对象如何呈现给外部世界的“名称”或“本质”，所以我想说它不仅仅是表现性的。

希望这对您有所帮助，并感谢您从一开始就考虑了整洁代码、解耦和可维护性。

有关原则 2 实际应用的示例 - 使用策略模式，遵循单一职责原则，开放/封闭原则并允许通过依赖注入实现控制反转--比较以下方法（由 @SteveJ 慷慨提供）：

public class Address {
        private String streetAddress;
        private int number;
        private String postalCode;
        private String city;
        private String state;
        private String country;

        public String toLongFormat(){
            return null; // stitch together your long format
        }

        public String toShortFormat(){
            return null; // stitch together your short format
        }

        public String toMailingLabelFormat(){
            return null; // stitch together your mailing label format
        }

        @Override
        public String toString(){
            return toShortFormat(); // your default format
        }
    }

}

与此方法（在“大部分正确”中） Groovy）：

public interface AddressFormatter {
   String format(Address toFormat)
}

public class LongAddressFormatter implements AddressFormatter {
    @Override
    public String format(Address toFormat){
         return String.format("%sBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAHBLAH%n%s", toFormat.streetAddress, toFormat.postalCode)
    }
}


public class ShortAddressFormatter implements AddressFormatter {
    @Override
    public String format(Address toFormat){
         return String.format("%d", toFormat.number)
    }
}

public  class Address {
        private String streetAddress;
        private int number;
        private String postalCode;
        private String city;
        private String state;
        private String country;
        public  AddressFormatter formatter = new ShortAddressFormatter(); // just to avoid NPE

        public void setFormatter(AddressFormatter fr) { this.formatter = fr; }



        @Override
        public String toString(){
            return formatter.format(this); // your default format
        }
    }

def addrr = new Address(streetAddress:"1234 fun drive", postalCode:"11223", number:1)
addr.setFormatter(new LongAddressFormatter());
println "The address is ${addrr}"
addr.setFormatter(new ShortAddressFormatter());
println "The address is ${addrr}"

正如 @SteveJ 所观察到的：

" 所以你有不同的格式“策略”，你可以切换
他们之间......我有这样的想法，你会设置一次格式
并坚持下去......如果你想添加另一种格式
风格，你不必打开并重写地址类，但是
编写一个新的单独样式并在需要使用时注入它。”

Answer 2

.NET 解决方案：

重写Object.ToString() 似乎是最合乎逻辑的解决方案。这使得在以下情况下使用起来更加简洁： Console.WriteLine("Home Address: {0}", homeAddress);

如果您希望提供额外的格式，则地址类应实现 IFormattable。

另外，您应该创建一个从 IFormatProvider和 ICustomFormatter。

MSDN 链接提供了很好的示例（BinaryFormatter 和 AcctNumberFormat），但如果这些还不够，还可以看看这个很好的示例：PhoneFormatter

---

此外，如果您决定全力以赴并实现 IFormattable 和自定义IFormatProvider/ICustomFormatter 那么我建议您的 ToString() 只需使用默认提供程序调用 ToString(String format, IFormatProvider formatProvider) 即可。这样您就可以考虑本地化和地址类型（短、长等）等问题。

Answer 3

使用 toString 不需要函数本身之外的额外负担；似乎是最简单的解决方案。它的存在是有原因的，对吧？

Answer 4

通常我将表示层与数据层分开。在我看来，将其呈现给 GUI 似乎与表示层相关，而不是数据层。

我建议您在表示层中的某个位置放置一个函数，将地址转换为字符串。

数据的呈现与数据无关！

静态方法很好。
转换器类会更好，您可以为应用程序保留一个实例，但如果您要将应用程序从 GUI 移动到另一种格式的 WEB，或者如果您想在一个窗口中显示所有内容，则可以替换它或编写另一个实例。另一个窗口您只想显示部分信息或以其他方式格式化的信息。

您可以遵循多种模型，例如 Microsoft WPF 使用完全另一种方法，即 MVVM（模型视图视图模型），它允许您很好地将数据层、业务逻辑和表示层分开。

我通常会重写 C# 中的 ToString 或 java 中的 toString，仅用于调试目的（呈现可用于调试的字符串）或用于某种简单的字符串序列化，通常还会放置 FromString（或 java 中的 fromString 方法）。一个例子是自定义类型，如点、向量、矩阵等。

谈论 C# 世界..

public class AddressToStringConverter
{
    public virtual string ToString(Address address)
    {
        return address.Street + ", " + address.City
    }
}

然后以您的形式（例如）。

AddressToStringConverter myConverter = new AddressToStringConverter();

public Address CurrentSelectedAddress { get { ... } }

public button1_click(object sender, EventArgs e)
{
    button1.Text = myConverter.Convert(address);
}

如果您愿意，您可以实现其他有用的接口，例如 ITypeConverter

Answer 5

toString() 是最灵活和方便的，当您将 Address 类的对象与 String 组合时，会隐式调用，如 System.out.println("My address is " + objectOfAddressClass)。

我能想到不重写 toString() 的唯一原因是如果您需要更改格式。然后，您将需要不同的方法（如 toMailingString() 和 toShortFormString() 等）或参数化方法（如 toMailingString(boolean useShortForm) 或其他），但无论哪种方式， toString() 都不会削减它。

当然，您可以（并且应该）两者都做。将 toString() 作为默认值，可能会调用您的特定格式方法之一，然后使用其他辅助方法来实现替代格式。

public class TestClass {

    class City{};

    class State{};

    class Country{};

    class Address {
        private String streetAddress;
        private int number;
        private String postalCode;
        private City city;
        private State state;
        private Country country;

        public String toLongFormat(){
            return null; // stitch together your long format
        }

        public String toShortFormat(){
            return null; // stitch together your short format
        }

        public String toMailingLabelFormat(){
            return null; // stitch together your mailing label format
        }

        @Override
        public String toString(){
            return toShortFormat(); // your default format
        }
    }

}

Answer 6

您已经用 Java 标记了您的帖子，所以我将回答 Java（更具体地说，是 Swing）。此任务通常是特定 TableCellRenderer 的任务。如果其他可视组件必须使用相同的格式，我确实会在可实例化的类中提取格式（解决方案 2）。这将允许子类根据需要自定义格式。

Answer 7

我认为返回字符串的 toString() 方法是最好的方法。如果您有一个 Address 实例，比如说 address，那么 address.toString() 的作用就很明显了。 toString() 与 Address 不直接关联这一事实并没有真正改变任何东西。