阿里巴巴JAVA编程规范

编程规约

命名风格

• 不能以下划线、美元符号开始或结束
• 不能以中文、拼音命名
• 类名各单词首字母大写MyFriendILoveYou
• 方法名、参数名、成员变量、局部变量除首单词其余单词首字母大写myFriendILoveYou
• 常量命名全部大写，单词间用下划线隔开MY_FRIEND_I_LOVE_YOU
• 抽象类命名以 Abstract、Base 开头
  异常类命名用 Exception 结尾
  测试类命名以它要测试的类的名称开始，以 Test 结尾
• String[] args
  String args[ ]
• 包名小写，点分隔符之间只有一个单词my.friend.i.love.you
• 枚举类名带 Enum 后缀，枚举成员名称大写，单词间下划线隔开

常量定义

• 未经定义的常量禁止出现
• long 型常量用大写L，避免与1混淆long a = 2L

代码格式

• 大括号
  • 左大括号前、右大括号后加空格
  • 空大括号不换行
  • 非空大括号左括号前不换行，右括号左右换行，遇 else 不换行

	public void a {}
	public void b {
		xxx;
	} else;

• 左右小括号与括号内字符之间不出现空格
• if、for、while、switch、do 与括号之间加空格
• 二目、三目运算符左右加空格

if (a == b) {
	xxx;
} else;

• 方法中参数逗号之后加空格void a(x, y, z);
• 不同语句组之间空行

OOP 规约

集合处理

并发处理

控制语句

注释规范

其它

异常日志

异常处理

日志规约

MySQL 数据库

建表规约

索引规约

SQL 语句

ORM 映射

工程结构

安全规约