Java 命名规范

文章Java 命名规范分享给大家，欢迎收藏Java资料网，专注分享技术知识

在编程的世界里，命名不仅仅是一个标识符，它更像是一件得体的衣服，能够直接影响代码的可读性和用户体验。Java 作为一门广泛使用的编程语言，有着一套明确的命名约定，虽然这些规则不是强制性的，但遵守它们可以极大地提升代码的可维护性和可读性。

1 包（Package）

包的命名规则如下：

• 全部小写字母：包名应该全部使用小写字母，避免使用大写字母或下划线。
• 点分隔符：点分隔符之间有且仅有一个自然语义的英语单词。
• 单数形式：包名统一使用单数形式，例如 com.itwanger.util，而不是 com.itwanger.utils。
• 唯一前缀：在最新的 Java 编程规范中，建议开发人员在自己定义的包名前加上唯一的前缀，通常使用公司或个人博客的域名作为前缀，例如 com.itwanger。

2 类（Class）

类的命名规则如下：

• 大写字母开头：类名必须以大写字母开头。
• 名词形式：类名最好是一个名词，例如 System。
• 驼峰式命名：类名使用 UpperCamelCase 风格，即每个单词的首字母大写。
• 例外情况：某些缩写可以省略首字母，例如 DO/BO/DTO/VO/AO/PO/UID 等。
  

此外，抽象类可以使用 Abstract 或 Base 开头，异常类可以使用 Exception 结尾，测试类可以使用 Test 结尾。

3 接口（Interface）

接口的命名规则如下：

• 大写字母开头：接口名必须以大写字母开头。
• 形容词形式：接口名最好是一个形容词，例如 Runnable。
• 驼峰式命名：接口名使用 UpperCamelCase 风格。

接口和实现类之间也有一些规则：

• 实现类后缀：实现类可以使用 Impl 后缀与接口区分，例如 CacheServiceImpl 实现 CacheService 接口。
• 抽象类实现接口：抽象类可以实现接口，例如 AbstractTranslator 实现 Translatable 接口。

4 字段（Field）和变量（Variable）

字段和变量的命名规则如下：

• 小写字母开头：字段和变量名必须以小写字母开头。
• 驼峰式命名：可以包含多个单词，第一个单词的首字母小写，其他单词的首字母大写，例如 firstName。
• 避免单个字符：尽量避免使用单个字符作为变量名，除非是局部变量。
• 数组表示：类型与中括号紧挨相连来表示数组，例如 int[] arrayDemo。
• 布尔类型：POJO 类中的布尔类型变量不要加 is 前缀，以避免序列化错误。
• 避免重名：避免在子类和父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名。

5 常量（Constant）

常量的命名规则如下：

• 全部大写字母：常量名应该全部使用大写字母。
• 下划线连接：可以包含多个单词，单词之间使用下划线连接，例如 MAX_PRIORITY。
• 数字允许：可以包含数字，但不能以数字开头。

6 方法（Method）

方法的命名规则如下：

• 小写字母开头：方法名必须以小写字母开头。
• 动词形式：方法名最好是一个动词，例如 print()。
• 驼峰式命名：可以包含多个单词，第一个单词的首字母小写，其他单词的首字母大写，例如 actionPerformed()。

Service/DAO 层的方法命名规约：

• 获取单个对象：使用 get 前缀，例如 getUser()。
• 获取多个对象：使用 list 前缀，复数结尾，例如 listUsers()。
• 获取统计值：使用 count 前缀，例如 countUsers()。
• 插入操作：使用 save 或 insert 前缀，例如 saveUser()。
• 删除操作：使用 remove 或 delete 前缀，例如 removeUser()。
• 修改操作：使用 update 前缀，例如 updateUser()。

7 总结

除了上述规则外，还有一些共同的规则需要遵守：

• 命名规范：代码中的命名均不能以下划线或美元符号开始或结束。
• 拼音与英文：严禁使用拼音与英文混合的方式，更不允许直接使用中文。
• 避免歧视性词语：代码和注释中都要避免使用任何语言的种族歧视性词语。
• 统一风格：方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。
• 避免缩写：杜绝完全不规范的缩写，避免望文不知义。
• 自解释命名：使用尽量完整的单词组合来表达自定义编程元素。
• 类型名词后置：在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
• 设计模式体现：如果使用了设计模式，在命名时需体现出具体模式。
• 枚举类命名：枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

遵守这些命名约定，不仅能让你的代码更加规范，还能提升团队协作的效率，减少不必要的沟通成本。希望这些规则能帮助你在 Java 编程的道路上走得更远、更稳。

8 思维导图

9 参考链接

5 分钟编码，1 小时命名，笑

文章来源:https://blog.csdn.net/gaosw0521/article/details/143819124
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若内容造成侵权/违法违规/事实不符，请联系邮箱：jacktools123@163.com进行投诉反馈，一经查实，立即删除！