长方法的方法名称

Question

良好的风格（《清洁代码》书）说，方法的名称应该描述该方法的用途。例如，如果我有一个验证地址、将其存储在数据库中并发送电子邮件的方法，那么名称应该是 verifyAddressAndStoreToDatabaseAndSendEmail(address);

或

verifyAddress_StoreToDatabase_SendEmail(address) );

虽然我可以将该功能分为 3 个方法，但我仍然需要一个方法来调用这 3 个方法。所以大的方法名是不可避免的。

拥有并命名的方法当然描述了该方法的作用，但在我看来，它的可读性不是很好，因为名称可能非常非常大。你会如何解决它？

编辑：也许我可以使用流畅的风格来分解方法名称，例如：

verifyAddress(address).storeToDatabase().sendEmail();

但我需要一种方法来确保调用顺序。也许通过使用状态模式，但这会导致代码增长。

Answer 1

我的方法是创建您提到的 3 个较小的方法，然后在调用 3 个较小的方法的更高方法中，我以“为什么”我需要做这三件事来命名它。

尝试定义为什么需要执行这些步骤并将其用作方法名称的基础。

Answer 2

一个方法不应该做三件事。因此将工作分为3个方法：

1. verifyAddress
2. storeAddress
3. sendEmail

Answer 3

我正在跟进我之前的评论，但我在这里得到的内容超出了评论的合理范围，所以我正在回答。

该方法的详细信息属于文档而不是方法名称（在我看来）。可以这样想……通过将 SendEmail 放在方法名称中，您就可以将实现细节提交给方法名称。如果以后决定通过短信、推特或其他方式而不是电子邮件发送通知怎么办？您是否更改了方法名称并破坏了您的 API，或者您的方法名称是否误导了 API 的使用者？需要考虑的事情。

如果您坚持在其名称中保留该方法的功能，我建议您找到更通用的名称。也许类似于VerifySaveAndNotify(Address address)。这样，方法名称就可以告诉您它正在做什么，而无需指定它如何执行该操作。 Address 类型的参数让您知道正在验证和保存的内容。所有这些共同作用使您的方法名称信息丰富、灵活且简洁。

Answer 4

编辑：也许我可以使用流畅的风格来分解方法名称，例如：

verifyAddress(地址).storeToDatabase().sendEmail();

但我需要一种方法来确保调用的顺序。也许可以使用状态模式，但这会导致代码增长。

为了确保以流畅的方式对命令进行排序，每个结果都将是一个仅公开下一步所需功能的对象。例如：

public class Verifier
{
    public DataStorer VerifyAddress(string address)
    { 
        ...
        return new DataStorer(address);
    }
}

public class DataStorer
{
    public Emailer StoreToDataBase()
    {
        ...
        return new Emailer(...);
    }
}

public class Emailer
{
    public void SendEmail()
    {
        ...
    }
}

如果您需要创建非常精细的设计并希望优化类以实现可重用性，那么这很方便，但在大多数情况下可能是设计过度的。正如其他人所说，最好选择一个代表整个过程应该代表的名称。您可以简单地将其称为“StoreAndEmail”，假设验证是您在将数据提交到任何目的地之前例行执行的操作。如果您不介意名称太长，另一种选择是简单地完整描述它并接受长名称是必要的。最后，它确实不会花费您任何费用，但肯定可以使您的代码的意图更加具体。