java项目规范_java 项目规范

命名规范

1公共

名称必须要要用英文【严格禁止拼音】

不可以通过大小写来区别名字

名字不能以"_"等特殊字符开头。

名字中各个单词的首字母必须大写，其他的小写(类名和接口名遵守此规范)

2包命名

包命名中不能有重复的名字

包名必须全部小写

包中不能包含"_"等特殊字符。

与业务相关的包命名格式为：

cn.com.caissa...

·为项目英文名称或英文简称或英文缩写。

·为子系统名

·为模块英文名称或英文简称或英文缩写，如果无细分模块的话可以省略。

与业务无关的包命名格式

cn.com.caissa...common

根据共通的范围大小可以调整包的路径，如工程共通用和子系统共通用和某一个模块内共通用。

3类命名

类的名称要有意义，并且使用完整的英文单词，如果单词过长，则要使用易于理解的单词缩写。

不要定义JDK中已经有的类。

接口的实现类为去掉接口开头的字母I，在结尾加上Impl。

所有抽象类的名字必须以【Abstract】开头。

所有异常类的名字必须以【Exception】结尾。

所有接口类的名字必须以"I"开头。

4变量

采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

应该简短有意义，能够指出其用途。但是例如循环因子可以使用诸如“i”之类的变量。

类的引用命名首字母要小写，其后单词的首字母大写。引用名要有意义

接口的引用名首字母要小写，其后单词首字母大写。引用名要有意义

集合的引用命名采用引用名 + 后缀

后缀命名规则参考如下：

List List

Map Map

Set Set

5常量

常量的名字要全部大写，单词之间要以"_"隔开，并且使用final static修饰

6方法名

方法名要以动词加名词的形式组织，首字母小写，后边的单词的首字母都是大写。

set/get方法 方法名为 "set+属性名" 或者 "get+属性名"   boolean类型取得方法为 "is+属性名"    属性存取的getter和setter方法，使用系统生成的即可