【Java】阿里巴巴java开发手册总结(我能看懂的)

尽管这本《手册》句句是精华,但由于我还是个菜鸟,这里仅作(我能用的到的&&我能看懂的)的笔记

1.1命名风格
1、类名用UpperCamelCase的风格

2、方法名、参数名、成员变量、局部变量都统一用lowerCameCase的风格,必须遵循驼峰形式。

补充:
驼峰形式:
骆驼式命名法就是当变量名或函数名是由一个或多个单词连结在一起,而构成的唯一识别字时,第一个单词以小写字母开始;从第二个单词开始以后的每个单词的首字母都采用大写字母。

3、类型与中括号间无空格连接定义数组

int[] arrayDemo

4、避免在子父类成员变量之间或者不同代码块的局部变量间采用完全相同的命名方式,使可读性降低。

5、杜绝完全不规范的缩写,避免词不达意。

6、为了达到代码自解释的目的,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。

7、各层的命名规约

Service/DAO层方法命名规约如下

获取单个对象的方法用get作为前缀。
获取多个对象的方法用list作为前缀。
获取统计值的方法用count作为前缀
插入方法用sava/insert作为前缀
删除方法用remove/delata作为前缀
修改方法用update作为前缀

1.2常量定义
1、long或Long初始赋值时,数值后用L而不是l,因为1和l易搞混

2、不要使用一个常量类维护所有的常量,要按常量功能进行归类,分开维护。

缓存相关常量放在类CaseConsts下;系统配置相关常量放在类ConfigCoonsts下。

1.3代码格式

1、大括号使用规定 。如果{}内为空,则简洁的写成{}即可,大括号内既无换行也无空格。若是非空代码块则:

1)左大括号前不换行

2)左大括号后换行

3)右大括号前换行

4)右大括号后若有else等则不换行;表示终止的右大括号后必须换行。

2、左小括号和字符间不出现空格

3、if/for/while/switch/do等保留字与括号间必须加空格。

4、任何一个二目、三目的运算符的左右两边都要加一个空格
说明:
运算符包括赋值运算符、逻辑运算符、加减乘除符号等。

5、采用4个空格缩进,禁止使用Tab控制符。

6、注释的双斜线与注释内容之间有且只有一个空格,单行字符数不超过120个,超出则需换行,换行时遵循以下规则。

1)第二行相对于第一行缩进四个空格,从第三行起不再换行

2)运算符与下文一起换行

3)方法调用的点符号与下文一起换行。

4)方法调用多个参数需要换行时,在逗号后进行

5)在括号前不要换行

7、方法参数定义和传入时,多个参数逗号后必须加空格。

8、没有必要增加若干空格来使某一行的字符与上一行的对应的位置的字符对齐。

1.4OOP规约

1、直接用类名调用静态方法和静态变量,避免使用对象。

2、相同的参数类型,相同的业务含义才可以使用可变参数,避免使用Object.可变参数必须在参数列表的最后。

1.7控制语句

1、在一个switch块里,都必须包含一个default语句放在最后,即使它什么代码也没有。

2、 在if/else/for/while/do语句中,必须使用大括号,即使只有一行代码。

3、在高并发场景中,避免使用“等于”判断作为中断或退出条件,应用大于或小于的区间判断条件来代替。

4、尽量少使用if else的方式,可用以下方法代替
if (condition){

return obj;
}

5、不要在条件判断中执行其它复杂的语句,可将复杂的逻辑判断的结果赋值给一个有意义的布尔类型变量名,以提高可读性。

6、避免采用反逻辑运算符。
说明:
取反逻辑不利于快速理解,并且取反逻辑写法必然存在对应的正向逻辑写法

1.8注释规约

1、类、类属性、类方法的注释必须使用Javadoc的规范,必须使用/*内容/的方式,不得使用//xx方式。

2、方法内部的单行注释,在注释语句的上方另起一行,使用//注释。方法内部多行注释,使用/* */注释,注意与代码对齐。

3、与其用半吊子的英语来注释,倒不如用中文把问题说清楚,专有名词保持英文即可。

猜你喜欢

转载自blog.csdn.net/tyrant_forever/article/details/89164465