阿里Java开发手册-泰山版之学习笔记

前言

本手册以 Java 开发者为中心视角，划分为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度，再根据内容特征，细分成若干二级子目录。
在 2017 杭州云栖大会上发布了配套的Java 开发规约 IDE 插件，下载量达到 152 万人 次，阿里云效也集成了代码规约扫描引擎。本书秉持“图胜于表，表胜于言”的理念，深入浅出地将计算机基础、面向对象思想、JVM 探源、数据结构与集合、并发与多线程、单元测试等知识客观、立体地呈现出来。紧扣学以致用、学以精进的目标，结合阿里巴巴实践经验和故障案例，与底层源码解析融会贯通，娓娓道来。《码出高效》和《Java开发手册》书籍版所得收入均捐赠公益事情，希望用技术情怀帮助更多的人。
感谢阿里巴巴，下载地址如下：阿里Java开发手册-2020版

一、编程规约

1·命名风格

1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
2. 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
3. 【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。
5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
6. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
7. 【强制】类型与中括号紧挨相连来表示数组。
8. 【强制】POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
10. 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。
11. 【强制】杜绝完全不规范的缩写，避免望文不知义。
12. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。
13. 【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
14. 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
15. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。
16. 接口和实现类的命名有两套规则：
    1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl 的后缀与接口区别。
    2）【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。
17. 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
18. 【参考】各层命名规约：
    A) Service/DAO 层方法命名规约
    1） 获取单个对象的方法用 get 做前缀。
    2） 获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects。
    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。

2·常量定义

3·代码格式

4·OOP规约

5·日期时间

6·集合处理

7·并发处理

8·控制语句

9·注释规约

10·其他

二、异常日志

1·错误码

2·异常处理

3·日志规约

三、单元测试

四、安全规约

五、MySQL数据库

1·建表规约

2·索引规约

3·SQL语句

4·ORM映射

六、工程结构

1·应用分层

2·二方库依赖

3·服务器

七、设计规约