返回布尔值的 Java 方法的命名约定

Question

我喜欢在其他语言中的方法/函数名称末尾使用问号。 Java 不允许我这样做。作为解决方法，我还能如何在 Java 中命名返回布尔值的方法？在某些情况下，在方法前面使用 is、has、should、can 听起来不错。有没有更好的方法来命名这些方法？

例如createFreshSnapshot？

Answer 1

惯例是以名义提出问题。

以下是 JDK 中可以找到的一些示例：

isEmpty()

hasChildren()

这样，名称读起来就像末尾带有问号一样。

集合是空的吗？
该节点有子节点吗？

然后，true 表示是，false 表示否。

或者，您可以将其视为断言：

集合为空。
该节点有子节点

注意：
有时您可能想将方法命名为 createFreshSnapshot? 之类的名称。如果没有问号，该名称意味着该方法应该创建快照，而不是检查是否需要快照。

在这种情况下，您应该重新考虑您实际要问的内容。像 isSnapshotExpired 这样的名称是一个更好的名称，它传达了该方法在调用时会告诉您的内容。遵循这样的模式还可以帮助您保持更多功能的纯净且没有副作用。

如果您执行在 Java API 中 Google 搜索 isEmpty()，您会得到很多结果。

Answer 2

如果您希望您的类与 Java Beans 规范，以便利用反射的工具（例如 JavaBuilders、JGoodies Binding) 可以识别布尔值 getter，可以使用 getXXXX() 或 isXXXX() 作为方法名称。来自 Java Bean 规范：

8.3.2 布尔属性

此外，对于布尔属性，我们允许 getter 方法来匹配模式：

public boolean is<PropertyName>();

这个“是<PropertyName>”可以提供方法来代替“get<PropertyName>”方法，或者除了“get<PropertyName>”之外还可以提供它方法。无论哪种情况，如果“is<PropertyName>”方法存在于布尔属性，那么我们将使用“is<PropertyName>”方法读取属性值。布尔属性示例可能是：

public boolean isMarsupial();
公共无效setMarsupial（布尔m）；

Answer 3

我想发布此链接，因为它可能有助于进一步检查此答案并寻找更多 java 样式约定

Java编程风格指南

项目“2.13 is 前缀应用于布尔变量和方法。”特别相关并建议使用 is 前缀。

风格指南继续建议：

is 前缀有一些替代方案，更适合某些情况。这些是 has、can 和 should 前缀：

boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

如果您遵循指南，我相信会命名适当的方法：

shouldCreateFreshSnapshot()

Answer 4

对于可能失败的方法，即指定布尔值作为返回类型，我将使用前缀 try：

if (tryCreateFreshSnapshot())
{
  // ...
}

对于所有其他情况，请使用诸如 is.. has 之类的前缀.. 曾经.. 可以.. 允许.. ..

Answer 5

标准是使用 is 或 has 作为前缀。例如isValid、hasChildren。

Answer 6

is 是我遇到最多的一个。但在目前的情况下，任何有意义的选择都是最好的选择。

Answer 7

我想对这个一般命名约定提出不同的看法，例如：

参见java.util.Set: boolean add (E e)

其中基本原理是：

进行一些处理，然后 报告 是否成功。

虽然return确实是一个boolean，但方法的名称应该指向要完成的处理而不是结果类型（本例中的布尔值）。

对我来说，您的 createFreshSnapshot 示例似乎与此观点更相关，因为似乎意味着：创建一个新快照，然后报告创建操作是否成功。考虑到这一推理，名称 createFreshSnapshot 似乎是最适合您的情况的名称。