java编程规范

1.命名规范

包命名：包名一律小写, 少用缩写和长名；采用以下规则：

                                  [基本包].[项目名].[模块名].[子模块名]...

不得将类直接定义在基本包下，所有项目中的类、接口等都应当定义在各自的项目和模块包中。

类和接口命名 每个单词首字母大写

变量命名  大小写混合，第一个单词首字母小写其余单词首字母大写不应以下划线或美元符号开头；尽量避免单个字符的变量名，除非是一次性的临时变量，不易清楚识别出该变量类型的变量应使用类型名或类型名缩写作其后缀；组件或部件变量使用其类型名或类型名缩写作其后缀；集合类型变量，例如数组和矢量，应采用复数命名或使用表示该集合的名词做后缀。

常量命名：全部采用大写，单词间用下划线隔开

方法命名：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写；取值类可使用get前缀，设值类可使用set前缀，判断类可使用is(has)前缀。

2.类、接口、方法、变量声明

2.1类、接口声明

[可见性][('abstract'|'final')] [Class|Interface] class_name [('extends'|'implements')][父类或接口名]{

//方法体

}

2.2方法声明

[可见性]['abstract'] [‘static’] ['final'] ['synchronized'][返回值类型] method_name(参数列表)[('throws')][异常列表]{

//方法体

}

尽量限制成员函数的可见性。如果成员函数没必要公有 (public)，就定义为保护 (protected)；没必要保护 (protected)，就定义为私有 (private)；

声明顺序：构造方法、静态公共方法、静态私有方法、公共方法、友元方法、受保护方法、私有方法、main方法；方法参数建议顺序：(被操作者，操作内容，操作标志，其他)。

2.3变量声明

1. 一行一个声明
2. 声明局部变量的同时初始化，变量的初始值依赖于某些先前发生的计算的特殊情况下可以不用同时初始化
3. 只在代码块的开始处声明变量
4. 不要在内部代码块中声明相同的变量名
5. 公共和保护的可见性应当尽量避免，所有的字段都建议置为私有，由获取和设置成员函数（Getter、Setter）访问
6. 定义一个变量或者常量的时候，不要包含包名（类似java.security.MessageDigest digest = null）

声明顺序：常量、类变量、实例变量、公有字段、受保护字段、友元字段、私有字段。

3 异常

1. 多个异常分别捕捉，避免单一catch处理
2. 捕捉异常的目的是为了处理它（额 说的就是我）

 

4 常用

1.  if、for、do、while等语句的执行语句部分无论多少都要加括号"{}"
2. 每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释；
3. 尽量避免在循环中构造和释放对象
4. 处理 String 的时候要尽量使用 StringBuffer 类

5 代码风格

5.1间隔

1. 类、方法及相对独立的程序块之间、变量说明之后必须加空行；

2. 关键字之后要留空格， 象if、for、while  等关键字之后应留一个空格再跟左括号"（"， 以突出关键字。方法名与其左括号"（"之间不要留空格, 以与关键字区别

3. 二元操作符如   " ="、" +="  " >="、" <="、" +"、" *"、" %"、" &&"、" ||"、" <<" ," ^" 等的前后应当加空格

4. 一元操作符如" !"、" ~"、" ++"、" --"等前后不加空格

5. 强制转型后应该跟一个空格

5.2换行

一行的长度超过80个字符需要换行，换行规则如下：

1. 在一个逗号后面断开；
2. 在一个操作符前面断开；
3. 长表达式要在低优先级操作符处划分新行；
4. 新行缩进2个TAB。

5.3对齐

程序块的分界符左大括号"{" 和右大括号"}"都另起一行，应各独占一行并且位于同一列，同时与引用它们的语句左对齐

5.4缩进

缩进只使用TAB键，编辑器中请将TAB设置为4格

6 注释

不推荐使用的类和方法需要注明@Deprecated，并说明替代的类或者方法

针对集合、开关的方法，要在方法注释中表明是否多线程安全

定义为public的字段必需给出注释，在类的(静态)变量、实例变量定义之前当对其进行注释，给出该字段的描述等：

方法注释：采用JavaDoc文档注释，在方法定义之前当对其进行注释，包括方法的描述、输入、输出及返回值说明、抛出异常说明、参考链接等：

7.文件组织

文件组织规则：尽量避免出现超过2000行的程序。一个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

文件组织顺序：

1.文件注释：所有的源文件都应该在开头有一个注释，其中列出文件的版权声明、文件名、功能描述以及创建、修改记录：

2.包和引入语句：在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟导包语句

3. 类或接口注释：在类、接口定义之前应当对其进行注释，包括类、接口的描述、最新修改者、版本号、参考链接等；

4. 类或接口的声明

5. 类或接口的实现注释：如果有关类或接口的信息不适合作为“类或接口文档注释”，可以在类或接口的实现注释中给出；

6. 构造方法；

7. 普通方法：方法应该按功能分组，而不应该按作用域或访问权限进行分组。
 

参考：Java编码规范总结（参考腾讯编码规范）