前言

前言

《阿里巴巴 Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总 结，经历了多次大规模一线实战的检验及不断的完善，系统化地整理成册，反馈给广 大开发者。现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是 编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：数据库的表 结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致后续 维护艰难；没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以 Java 开发者为中心 视角，划分为编程规约、异常日志、单元测试、安全规约、工程结构、MySQL 数据库六 个维度，再根据内容特征，细分成若干二级子目录。根据约束力强弱及故障敏感性，

规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中，“说明”对内 容做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要 提防的雷区，以及真实的错误案例。

本手册的愿景是码出高效，码出质量。现代软件架构都需要协同开发完成，高效 协作即降低协同成本，提升沟通效率，所谓无规矩不成方圆，无规范不能协作。众所 周知，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全。试想如 果没有限速，没有红绿灯，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是 消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式 一起做事，提升协作效率。代码的字里行间流淌的是软件生命中的血液，质量的提升 是尽可能少踩坑，杜绝踩重复的坑，切实提升质量意识。

考虑到可以零距离地与众多开发同学进行互动，决定在线维护《手册》内容，此

版本号为1.3.0的

PDF

日杭州云栖大会上，进行阿里巴巴 Java 开发规约插件全球首发，插件点此下载，阿里 巴巴云效（一站式企业协同研发云）也会集成代码规约扫描引擎。最后，《码出高效

——阿里巴巴 Java 开发手册详解》即将出版，敬请关注。

目录

前言

一、编程规约 ... 1

(一) 命名风格 ... 1

(二) 常量定义 ... 3

(三) 代码格式 ... 4

(四) OOP 规约 ... 6

(五) 集合处理 ... 9

(六) 并发处理 ... 12

(七) 控制语句 ... 14

(八) 注释规约 ... 16

(九) 其它 ... 17

二、异常日志 ... 18

(一) 异常处理 ... 18

(二) 日志规约 ... 19

三、单元测试 ... 21

四、安全规约 ... 23

五、 MySQL 数据库 ... 24

(一) 建表规约 ... 24

(二) 索引规约 ... 25

(三) SQL 语句 ... 27

(四) ORM 映射 ... 28

六、工程结构 ... 30

(一) 应用分层 ... 30

(二) 二方库依赖 ... 31

(三) 服务器 ... 32

附 1：版本历史 ... 34

附 2：本手册专有名词 ... 35

（注：浏览时请使用 PDF 左侧导航栏）

Java 开发手册

版本号 制定团队 更新日期 备注

1.3.0 阿里巴巴集团技术团队 2017.9.25 增加单元测试规约（PDF 终极版）

一、编程规约

(一) 命名风格

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

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

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

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

正例：

alibaba

taobao

youku

hangzhou

反例：

DaZhePromotion [

]

getPingfenByName() [

]

int

UpperCamelCase

DO

BO

DTO

VO

AO

正例：

MarcoPolo

UserDO

XmlService

TcpUdpDeal

TaPromotion

反例：

macroPolo

UserDo

XMLService

TCPUDPDeal

TAPromotion

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用

lowerCamelCase

正例：

localValue

getHttpMessage()

inputUserId

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

正例：

MAX

STOCK

COUNT

反例：

MAX

COUNT

6. 【强制】抽象类命名使用

Abstract

Base

；

Exception

；

Test

7. 【强制】中括号是数组类型的一部分，数组定义如下：String[]

args;

反例：使用

String args[]

8. 【强制】

POJO

is

反例：定义为基本数据类型

Boolean isDeleted；

isDeleted()

RPC

框架在反向解析的时候，“以为”对应的属性名称是

deleted

9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式，但是类名如果有复数含义，类名可以使用复数形式。

正例： 应用工具类包名为

com

alibaba

open

util

MessageUtils（

spring

）

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

反例：

AbstractClass

AbsClass；condition

condi

11. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词 组合来表达其意。

正例：从远程仓库拉取代码的类命名为

PullCodeFromRemoteRepository。

反例：变量

int a;

12. 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

正例：

public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

13. 【推荐】接口类中的方法和属性不要加任何修饰符号

（public

^）

Javadoc

正例：接口方法签名：

void f();

接口基础常量表示：

String COMPANY

alibaba

;

反例：接口方法定义：public abstract

void f();

说明：

JDK

default

14. 接口和实现类的命名有两套规则：

1

^）

Service

DAO

SOA

Impl

正例：

CacheServiceImpl

CacheService

2

^）

^（

able

）

AbstractTranslator

Translatable

15. 【参考】枚举类名建议带上

Enum

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例：枚举名字为

ProcessStatusEnum 的

SUCCESS

UNKOWN

REASON

A) Service

DAO

1

）

get

2

^）

list

3

^）

count

4

^）

save/insert

5

）

remove/delete

6

^）

update

B)

1

）

