阿里巴巴Java开发手册学习笔记

阿里巴巴Java开发手册学习笔记

一，编程规约

1，命名不能以_和$开头
2，命名英文，见名知意
3，常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长
正例： MAX_STOCK_COUNT
反例： MAX_COUNT
4，类名使用 UpperCamelCase 风格
5，方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式
6，抽象类命名使用 Abstract 或 Base 开头； 异常类命名使用 Exception 结尾； 测试类命名以它要测试的类的名称开始，以 test 结尾
7，类型与中括号紧挨相连来表示数组。
正例： 定义整形数组 int[] arrayDemo;
反例： 在 main 参数中，使用 String args[]来定义。
8，POJO 类中布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误
9，包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例： 应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils
10，杜绝完全不规范的缩写， 避免望文不知义
反例：AbstractClass“缩写” 命名成 AbsClass； condition“缩写” 命名成 condi，此类随意缩写严重降低了代码的可阅读性