读阿里巴巴泰山版《java开发手册》总结

Posted 2021-02-21 wushenjiang

写在前面

某天上网冲浪时，看见阿里巴巴发布了最新的java开发手册。好奇之下下载来了看了看。觉得收获很大，特此在这里记录一下自己觉得有用的点。
java开发手册链接：https://developer.aliyun.com/topic/java2020

代码规范篇

命名风格

• 1.[强制]所有编程相关的命名严禁使用拼音和英文混合,更不允许直接使用中文.
• 2.[强制]类名使用UpperCamelCase风格,除某些特殊情况.
• 3.[强制]方法名、参数名、成员变量、局部变量统一使用lowerCamelCase风格.
• 4.[强制]常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长.
• 5.[强制]抽象类命名使用 Abstract 或 Base 开头；异常类命名使用Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
• 6.[强制]类型与中括号紧挨相连来表示数组。如int[] arrayDemo;
• 7.[强制]包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式.
• 8.[强制]避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低.
• 9.[强制]杜绝完全不规范的缩写，避免望文不知义。
• 10.[推荐]接口类中的方法和属性不要加任何修饰符号（public 也不要加），并加上有效的javadoc注释.

常量定义

• 1.[强制]不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
• 2.[强制]在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字混淆，造成误解.
• 3.[推荐]不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。

代码格式

• 1.[强制]如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非
  空代码块则：
  1） 左大括号前不换行。
  2） 左大括号后换行。
  3） 右大括号前换行。
  4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
• 2.[强制]左小括号和右边相邻字符之间不出现空格；右小括号和左边相邻字符之间也不出现空格；而左大括号前需要加空格。如反例：if(空格a==b空格)
• 3.[强制]if/for/while/switch/do 等保留字与括号之间都必须加空格。
• 4.[强制]任何二目、三目运算符的左右两边都需要加一个空格。
• 5.[强制]采用四个空格缩进。
• 6.[强制]注释的双斜线与注释内容之间有且仅有一个空格。
• 7.[强制]单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
  1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
  2）运算符与下文一起换行。
  3）方法调用的点符号与下文一起换行。
  4）方法调用中的多个参数需要换行时，在逗号后进行。
  5）在括号前不要换行
• 8.[强制]方法参数在定义和传入时，多个参数逗号后边必须加空格。
• 9.[推荐]不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

总结

暂时先看了这些，等接着看会继续更新的。