xxxDO

xxx

2

^）

xxxDTO

xxx

3

^）

xxxVO

xxx

4

^） POJO

DO

DTO

BO

VO

xxxPOJO

(二) 常量定义

1. 【强制】不允许任何魔法值

^（

）

反例：

String key

tradeId;

cache

put(key

value);

2. 【强制】

long

Long

L

l

说明：

Long a

l;

Long

3. 【推荐】不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。

说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

正例：缓存相关常量放在类

CacheConsts

；

ConfigConsts

4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。

1

^）

client

jar

constant

2

^）

modules

constant

“是”的变量：

A

public static final String YES

yes

;

B

public static final String YES

y

;

A

YES

equals(B

YES)

true

false

3

^）

constant

4

^）

constant

5

^）

private static final

5. 【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。下面 正例中的数字就是延伸信息，表示星期几。

正例：public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}

(三) 代码格式

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

^；

1

）

2

^）

3

^）

4

）

else

；

2. 【强制】 左小括号和字符之间不出现空格

^；

反例：if (空格 a == b 空格)

3. 【强制】

if

for

while

switch

do

4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。

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

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

tab

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

请勿勾选

Use tab character

insert spaces for tabs

^（

^）

public static void main(String[] args) { // 缩进 4 个空格

String say = "hello";

// 运算符的左右必须有一个空格 int flag = 0;

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

System.out.println(say);

}

// 左大括号前加空格且不换行；左大括号后换行 if (flag == 1) {

System.out.println("world");

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

System.out.println("ok");

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

}

6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。

正例：

//

//

7. 【强制】单行字符数限制不超过

120

1

4

2

）

3

^）

4

^）

5

^）

正例：

StringBuffer sb = new StringBuffer();

// 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行 sb.append("zi").append("xin")...

.append("huang")...

.append("huang")...

.append("huang");

反例：

StringBuffer sb = new StringBuffer();

// 超过 120 个字符的情况下，不要在括号前换行 sb.append("zi").append("xin")...append

("huang");

// 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行 method(args1, args2, args3, ...

, argsX);

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

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

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

9. 【强制】

IDE

text file encoding

UTF

; IDE

Unix

不要使用

Windows

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

正例：

int a = 3;

long b = 4L;

float c = 5F;

StringBuffer sb = new StringBuffer();

说明：增加

sb

a

b

c

11. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义 之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

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

(四) OOP 规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成 本，直接用类名来访问即可。

2. 【强制】所有的覆写方法，必须加@

Override

说明：

getObject()

get

bject()

O

Override

可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编 译报错。

3. 【强制】相同参数类型，相同业务含义，才可以使用

Java

Object

（

）

正例：public User getUsers(String type, Integer... ids) {...}

4. 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生 影响。接口过时必须加@

Deprecated

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

说明：

java

net

URLDecoder

decode(String encodeStr)

decode(String source, String encode)

那么有义务同时提供新的接口

；

6. 【强制】

Object

equals

equals

正例："

test

.equals(object);

反例：

object.equals(

test

);

说明：推荐使用

java

util

Objects

equals（JDK

^）

7. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用

equals

说明：对于

Integer var

Integer

IntegerCache

cache

Integer

推荐使用

equals

8. 关于基本数据类型与包装数据类型的使用标准如下：

1

^）

POJO

2

）

RPC

3

^）

说明：

POJO

NPE

正例：数据库的查询结果可能是

null

NPE

反例：比如显示成交总额涨跌情况，即正负

x

x

RPC

null

9. 【强制】定义

DO

DTO

VO

POJO

反例：

POJO

gmtCreate

new Date();

10. 【强制】序列化类新增属性时，请不要修改

serialVersionUID

；

serialVersionUID

说明：注意

serialVersionUID

11. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在

init

12. 【强制】

POJO

toString

source

generate toString

时，如果继承了另一个

POJO

super

toString

说明：在方法执行抛出异常时，可以直接调用

POJO

toString()

13. 【推荐】使用索引访问用

String

split

IndexOutOfBoundsException

说明：

String str = "a,b,c,,";

String[] ary = str.split(",");

// 预期大于 3，结果是 3

System.out.println(ary.length);

14. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，

便于阅读，此条规则优先于第15 条规则。

15. 【推荐】 类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 >

getter

setter

方法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好

；

；

；

Service

DAO

getter

setter

16. 【推荐】

setter

this

getter

setter

反例：

public Integer getData() { if (true) {

return this.data + 100;

} else {

return this.data - 100;

} }

17. 【推荐】循环体内，字符串的连接方式，使用

StringBuilder

append

说明：反编译出的字节码文件显示每次循环都会

new

StringBuilder

append

toString

String

反例：

String str = "start";

for (int i = 0; i < 100; i++) { str = str + "hello";

}

18. 【推荐】

final

final

