java编码规范

java编码规范

一、注释
1.分类：注释分实现注释和文档注释两类
实现注释--为/* */和//格式，有块、单行、尾端、行末四种注释方式，在局部变量进行注释
文档注释--为/** */格式，在包、类、接口、方法、类变量、实例变量前进行注释
2.规则：用中文描述，注释量50%以上，与代码同步，明确注释的含义，在关键代码、复杂代码、分支语句要进行注释
3.避免：缩写，特殊字符，在代码中写注释

二、语句
1.简单语句：每行至多一个简单语句，例如定义字符变量：String str = "A";
2.返回语句：return语句一般不用小括号，除非能明确表示含义，例如：return (A>2?true:false)
3.switch中若没有Break要添加注释

三、换行
1.行长度一般不要超过80个字，不超过120字也可以接受，最好不要影响阅读性
2.在一个逗号后面断开，在一个操作符前面断开
3.新的一行应该与上一行同一级别表达式的开头处对齐
4.if语句括号内的换行通常使用2个TAB的规则，因为常规缩进(1个TAB)会使语句体看起来比较费劲

四、空白
1.空行规则：（1）.方法间，（2）.变量和方法间，（3）.方法逻辑间
2.空格规则：（1）.关键字与()之间，（2）.参数列表逗号后，（3）.除.之外的二元操作符加空格，（4）.for语句分号后
3.缩进规则：类中成分，方法体或语句块的成分，换行后非起始行---一般在上一级成分的基础上加一个缩进

五、命名规范
1.包名：小写
2.类名/接口：每个单词首字母大写，使用完整单词拼接
3.方法：首字母小写，其他拼接的单词首字母大写
4.变量：不能以下划线和美元符号开头，实例名、类常量等与方法规则一致，变量名应简短
5.常量：全部大写，并且每个字母间以下划线隔开

六、编程习惯
1.实例或类变量一般私有，公有的时候一般是作为数据结构
2.访问一个类的静态属性，一般是用该类直接引用
3.除-1、0、1外的数字一般要用常量来标识它的意思
4.同一个语句中避免给多个变量赋值
5.在一个运算的表达式中要用圆括号来表达运算的优先级，容易看懂

七、编码规则
1.数据库及时关闭，多个IO要关闭，都要用try-catch
2.捕获到异常若不处理，则要用日志进行打印，自己抛出异常要明确异常含义
3.运算时用括号明确表示运算的优先级
4.声明数组用int[] index，经过了一个强转的过程，可读性差
5.不用system.out打印，同一用日志打印
6.集合必须指定类型
7.一个文件不要定义两个类
8.条件语句不要用==号来判断
9.尽量不要强转
10.异常：不要抛出过多异常，异常要明确分类

八、性能可靠
1.数组复制使用System.arraycopy(*)
2.不要使用循环将集合转为数组，可以使用集合的toArray()方法
3.大量字符串的相加等于处理应该使用StringBuffer
4.对类中日志工具对象logger应声明为static

九、SSH相关规则
1.命名规则：接口要以大写字母I开头(或者实现类要以Impl结尾)并放在impl目录下
2.以该类文件结尾：Action,Controller,Service,Dao
3.注解声明Sprng的bean：@Controller-Action（Controller），@Service-Service，@Repository-DAO，@Component-其他
4.注解方式声明Spring的bean时，要定义bean的名字为常量
5.一个Action类的方法中，只调用一次Service类：（1）避免掉用多个事务的时候没有办法回滚所有事务，（2）一个业务逻辑应在一个Service里完成，可以在Service中调用其他Service
6.跟数据库相关的SQL应放入Dao层