ITEM 68: ADHERE TO GENERALLY ACCEPTED NAMING CONVENTIONS
Java平台有一组完善的命名约定，其中许多约定包含在 Java 语言规范[JLS, 6.1]中。一般来说，命名约定分为两类：排版和语法。
只有少数印刷式命名约定，包括包、类、接口、方法、字段和类型变量。如果没有一个很好的理由，你不应该违反它们。如果 API 违反了这些约定，那么它可能很难使用。如果实现违反了它们，可能很难维护。在这两种情况下，违规都有可能使其他使用代码的程序员感到困惑和恼火，并可能导致错误的假设，从而导致错误。本项目概述了各项公约。
包名和模块名应该是分层的，组件之间用 '.' 分隔。组件应该由小写字母和数字组成。将在您的组织外部使用的任何包的名称都应该以您组织的Internet域名开头，并将组件颠倒过来，例如，edu.cmu, com.google, org.eff。标准库和可选包，以 java 和 javax 开头的标准库和可选包是这个规则的例外。用户不能创建以 java 或 javax 开头的包或模块。将 Internet 域名转换为包名前缀的详细规则可以在JLS [JLS, 6.1]中找到。
包名的其余部分应该由一个或多个描述包的组件组成。组件应该很短，通常为8个或更少的字符。鼓励使用有意义的缩写，例如，util 而不是 utilities。缩写词是可以接受的，例如，awt。组件通常由一个单词或缩写组成。
除了 Internet 域名之外，许多包的名称只有一个组件。额外的组件适合于大型设施，它们的大小要求将它们分解为一个非正式的层次结构。例如，javax.util 包具有丰富的包层次结构，其名称如 java.util.concurrent.atomic。这样的包称为子包，尽管几乎不支持包层次结构。
类和接口名(包括enum和注释类型名)应该由一个或多个单词组成，每个单词的首字母大写，例如 List 或 FutureTask。除了首字母缩写和某些常见的缩写如 max 和 min外，缩略语应避免使用。对于首字母缩写是大写还是首字母大写存在一些分歧。虽然有些程序员仍然使用大写字母，但有一个强有力的理由支持只将第一个字母大写：即使多个首字母缩写连续出现，您仍然可以确定一个单词的开头和下一个单词的结尾。你希望看到的类名是什么，HTTPURL 还是 HttpUrl ? 方法名和字段名遵循与类名和接口名相同的排版约定，不同之处是方法名或字段名的第一个字母应该是小写的，例如 remove 或 ensureCapacity。如果方法名或字段名的首字母缩写词出现，它应该是小写的。
前一条规则的唯一例外是“常量字段”，它的名称应该由一个或多个由下划线分隔的大写单词组成，例如 VALUES 或 NEGATIVE_INFINITY。常量字段是一个静态的 final字段，它的值是不可变的。如果静态 final 字段具有基本类型或不可变引用类型(item 17)，则它是常量字段。例如，enum 常量是常量字段。如果静态 final 字段有一个可变的引用类型，那么如果被引用的对象是不可变的，那么它仍然可以是一个常量字段。注意，常量字段是推荐使用的唯一下划线。
局部变量名与成员名具有类似的排版命名约定，但允许使用缩写，也允许使用单个字符和短字符序列，它们的含义取决于它们出现的上下文，例如 i、denom、houseNum。输入参数是一类特殊的局部变量。它们的命名应该比普通的局部变量小心得多，因为它们的名字是方法文档的一个组成部分。
类型参数名通常由单个字母组成。最常见的是以下五种类型之一: T表示任意类型，E表示集合的元素类型，K 和 V 表示映射的键和值类型，X 表示异常。函数的返回类型通常为 R。一个任意类型的序列可以是 T、U、V 或 T1、T2、T3。
语法命名约定比排版约定更灵活，也更有争议。包没有语法命名约定。可实例化的类(包括 enum 类型)通常使用单数名词或名词短语来命名，例如 Thread、PriorityQueue 或 ChessPiece。不可实例化的实用程序类(item 4)通常使用复数名词命名，例如 collector 或 Collections。接口的命名类似于类，例如集合或比较器，或者以 able 或 ible 结尾的形容词，例如 Runnable、Iterable 或 Accessible。因为注释类型有如此多的用途，所以没有哪个部分占主导地位。名词、动词、介词和形容词都很常见，例如，BindingAnnotation、Inject、ImplementedBy 或 Singleton。
执行某些操作的方法通常用动词或动词短语(包括对象)命名，例如，append 或drawImage。返回布尔值的方法的名称通常以单词 is 或 has 开头，后面跟一个名词、名词短语或任何用作形容词的单词或短语，这种情况比较少见，例如 isDigit、isProbablePrime、isEmpty、isEnabled 或 hassi。返回被调用对象的非布尔函数或属性的方法通常使用以 get 开头的名词、名词短语或动词短语来命名，例如 size、hashCode 或 getTime。有一种观点认为，只有第三种形式(以get开头)才是可以接受的，但这种观点几乎没有根据。前两种形式通常会产生可读性更好的代码，例如:
if (car.speed() > 2 * SPEED_LIMIT)
generateAudibleAlert("Watch out for cops!");
以get开头的表单起源于已经过时的 Java Beans 规范，该规范构成了早期可重用组件体系结构的基础。现在有一些工具仍然依赖于 bean 命名约定，您可以在任何与这些工具一起使用的代码中随意使用它。如果一个类同时包含相同属性的 setter 和getter，那么遵循这种命名约定也有很好的先例。在本例中，这两个方法通常被命名为 getAttribute 和 setAttribute。
有几个方法名值得特别注意。转换对象类型、返回不同类型的独立对象的实例方法通常被调用为 type，例如 toString 或 toArray。返回类型与接收对象不同的视图(item 6)的方法通常称为类型，例如 asList。返回与调用它们的对象具有相同值的原语的方法通常称为类型值，例如 intValue。静态工厂的常用名称包括 from、of、valueOf、instance、getInstance、newInstance、getType 和 newType(Item 1)。
与类、接口和方法名相比，字段名的语法约定不那么完善，也不那么重要，因为设计良好的 api 几乎不包含任何公开的字段。布尔类型的字段通常被命名为类似于布尔访问器的方法，初始值被省略，例如，initialized, composite。其他类型的字段通常用名词或名词短语来命名，如高度、数字或体型。局部变量的语法规则与字段的语法规则相似，但更弱。
总之，要内化标准命名约定，并将其作为第二天性来使用。排版的惯例是简单明了的;语法规范更复杂、更松散。引用Java语言规范[JLS, 6.1]中的话，“如果长期以来的传统用法另有规定，就不应该盲目地遵循这些约定。运用常识。
网友评论