1） 不允许被继承的类，如：

String

2） 不允许修改引用的域对象，如：

POJO

3） 不允许被重写的方法，如：

POJO

setter

4） 不允许运行过程中重新赋值的局部变量。

5） 避免上下文重复使用一个变量，使用

final

19. 【推荐】慎用

Object

clone

说明：对象的

clone

clone

20. 【推荐】类成员与方法访问控制从严：

1

^）

new

private

）

public

default

3

^）

static

protected

^）

static

private

^）

static

private

6

）

static

final

）

private

^）

protected

说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。

思考：如果是一个

private

public

service

一个

public

视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

(五) 集合处理

1. 【强制】关于

hashCode

equals

1） 只要重写

equals

hashCode

2） 因为

Set

hashCode

equals

Set

3） 如果自定义对象做为

Map

hashCode

equals

说明：

String

hashCode

equals

String

key

2. 【强制】

ArrayList

subList

ArrayList

ClassCastException

异常，即

java

util

RandomAccessSubList cannot be cast to java

util

ArrayList

subList

ArrayList

SubList

ArrayList

ArrayList

SubList

3. 【强制】在

subList

删除均会产生

ConcurrentModificationException

4. 【强制】使用集合转数组的方法，必须使用集合的

toArray(T[] array)

list

size()

说明：使用

toArray

toArray

；

[ list

size() ]

null

正例：

List<String> list = new ArrayList<String>(2);

list.add("guan");

list.add("bao");

String[] array = new String[list.size()];

array = list.toArray(array);

反例：直接使用

toArray

Object[]

ClassCastException

5. 【强制】使用工具类

Arrays

asList()

add

remove

clear

UnsupportedOperationException

说明：

asList

Arrays

Arrays

asList

体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { "you", "wu" };

List list = Arrays.asList(str);

第一种情况：list.add("yangguanbao"); 运行时异常。

第二种情况：str[0] = "gujin"; 那么list.get(0)也会随之修改。

6. 【强制】泛型通配符<?

extends T

add

<? super T>

get

说明：扩展说一下

PECS(Producer Extends Consumer Super)

extends T

<? super T>

7. 【强制】不要在

foreach

remove

add

remove

Iterator

方式，如果并发操作，需要对

Iterator

正例：

Iterator<String> iterator = list.iterator();

while (iterator.hasNext()) {

String item = iterator.next();

if (删除元素的条件) { iterator.remove();

} }

反例：

List<String> list = new ArrayList<String>();

list.add("1");

list.add("2");

for (String item : list) { if ("1".equals(item)) {

list.remove(item);

} }

说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的 结果吗？

8. 【强制】 在

JDK

Comparator

Arrays

sort

Collections

sort

IllegalArgumentException

说明：三个条件如下

1

^） x

y

y

x

2

） x

y

y

z

x

z

3

） x

y

x

z

y

z

反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

new Comparator<Student>() {

@Override

public int compare(Student o1, Student o2) { return o1.getId() > o2.getId() ? 1 : -1;

} };

9. 【推荐】集合初始化时，指定集合初始值大小。

说明：

HashMap

HashMap(int initialCapacity)

正例：

initialCapacity =

0.75，

16（即默认值）。

反例：

HashMap

1024

7

resize

hash

10. 【推荐】使用

entrySet

Map

KV

keySet

说明：

keySet

Iterator

hashMap

key

value

entrySet

key

value

entry

JDK

Map

foreach

正例：

values()

V

list

；keySet()

K

Set

；entrySet()

K

V

11. 【推荐】高度注意

Map

K

V

null

集合类 Key Value Super 说明

Hashtable 不允许为null 不允许为null Dictionary 线程安全

ConcurrentHashMap 不允许为null 不允许为null AbstractMap 锁分段技术（JDK8:CAS）

TreeMap 不允许为null 允许为null AbstractMap 线程不安全

HashMap 允许为null 允许为null AbstractMap 线程不安全

反例：

由于 HashMap 的干扰，很多人认为 ConcurrentHashMap

null

存储

null

NPE

12. 【参考】合理利用好集合的有序性

(sort)

(order)

(unsort)

(unorder)

说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次 序是一定的。如：

ArrayList

order

unsort；HashMap

unorder

unsort；TreeSet

order

sort

13. 【参考】利用

Set

List

contains

(六) 并发处理

1. 【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。

说明：资源驱动类、工具类、单例工厂类都需要注意。

2. 【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。

正例：

