Java - 接口方法命名约定
Java - interface methods naming convention
我读过很多关于接口命名约定的问题,但是 none 关于它们的方法。
以这个界面为例
public interface TableProvider<T> {
ServiceProxy<T> getServiceProxy();
JsonParser<T> getJsonParser();
String getDefinition();
}
考虑到我不允许设置器,是否值得(并且正确)在这些方法前加上 get
?
我应该考虑遵守 JavaBean 约定吗?
在接口中专门声明的命名方法没有约定。
接口方法应遵循相同的命名约定 methods,建议使用 verbs/actions 驼峰式方法名称。
尽管 get
在 getDefinition()
中可能显得多余,但根据 "verbs" 约定,它仍然是比 definition()
更好的方法名称。
一个不限于所有返回值方法的 get
前缀(在 JDK 中有许多没有 getXYZ
方法的接口示例)。意思合适的地方,常见的有createJsonParser
、fetchDefinition
等方法
但在我看来,TableProvider<T>
和 ServiceProxy<T>
似乎不适合为方法 getServiceProxy
起一个非常直观、通用的名称。这就是为什么这些准则只是惯例,您或您的团队在某些情况下可以决定不遵循的内容。
我读过很多关于接口命名约定的问题,但是 none 关于它们的方法。
以这个界面为例
public interface TableProvider<T> {
ServiceProxy<T> getServiceProxy();
JsonParser<T> getJsonParser();
String getDefinition();
}
考虑到我不允许设置器,是否值得(并且正确)在这些方法前加上 get
?
我应该考虑遵守 JavaBean 约定吗?
在接口中专门声明的命名方法没有约定。
接口方法应遵循相同的命名约定 methods,建议使用 verbs/actions 驼峰式方法名称。
尽管 get
在 getDefinition()
中可能显得多余,但根据 "verbs" 约定,它仍然是比 definition()
更好的方法名称。
一个不限于所有返回值方法的 get
前缀(在 JDK 中有许多没有 getXYZ
方法的接口示例)。意思合适的地方,常见的有createJsonParser
、fetchDefinition
等方法
但在我看来,TableProvider<T>
和 ServiceProxy<T>
似乎不适合为方法 getServiceProxy
起一个非常直观、通用的名称。这就是为什么这些准则只是惯例,您或您的团队在某些情况下可以决定不遵循的内容。