《阿里巴巴Java规范》读后感和笔记

读《阿里Java规范》确实受益良多，很多细微的地方考虑的很完善，里面指出的有的陋习我也有，而我从阅读别人代码的时候也感受到了统一规范的代码格式有多重要，这还倒是其次，而是不良的代码规范在以后的运行会产生很大的问题，尤其是访问量上来的时候。里面说的“可能错就一定会错”我怕每一个程序员都会深有感慨，我想有时还会经常翻翻，直到我能在某些地方找出比它更好的规范和方式，哈哈。
放一下随手记录的笔记：
一.命名规约
1.常量命名全部大写
2.POJO类中布尔类型的变量，都不要加is，会引起rpc框架反向解析的异常
3.包名统一用单数形式
4.缩写规范，避免望文不知义
5.如果使用到设计模式，要在类名中体现出来
6.接口的方法和属性不要加任何符号，保持代码的简洁性，并加入javadoc注释，尽量不要在接口定义变量
7.基于soa的理论，暴露出来的服务一定是接口，内部的实现类用Impl的后缀和接口区别（如果是形容能力的接口名称，取其对应的形容词做接口名）
8.枚举类名建议带上Enum后缀，枚举成员名称需要全部大写，单词间用下划线隔开，枚举其实就是特殊的常量类
9.获取单个对象的方法用get做前缀、获取多个对象的方法用list做前缀
二常量定义
1.不允许出现任何魔法值（即未经定义的常量）直接出现在代码中
2.必须使用Long赋值，用long容易跟数字1混淆
3.不推荐使用一个常量类维护所有常量，应该按常量功能进行分类，分开维护。例如缓存相关的常量放在CacheConsts下；配置相关的常量放在ConfigConsts下
4.如果变量值仅在一个范围类变化用Enum。如果还带有名称之外的延伸属性，必须使用Enum类
三格式规约
1.左右括号和字符之间不出现空格
2.if/for/while/switch/do等保留字与左右括号之间都必须加空格
3.任何运算符左右都必须加一个空格
4.缩进采用4个空格，禁止使用tab字符。如果使用tab缩进，必须设置1个tab为4个空格
5.单行字符数限制不超过120个，超出需换行：第二行相对第一行缩进4个空格，第三行开始不再继续缩进；运算符与下文一起换行；方法调用的点符号与下文一起换行；在多个参数超长，逗号后进行换行；在括号前不要进行换行
6.方法参数在定义和传入时，多个参数逗号后边必须加空格
四oop规约
1.避免通过对象引用访问静态变量和方法，这会无谓增加编译器解析成本
2.所有覆写方法，必须加@Override注解
3.尽量不用可变参数编程，避免使用object
4.Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象调用equals
5.所有相同类型的包装类对象之间值得比较全部使用equals
6.所有的pojo类属性必须使用包装数据类型；rpc方法的方法值和参数必须使用包装数据类型，所有局部变量推荐使用基本数据类型
7.构造方法中禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中
8.pojo类必须写toString方法。这样在方法执行抛出异常时可以直接调用pojo类的tostring方法打印其属性值，便于排查问题
9.在get/set方法中尽量不要增加业务逻辑，这样会增加排查问题的难度
10.循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展
11.声明成final的情况：不需要重新赋值的变量，包括类属性、局部变量；对象参数前加final，表示不允许修改引用的指向；类方法确定不允许被重写
12.object的clone方法拷贝对象默认是浅克隆，虽然新分配内存克隆了一个新对象，但对象里的属性值没有克隆，引用还是指向原对象的属性值的地址
13.任何类、方法、参数变量，严控访问范围。过宽的访问的范围，不利于模块解耦。如果是一个private方法想删除就删除，但是如果是一个public我们不知道他在哪里被调用了，就不敢随便修改和删除
五集合处理
1.只要重写equals，就必须重写hashcode
2.如果自定义对象作为map的键，那么就必须重写hashcode和equals
3.ArrayList的sublist结果不可强转成ArrayList，subList返回的是ArrayList的内部类，并不是ArrayList
4.使用集合转数组的方法，必须使用集合的toArray(T[] array),直接使用toArray无参方法存在问题，此方法返回值只能是object[]类，强转其他类型数组将出现classcastexecption的错误
5.同样Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法
6.不要在foreach循环里进行元素的remove/add操作，remove请使用Iterator方式
7.集合初始化的时候，尽量指定初始值大小
8.使用entrySet遍历Map类集合，keySet是遍历了两次
六并发处理
1.线程池资源必须通过线程池提供，不允许在应用中自行显示创建线程，并且要通过ThreadPoolExecutor的方式创建
2.高并发时，要考量锁的性能损耗，能用无锁数据结构，就不要用锁；能锁区块，就不要锁锁整个方法体，能锁对象，就不要用类锁。
3.多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其他任务便会自动终止，使用ScheduledExecutorService则没有这个问题
4.HashMap在容量不够时进行resize时由于高并发可能出现死链，导致cpu飙升
七.控制语句
1.在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码都没有
2.if…else…请勿超过3层，超过请使用状态设计模式
3.在条件判断中不要执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名
4.定义对象、变量、获取数据库连接以及try-catch操作尽量放在循环体外
5.批量操作的接口要有入参保护
6.方法中进行参数校验的场景：调用频次低的方法；开销大的方法（因为参数错误导致中间执行回退或者错误得不偿失）;需要极高稳定性和可用性的方法；对外提供的开放接口；敏感权限接口
7.类、类属性、类方法的注释必须使用Javadoc规范
8.所有的抽象方法必须要使用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能，所有的类都必须添加创建者信息
9.所有枚举类型字段必须有注释，说明每个数据项的用途，注释掉的代码要配合说明
二.异常处理
1.不要捕获Java类库中定义的继承RuntimeException的运行时异常类，如IndexOutOfBoundsException/NullPointerException,这类程序有程序员预检查来规避，以此来保证程序的健壮性
2.异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低
3.稳定代码不要try-catch，对于非稳定代码尽可能区分异常类型，再做对应的异常处理
4.try块放到了事物代码中，catch异常后，如果需要回滚事务，一定注意手动回滚事务
5.finally块必须对资源对象、流对象进行关闭，jdk7中可以用try-with-resources方式
6.集合元素即使isNotEmpty，取出的元素也可能为null；远程调用对象，一律要求进行null判断
7.rpc调用优先考虑result方式，封装isSuccess、错误码、错误简短信息
三.日志规约
1.应用中不可直接使用日志系统（log4j、logback）中的api，而应该使用日志框架slf4j中的api，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一
2.日志文件至少保存15天
3.对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的形式
4.避免重复打印日志，务必在log4j.xml设置additivity=false
5.生产环境禁止输出debug日志；有选择地输出info日志；记录日志的时候思考：这些日志真的有人看吗？看懂啊这条日志你能做什么？能不能给问题排查带来好处？
四.数据库建表规约
1.表达是否概念的字段必须使用is_xxx方式命名
2.唯一索引名为uk_字段名；普通索引名则为idx——字段名
3.如果存储的字符串长度几乎相等，使用char定长字符串类型
4.varchar是可变长字符串，不预先分配存储空间，长度不要超过5000
5.表必备三字段，自增id，创建时间，修改时间
6.库名与应用名尽量一致，表的命名最好是“业务名称_表的作用”
7.字段允许适当冗余以提高性能，但冗余字段不能是频繁修改的字段，更不能是varchar字段
8.合适的存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度
（二） 36 711
前言：因为索引对字段数据进行了重排序，所以插入数据的时候会增加排序的开销变慢，普通索引能加快查询的速度，唯一索引保证值是唯一的，值有一个可为null，主键索引是特殊的唯一索引，但不允许null值；可将多个列做成组合索引，但前导列一定是最频繁的列，索引字段覆盖查询条件会形成“索引覆盖”，不会进行回表操作，查询会达到最忧效果
1.业务具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。
2.超过三个表禁止join，需要join的字段数据类型保持绝对一致，连接字段需要索引
3.在varchar字段建立索引，必须指定索引长度，没必要对全字段建立索引
4.页面搜索严禁左模糊或者全模糊（索引文件具有B-tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用次索引）
5.索引中有范围查找，那么索引顺序无法利用，利用覆盖索引来进行查询操作，来避免回表操作，也就是说我查的内容都是索引字段，那么就不会再去查其它非索引字段的数据，查询速度会最快
6.建组合索引的时候，区分度最高的在最左边，=的判断条件优先度大于其它符号，并大于区分度条件
(三) sql规约
1.不要使用count（列名）来代替count（），count（）会统计null值
2.sum（col）列的时候会返回null，所以使用它的时候注意npe
3.必须使用isnull判断是否为null值，null值与任何值的直接比较都为null
4.在代码中写分页查询逻辑时，若count为0应该直接返回，避免执行后面的分页语句
5.不得使用外键与级联，一切外键概念必须都在应用层解决
6.禁止使用存储过程，存储过程难以调试和扩展，更没有移植性
7.删除和修改记录时，要先select，避免误删除
8.in操作能避免就避免，trunct比delete速度更快，但trunct无事务且不触发trigger
（四orm规约）
1.在表查询中，一律不要使用*作为查询的字段列表，需要哪些字段必须明确写明
2.不允许直接拿HashMap与HashTable作为查询结果集的输出
3.更新数据表记录，必须更新记录对应的更新时间，尽量不更新无改动的字段
4.@Transactional事务不要滥用，事务会影响数据库的qps