public class TimerTaskThread extends Thread { public TimerTaskThread() {

super.setName("TimerTaskThread");

...

}

3. 【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资 源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者

“过度切换”的问题。

4. 【强制】线程池不允许使用

Executors

ThreadPoolExecutor

说明：

Executors

1

:

2）

:

SimpleDateFormat

static

static

DateUtils

正例：注意线程安全，使用

DateUtils

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {

@

protected DateFormat initialValue() { return new SimpleDateFormat("yyyy-MM-dd");

} };

说明：如果是

JDK

Instant

Date

LocalDateTime

Calendar

DateTimeFormatter

SimpleDateFormat

simple beautiful strong

immutable thread

safe

6. 【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁

；

；

说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用

RPC

7. 【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造 成死锁。

说明：线程一需要对表

A

B

C

A

B

C

8. 【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加 锁，要么在数据库层使用乐观锁，使用

version

说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次 数不得小于3 次。

9. 【强制】多线程并行处理定时任务时，

Timer

TimeTask

ScheduledExecutorService

10. 【推荐】使用

CountDownLatch

countDown

方法，线程执行代码注意

catch

countDown

await

说明：注意，子线程抛出异常堆栈，不能在主线程

try

catch

11. 【推荐】避免

Random

seed

说明：

Random

java

util

Random

Math

random()

正例：在

JDK

API ThreadLocalRandom

JDK

12. 【推荐】在并发场景下，通过双重检查锁

（double

checked locking）

(

The

Double

Checked Locking is Broken

Declaration)

（

JDK

^）

volatile

。

反例：

class Singleton {

private Helper helper = null;

public Helper getHelper() {

if (helper == null) synchronized(this) { if (helper == null)

helper = new Helper();

}

return helper;

}

// other methods and fields...

}

13. 【参考】

volatile

但是如果多写，同样无法解决线程安全问题。如果是

count

AtomicInteger count

new AtomicInteger(); count

addAndGet(

);

JDK

LongAdder

AtomicLong

（

）

14. 【参考】

HashMap

resize

CPU

15. 【参考】

ThreadLocal

ThreadLocal

static

修饰。这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享 此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象

(

)

(七) 控制语句

1. 【强制】在一个

switch

case

break

return

case

；

switch

default

2. 【强制】在

if

else

for

while

do

3. 【推荐】表达异常的分支时，少用

if-else 方式

if (condition) { ...

return obj;

}

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

说明：如果非得使用

if()...else if()...else...

正例：超过3 层的

if-else

其中卫语句示例如下：

public void today() { if (isBusy()) {

System.out.println(“change time.”);

return;

}

if (isFree()) {

System.out.println(“go to travel.”);

return;

}

System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);

return;

}

4. 【推荐】除常用方法（如

getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复

说明：很多

if

正例：

// 伪代码如下

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

if (existed) { ...

}

反例：

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

}

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

获取数据库连接，进行不必要的

try

catch

（

try

catch

）

7. 【参考】下列情形，需要进行参数校验：

1

^）

2

）

3

^）

4

^）

RPC

API

HTTP

5） 敏感权限入口。

8. 【参考】下列情形，不需要进行参数校验：

1

^）

2

^）

DAO

Service

DAO

3

^）

private

(八) 注释规约

1. 【强制】类、类属性、类方法的注释必须使用

Javadoc

xxx

说明：在

IDE

Javadoc

Javadoc

；

IDE

2. 【强制】所有的抽象方法

^（

）

Javadoc

异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：对子类的实现要求，或者调用注意事项，请一并说明。

3. 【强制】所有的类都必须添加创建者和创建日期。

4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释 使用/* */注释，注意与代码对齐。

5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

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

反例：“

TCP

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

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

就失去了导航的意义。

8. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。

说明：代码被注释掉有两种可能性：1

^）

^）

（

）

9. 【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑

^；

；

10. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的 一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

反例：

// put elephant into fridge put(elephant, fridge);

方法名

put

elephant

fridge

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

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

1

^）

（TODO）

^（

[

]）

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

Javadoc

Javadoc

还没有实现，但已经被广泛使用。只能应用于类，接口和方法

（

Javadoc

）

^）

（FIXME）

^（

[

]）

在注释中用

FIXME

(九) 其它

1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

说明：不要在方法体内定义：

Pattern pattern

Pattern

compile(

);

2. 【强制】

velocity

POJO

POJO

getXxx()

boolean

（boolean

is

前缀

）

isXxx()

说明：注意如果是

Boolean

getXxx()

3. 【强制】后台输送给页面的变量必须加

$!{var}

说明：如果

var

null

${var}

4. 【强制】注意

Math

random()

double

x

（

）

x

Random

或者

5. 【强制】获取当前毫秒数

System

currentTimeMillis();

new Date()

getTime();

说明：如果想获取更加精确的纳秒级时间值，使用

System

nanoTime()的方式

JDK

针对统计时间等场景，推荐使用

Instant

6. 【推荐】不要在视图模板中加入任何复杂的逻辑。

说明：根据

MVC

7. 【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。

8. 【推荐】及时清理不再使用的代码段或配置信息。

说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。

正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三 个斜杠(///)来说明注释掉代码的理由。