Java 命名规范
在学了Java近一年以后,做的项目大大小小也有几个,但命名规范一直是一个痛,总是随心所欲的命名,最近又要做一个项目
在这之前,想要把命名规范好好的学习下
首先最重要的
1:Java是面向对象的编程,所以命名应以名词为主
2:驼峰命名法:函数或变量名是几个单词拼接而成时,即要用到驼峰命名,即变量或函数名的第一个单词首字母小写,其余的
都大写 譬如:firstName
下面开始分类对命名进行总结
一:包名
1:使用公司或机构的顶级域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性。包名全部为小写字母,且具有
实际的区分意义。
2:
1:选择有意义的名字,能快速地传达该类的用途。
2:所有包的命名必须采用小写英文字母。
3:在包名的接下来一个单词为模块的名称
二:类名
类名必须使用名词,如果一个类名内含多个单词,那么各个单词第一个字母大写,后续字母小写,起伏呈驼峰状,人称驼峰式命
名。给类名命名时,必须保证准确、简洁且容易理解。尽量使用完整单词,避免使用缩写词(除了大家公认的)
2.1 类的命名
2.1.1 一般要求
1、选择有意义的名字,能快速地传达该类的用途。
2、参照java驼峰命名法,类名的首字母必须采用大写的形式,如果类名为多词组合而成的话,那么每个词的首字母必须采用大写
。如:StudentAnswer.java
3、当要区别接口类和实现类的时候,可以在类的后面加上“Impl”。如:接口类:UserInterface.java 接口实现类:UserInterfaceI
mp
4:实体类没有后缀名。
下面说一下实际中的应用
应用系统中经常应用分层,Dao层(数据库访问)、Service层(业务处理)、Web层(页面控制action类),每一层的类的名称尽量带上该层后缀。
1、Dao层
a、接口类:采用JavaBean+Interface+Dao的形式来定义,即,实体对象+Interface+Dao。 如:用户对象接口类: UserInterfaceDao,其中xxx为模
块名称。
b、实现类:采用JavaBean+Interface+Impl+Dao的形式来定义,即,实体对象 +Interface+Impl+Dao。 如:用户对象实现类:UserInterfaceImpl
Dao
2、Service层
a、接口类:采用Xxx+Interface+Service的形式来定义,即,模块+Interface+Service。 如:用户管理接口类:UserMsgInterfaceServiec
b、实现类:采用Xxx+Interface+Impl+Service的形式来定义,即,模块+Interface+Impl+Service。如:用户管理实现类:UserMsgInterfaceImplServ
iec
3、Web层(action类)
a、实现类:采用县 Xxx+Operator+Action的形式来定义,即,模块+操作+Action。如 用户模块User+删除操作Delete+Action = UserDeleteAction
三:变量名
(1):一般要求
1:要求能快速表达出变量名所代表的变量
2:驼峰命名法,变量名首字母小写,后面每个单词首字母大写
(2):、变量使用技巧:
a、在一段函数中不使用同一个变量表示前后意义不同的两个数值。
b、除非是在循环中,否则一般不推荐使用单个字母作为变量名,i、j、k等只作为小型循环的循环索引变量。
c、避免用Flag来命名状态变量。
d、用Is来命名逻辑变量,(以前未注意过)如:blnFileIsFound方式,通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚
的理解布尔变量所代表的意义。
e、如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCou
nt,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。
(3):静态变量
1、选择有意义的名字,能快速地传达该变量的用途。
2、参照java驼峰命名法,采用全部大写的形式来书写,对于采用多词合成的变量采用“_”来连接各单词。如:USER_LIST
四:方法的命名
1、选择有意义的名字,能快速地传达该方法的用途。
2、参照java驼峰命名法,首字母以小写开头,每个单词首字母大写(第一个单词除外)。
3、方法表示一种行为,它代表一种动作,最好是一个动词或者动词词组或者第一个单词为一个动词。
4、属性方法:以get/set开头,其后跟字段名称,字段名称首字母大写。如:getUserName()
5、数据层方法:只能以insert(插入),delete(删除),update(更新),select(查找),count(统计)开头,其他层方法避免以这个5个单词开头,以免造成误解。
6、服务层方法,根据方法的行为命名,只描述方法的意义,而不采用方法的目的命名。比如系统的添加新用户,用户可以前台注册,也可以管理员后台添加,方法会被重用,所以最好不要用使用register,采用add会更好写。避免使用与web层相关的方法。