- 首页 > it技术 > >
阿里Java开发手册学习笔记（一）----编程规约
【阿里Java开发手册学习笔记（一）----编程规约】学习阿里Java开发手册笔记系列，参考版本1.0.0
在线阅读：https://img.hacpai.com/file/2017/1/eb0998bac7664496b2f1af98e07b08e5-Java.pdf
最新版本下载：http://click.aliyun.com/m/10355/
一、命名规范
- 不以下划线（_）或美元符号（$）开始/结尾。
- 不允许中英文混合使用，不允许直接使用中文。
- 类名使用UpperCamelCase风格；方法名、参数名、成员变量使用lowerCamelCase风格，都要遵从驼峰式命名。常量名全大写，用下划线（_）分隔。
- 抽象类以Abstract/Base开头，异常类以Exception结尾，测试类以被测试类名字+Test方式命名。
- POJO类中布尔类型变量不加is，避免部分框架解析时发生错误。
- 包名统一小写，统一使用单数形式。
- 不要瞎jb缩写。
- 将设计模式体现在命名中。
- 接口类方法、属性不加任何修饰符号，包括public。
- Service与DAO暴露出的一定是接口，对应实现加Impl后缀。
e.g. CacheService对应实现为CacheServiceImpl
形容能力的接口，取对应形容词作为接口的名称。
e.g. AbstractTranslator实现Translatable
- Service、DAO方法命名规范：
- 单个对象获取用get，多个用list前缀
- 统计用count前缀
- 插入用save(推荐)、insert前缀
- 删除用remove(推荐)、delete前缀
- 修改用update前缀
- 领域模型命名
- 数据对象 XXXDO
- 数据传输对象 XXXDTO
- 展示对象 XXXDVO
二、常量规范
- 不允许出现魔法值，比如
String str="id="+id;
- long/Long型变量用L（不使用l）标明。
- 按常量功能进行分类，分开维护。
- 常量复用的五个层次：
- 跨应用的共享常量，放于第二方库中
- 应用内共享常量，放于第一方库modules的const目录下
- 子工程内部共享变量，放于子工程const目录下
- 包内共享常量，在当前包内单独const目录下
- 类内共享，直接在类内部定义。
- 变量在一个范围内变化用Enum。
三、OOP规约
- 使用类名访问此类的静态变量或者静态方法。
- 所有复写方法必须加@Override注解。
- 对过时的接口方法加@Deprecated注解，并说明新接口新服务是什么。
- 不能使用过时的方法或者类。
- 使用常量或确定有值的对象来调用equals方法。
- 所有相同类型的包装类之间值的比较全使用equals方法。
- 所有POJO类属性都使用包装数据类型。RPC方法的返回值与参数也使用包装数据类型。局部变量使用基本数据类型。
- 定义DO/DTO/DVO等POJO类时，不要设定任何属性的默认值。
- 序列化类新增属性的时候不要修改serialVersionUID、避免反序列失败。如果完全不兼容升级，避免反序列化混乱，需要修改serialVersionUID。
- 构造方法里禁止加入任何业务逻辑，如有初始化逻辑，放置在init方法中。
- POJO类必须重写toString方法。如果继承了另一个POJO类，在前面加super.toString()。
- 构造方法按顺序放在一起。
- 类内方法顺序：
public->protect->private->setter/getter。
- 循环体内，使用StringBulider的append方法对字符串进行扩展。
四、集合处理
- Map/Set的key为自定义对象时，必须重写hashCode和equals。
- ArrayList的subList结果可强转为ArrayList。并且，对subList的操作都会反映到源列表上。对原集合的个数的修改会导致subList的操作产生异常。
- 使用集合转数组时使用集合类的
toArray(T[]array),传入类型大小一样的数组。
- 使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法。
- 泛型通配符来接受返回的数据，此写法的泛型集合不能使用add方法。
- 不要在foreach循环里进行元素的remove/add操作。
- 集合初始化时尽量指定集合初始值的大小。
- 使用entrySet遍历Map类集合而不是keySet方式进行遍历。
- 注意Map类集合K/V能否存储null情况。
- 利用Set元素唯一的特性对另一集合去重，避免手动遍历。
五、并发处理
- 获取单例对象要线程安全。在单例对象中操作也要保证线程安全。
- 线程资源必须通过线程池提供，不允许在应用中自行显示创建线程。
- 高并发时，同步调用应该尽量减小锁的性能损耗.
- 对多个资源同时加锁时，需要保证一致的加锁顺序，否则会造成死锁。
- 并发修改同一记录时，避免更新丢失，要么在应用层加锁要么在缓存加锁，要么在数据库使用乐观锁，并使用version作为更新依据。
- 多线程并行处理定时任务时，Timer运行多个TimerTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止，使用ScheduledExecutorService来避免这个问题。
- 线程池不允许使用Executors创建，而是使用ThreadPoolExecutor。（了解使用Executors的诸多弊端）
- 创建线程or线程池时需指定有意义的线程名称。
- 使用CountDownLatch进行异步转同步操作时，每个线程退出前必须调用countDown()方法，线程执行代码注意catch异常，以确保countDown方法可以执行，避免主线程无法执行countDown方法直到超时才返回结果。
- 避免Random实例被多线程使用，会因竞争同一seed导致性能下降。
六、控制语句
- switch块中每个case要么通过break/return终止，要么注释说明将要执行到哪一个case为止。必须添加default在结尾。
if/else/for/while/do 必须使用大括号。- 尽量少使用else if-else if-else表达逻辑不应超过3层，超过应使用状态设计模式。
- 判断语句尽量精简。
- 定义对象、变量、获取数据库连接、try-catch操作，尽量移动到循环体外。
七、注释规约
- 类、类属性、类方法必须使用javadoc注释。
- 所有抽象方法必须使用javadoc注释。说明返回值、参数、异常、功能。
- 所有类需加创建者信息。
- 所有枚举字段必须注释，说明用途。
- 代码修改时同步修改注释。
- 注释掉的代码配合说明，是以后恢复还是永久弃用。
八、其它
- 使用正则表达式时利用好预编译功能，可加快正则匹配速度。
- 后台输送给页面的变量需加! —
$!{var}
- 获取当前时间毫秒使用
System.currentTimeMillis()。
推荐阅读
