相忘谁先忘,倾国是故国。泠泠不肯弹,蹁跹影惊鸿。
Java命名规范是一种约定俗称的准则,应用程序开发者应遵循这些规范来在整个应用程序中编写可读的代码。如果团队不遵循这些规范,他们可能会编写出难以阅读和理解的程序代码。
Java
大量使用 Camel Case
表示法来命名方法,变量等,而使用 TitleCase
用于类和接口。
让我们通过示例详细了解这些命名规范。
包的名称必须是一组以所有小写域名开头的字词(例如 com
, org
, net
等)。根据组织自己的内部命名约定,包名称的后续部分可能会有所不同。
package cn.howtodoinjava.webapp.controller; package com.company.myapplication.web.controller; package com.google.search.common;
在 Java
中,类名通常应为名词,且每个单独的单词的首字母应大写。例如
public class ArrayList {} public class Employee {} public class Record {} public class Identity {}
在 Java
中,接口名称通常应为形容词。接口应使用大写字母,每个单独单词的首字母大写。同样,当接口表示类概念时,接口也可以是名词(例如, List
和 Map
)。
public interface Serializable {} public interface Clonable {} public interface Iterable {} public interface List {}
方法应该是动词。它们代表一个动作,方法名称应清晰易懂,表明它要执行的动作。为了清楚地表示操作,方法名称可以是单个单词,也可以是2-3个单词。单词应使用驼峰式大写。
所有实例,静态和方法参数变量名称均应使用驼峰表示法。它们应该简短,且足以描述其目的。临时变量可以是单个字符,例如循环中的计数器。
public Long id; public EmployeeDao employeeDao; private Properties properties; for (int i = 0; i < list.size(); i++) { }
Java
常量应全部为大写,其中单词之间用下划线字符(”_“)分隔。确保将 final
修饰符与常量变量一起使用。
public final String SECURITY_TOKEN = "..."; public final int INITIAL_SIZE = 16; public final Integer MAX_SIZE = Integer.MAX;
通用类型参数名称应为大写单字母。通常建议使用字母 T
作为类型。在 JDK
类中, E
用于集合元素, S
用于服务加载程序,而 K
和 V
用于映射键和值。
public interface Map <K,V> {} public interface List<E> extends Collection<E> {} Iterator<E> iterator() {}
类似于类常量,枚举名称应全部为大写字母。
enum Direction {NORTH, EAST, SOUTH, WEST}
注释名称遵循标题大小写。根据要求,它们可以是形容词,动词或名词。
public @interface FunctionalInterface {} public @interface Deprecated {} public @interface Documented {} public @Async Documented {} public @Test Documented {}
在本文中,我们讨论了再编写代码要遵循的 Java
命名规范,这使代码更具可读性和可维护性。
在使用任何编程语言编写简洁的代码时,命名约定可能是遵循的第一个最佳实践。
关注微信公众号 java干货 不定期分享干货资料
原文链接: Java Naming Conventions