团队代码开发规范

结合阿里java开发手册整理了一些js和java都试用的规范，后期会持续更新；

命名规约:

1. 【强制】 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

反例： _name / __name / $Object / name_ / name$ / Object$

2. 【强制】 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式

也要避免采用。

反例：  DaZhePromotion [ 打折 ] /  getPingfenByName() [ 评分 ] /  int 某变量 = 3

正例：  alibaba /  taobao / youku /  hangzhou 等国际通用的名称，可视同英文。

3.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从

驼峰形式。

正例：  localValue /  getHttpMessage() /  inputUserId

4. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

正例：  MAX _ STOCK _ COUNT

反例：  MAX _ COUNT

5.【强制】杜绝完全不规范的缩写，避免望文不知义。

反例：  AbstractClass “缩写”命名成AbsClass；condition “缩写”命名成  condi ，此类

随意缩写严重降低了代码的可阅读性。

6. 方法命名规约

1 ） 获取单个对象的方法用 get 做前缀。

2 ） 获取多个对象的方法用 list 做前缀。

3 ） 获取统计值的方法用 count 做前缀。

4 ） 插入的方法用 save（ 推荐 ） 或 insert 做前缀。

5 ） 删除的方法用 remove（ 推荐 ） 或 delete 做前缀。

6 ） 修改的方法用 update 做前缀。

格式规约：

 

1. 【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行； 如果

是非空代码块则：

1 ） 左大括号前不换行。

2 ） 左大括号后换行。

3 ） 右大括号前换行。

4 ） 右大括号后还有 else 等代码则不换行 ； 表示终止右大括号后必须换行。

 

2. 【强制】 左括号和后一个字符之间不出现空格 ； 同样，右括号和前一个字符之间也不出现空

格。

// 左大括号前加空格且不换行；左大括号后换行

if (flag == 1) {

console.log("world");

// 右大括号前换行，右大括号后有 else，不用换行

} else {

Console.log("ok");

// 在右大括号后直接结束，则必须换行

}

 

3. 【强制】 if / for / while/ switch / do 等保留字与左右括号之间都必须加空格。

// 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格

if (flag == 0) {

console.log("say")

}

 

4. 【强制】任何运算符左右必须加一个空格。

说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

var flag = 0;

 

5. 【强制】缩进采用 4 个空格，禁止使用 tab 字符。

说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，

请勿勾选 Use tab character ；而在 eclipse 中，必须勾选 insert spaces for tabs 。

 

6. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

2 ） 运算符与下文一起换行。

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

4 ） 在多个参数超长，逗号后进行换行。

5 ） 在括号前不要换行

 

7. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

正例：下例中实参的" a",后边必须要有一个空格。

method("a", "b","c");

 

8. 【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐

 

9. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义

之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

说明：没有必要插入多行空格进行隔开

 

OOP规约：

1.      【强制】不能使用过时的类或方法。

2.      【强制】构造方法里

3.      面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

 

控制语句：
1. 【强制】在一个 switch 块内，每个 case 要么通过 break / return 等来终止，要么注释说明程

序将继续执行到哪一个 case 为止； 在一个 switch 块内，都必须包含一个default 语句并且

放在最后，即使它什么代码也没有。

 

2. 【强制】在 if / else / for/ while / do 语句中必须使用大括号，即使只有一行代码，避免使用

下面的形式： if (condition) statements;

 

3. 【推荐】推荐尽量少用 else ，  if - else 的方式可以改写成：

if(condition){

...

return obj;

}

// 接着写 else 的业务逻辑代码;

说明：如果非得使用 if()...else if()...else... 方式表达逻辑，【强制】请勿超过 3 层，

超过请使用状态设计模式。

正例：逻辑上超过 3 层的 if-else 代码可以使用卫语句，或者状态模式来实现。

 

4. 【推荐】除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复

杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么

样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？

正例：

//伪代码如下

boolean existed = (file.open(fileName,"w") != null) && (...) || (...);

if (existed) {

...

}

反例：

if ((file.open(fileName, "w") !=null) && (...) || (...)) {

...

}

 

5. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、

获取数据库连接，进行不必要的 try - catch 操作（ 这个 try -catch 是否可以移至循环体外） 。

 

注释规约：
1. 【强制】所有的类都必须添加创建者信息。

2. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释

使用/* */注释，注意与代码对齐

3. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持

英文原文即可。

反例：“ TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

4. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑

等的修改。

说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，

就失去了导航的意义。

5. 【参考】注释掉的代码尽量要配合说明，而不是简单的注释掉。

说明：代码被注释掉有两种可能性：1 ）后续会恢复此段代码逻辑。2 ）永久不用。前者如果没

有备注信息，难以知晓注释动机。后者建议直接删掉（ 代码仓库保存了历史代码 ） 。

6. 【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑 ； 第二、能够描述业务含

义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同

天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路； 注释也是给继任者看

的，使其能够快速接替自己的工作。

7. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的

一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

8. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，

经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1 ） 待办事宜 （TODO） : （ 标记人，标记时间， [ 预计处理时间 ]）

表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc

还没有实现，但已经被广泛使用。只能应用于类，接口和方法（ 因为它是一个 Javadoc标签 ） 。

2 ） 错误，不能工作 （FIXME） : （ 标记人，标记时间， [ 预计处理时间 ]）

在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况

 

二、异常日志

( 一)  异常处理

3. 【强制】对大段代码进行 try -catch ，这是不负责任的表现。 catch 时请分清稳定代码和非稳

定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分

异常类型，再做对应的异常处理。

 

4. 【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请

将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的

内容。

 

 

 

( 二)  日志规约

1.      【强制】日志文件推荐至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。

2. 【强制】应用中的扩展日志 （ 如打点、临时监控、访问日志等 ） 命名方式：

appName _ logType _ logName . log 。 logType :日志类型，推荐分类有

stats / desc / monitor / visit 等 ；logName :日志描述。这种命名的好处：通过文件名就可知

道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。

正例： mppserver 应用中单独监控时区转换异常，如：

mppserver _ monitor _timeZoneConvert . log

说明：推荐对日志进行分类，错误日志和业务日志尽量分开存放，便于开发人员查看，也便于

通过日志对系统进行及时监控。

3. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适

从。注意日志输出的级别， error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必

要，请不要在此场景打出 error 级别。

 

4. 【推荐】谨慎地记录日志。生产环境禁止输出debug 日志； 有选择地输出 info 日志 ； 如果使

用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘

撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请

思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？