Java项目命名
Java项目命名所有单词应当全部为小写,多个单词使用短横线‘-’分隔。
spring-cloud
Java文件命名
1.源代码文件名必须与公共类的名字相同。
2.一个Java文件中只能有一个public类;
3.如果文件中只有一个类,文件名必须与类名一致;
4.如果文件中不止一个类,文件名必须与public类名一致;
5.如果文件中不止一个类,而且没有public类,文件名可与任一类名一致。
包命名
包名统一使用小写,点分隔符之间有且仅有一个自然语义的英文单词或者多个单词自然连接到一块。(如 springframework
,deepspace
不需要使用任何分割)
一般地,包命名常采用顶级域名作为前缀,例如com,net,org,edu,gov,cn,io等,随后紧跟公司/组织/个人名称以及功能模块名称。
package com.alibaba.druid
类命名
类名使用大驼峰命名形式,类命通常时名词或名词短语,接口名除了用名词和名词短语以外,还可以使用形容词或形容词短语,如Cloneable
,Callable
等,表示实现该接口的类有某种功能或能力。
class EmployeeService{
}
不能使用Java保留字作为类名,对于一些特殊特有名词缩写也可以使用全大写命名,比如XMLHttpRequest
。
方法命名
方法命名采用小驼峰的形式,首字小写,往后的每个单词首字母都要大写。
和类名不同的是,方法命名一般为动词或动词短语,与参数或参数名共同组成动宾短语,即动词 + 名词。一个好的函数名一般能通过名字直接获知该函数实现什么样的功能。
public String getUserName(){
}
变量命名
变量命名采用小驼峰的形式,首字小写,往后的每个单词首字母都要大写。
在变量命名过程中,不能由数字开头,不建议使用“_”或“$”作为前缀或者单词之间的分割符号。变量不能是保留字或者关键字。
private Long orderItemId;
常量命名
常量一般采用全部大写(作为方法参数时除外),单词间用下划线分割。
public static final String LOGIN_USER_SESSION_KEY = "current_login_user";
public static final int MAX_AGE_VALUE = 120;