阿里《Java开发手册》学习
就是将阿里的java开发手册抄了一遍,加强记忆
一, 编程规约:
-
命名风格:
(1)不能以下划线和美元符号$开始,也不能以此结束
(2)严禁使用拼音和英文混合, 更不允许使用中文,纯拼音命名要避免使用
(3)类名使用UpperCamelCase风格,首字母大写其余小写,但DO/BO/DTO/VO/PO例外
(4)方法名,参数名,成员变量,局部变量都统一使用lowerCamelCase风格,首字母小写
(5)常量名全部大写,单词用下划线隔开,不要嫌名字长
(6)抽象类命名使用Abstract或Base开头,异常类命名使用Exception结尾.测试类使用测试类的名称开始,以Test结尾
(7) 类型与中括号紧挨来表示数组 例如int[] array
(8) POJO类中布尔类型变量都不能加is前缀,否则部分框架会引起序列化错误
(9)包名统一使用小写,点分割符直接有且仅有一个自然语义的英语单词, 包名统一使用单数形式.类名可以使用复数形式
(10)子类中不允许与父类成员变量重名,同一方法内不同代码块的局部变量也不允许重名
(11)避免不规范缩写,避免歧义
(12)任何自定义编程元素在命名时,尽量使用完整的单词表达其意
(13)常量或者变量命名是表示类型的单词放在词尾, 如: startTime nameList
(14)如果模块,接口,类方法使用的某种设计模式, 例如pbulic class OrderFactory;
(15)接口类中的方法和属性不要添加任何修饰符,public也不要添加,尽量不要在接口中定义变量
(16)接口实现类使用Impl与接口区别
(17)枚举类名称带Enum后缀,枚举类成员名称需要全部大写,单词用下划线隔开
(18)命名规约:
Service/DAO层命名规约
[1]获取单个对象的方法用get做前缀
[2]获取多个方法用list做前缀,复数结尾
[3]获取统计值使用count做前缀
[4]插入用save/insert做前缀
[5]删除用remove/delete做前缀
[6]修改用update做前缀
领域模型命名规约
[1]数据对象:xxxDO, xxx数据表名
[2]数据传输对象:xxxDTO, xxx为领域相关的名称
[3]展示对象: xxxVO xxx一般为网页名
[4]POJO是DO/DTO/BO/VO的统称,禁止xxxPOJO -
常量定义:
(1)不允许使用未经预先定义的常量出现在代码中
(2)在使用long或者Long时,数值后面使用大写的L,禁止使用小写l,
(3)不要使用一个常量类维护所有常量,要按照常量功能进行归类,分开维护
(4)常量复用层次有5层: 跨应用共享常量 应用内共享常量 子工程内共享常量, 包内共享常量, 类内共享常量
[1]跨应用共享常量:放置在第二方库中,通常时client.jar中的constant目录下
[2]应用内共享常量: 放置在第一方库中,通常在子模块中的constant目录下
[3]子工程内部共享常量: 当前子工程的constant目录下
[4]包内共享常量:当前包下单独的constant目录下
[5]类内共享常量:直接在类中private static final定义
(5)如果变量值仅在一个固定范围内变化,用enum来定义 -
代码格式:
(1)如果大括号为空,则写成{}即可,大括号中间无需换行和空格;如果是非空代码块则
左大括号前不换行 左大括号后换行
右大括号前换行 右大括号后还有else 等代码则不按行,表示终止的右大括号后必须换行
(2)小括号与字符串之间不出现空格, 而右大括号前需要空格
(3)if/for/while/switch/do 等保留关键字与括号之间必须加空格
(4)任何二目运算三目运算的左右两边都需要加一个空格 运算符号包括 = && 加减乘除
(5)采用4个空格缩进,禁止使用table字符
(6)注释的双斜线与注释内容之间有且仅有一个空格
(7)强制类型转换时,右括号与强制转换值之间不需要任何空格隔开
(8)单行字符数限制不超过120个,超出需换行,换行规则如下
[1]第二行相对第一行缩进4个空格,第三行开始不再继续缩进
[2]运算符与下文一起换行
[3]方法调用的点与下文一起换行
[4]方法调用多个参数需要换行时,在逗号后进行
[5]在括号前不要换行
(9)方法参数在定义和传入时,多个参数逗号后边必须加空格
(10)IDE的text file encoding设置为UTF-8,IDE中文件换行使用Unix格式.不要使用Windows
(11)单个方法总行数不要哦超过80行
(12)不需要增加空格使等号对齐
(13)不同逻辑不同语义不同业务代码之间插入一行空行分割,不需要插入多个空行 -
OOP规约
(1)直接使用类名访问类的静态变量和静态方法,不需要使用类的对象引用
(2)方法重写 必须加@Override注解
(3)相同参数,相同业务含义,才可以使用可变参数,避免使用Object.(尽量不要使用可变参数编程)
(4)外部正在调用或者二方库依赖接口时,不允许修改方法签名. 接口过时时必须添加@Deprecated注解 并且清晰说明采用的新的接口或者服务是什么.
(5)不能使用过时的类或者方法
(6)equals方法容易抛空指针异常,应使用常量或者确定有值的对象来调用equals
(7)所有整形包装类对象之间的比较, 全部使用equals方法比较
(8)浮点数不能使用 ==来比较 它的包装类型不能使用equals判断
[1]浮点数插值在一定范围内,则认为事项等的 Math.abs(a - b)<1e-6f
[2]使用BigDecimal定义值后,在进行浮点数运算操作
(9)定义数据对象DO类时,属性类型要与数据库字段类型相匹配
例:数据库字段的bigint必须与类属性的Long类型对应
(10)防止精度丢失,禁止使用构造方法BigDecimal(double)的方式把double转为BigDecimal对象
优先推荐入参为String的构造方法,或者使用BigDecimal的valueOf方法
(11)基本类型与包装数据类型的使用标准
[1]所有POJO类属性必须使用包装类数据类型(返回值可能为null)
[2]RPC方法的返回值和参数必须使用包装数据类型
[3]所有的局部变量使用基本数据类型
(12)定义DO/DTO/VO等POJO时,不要设定任何属性的默认值
(13)序列化新增属性时,请不要修改serialVersionUID字段,避免反序列化失败. serialVersionUID不一致会抛出序列化运行时异常
(14)构造方法中禁止添加任何业务逻辑,如果有初始化逻辑,请放在init方法中
(15)POJO类必须写toString方法。 在抛出异常时可以直接调用toString方法打印其属性
(16)禁止在POJO类中同时存在对应其属性的isXxx()和getXxx()方法;
(17)使用索引访问String的split方法得到的数组时,需做最后一个分割符后有无内容检查,否则有报IndexOutOfBoundsException的风险。
(18) 当一个类有多个构造方法,或者多个同名方法,这些应按顺序放在一起
(19)类内方法定义的顺序依次是 公有方法或保护方法 > 私有方法 > get/set 方法
(20) get/set方法中参数名称与类成员变量名称一致,get/set方法中不要增加业务逻辑
(21)循环体中字符串连接方式使用StringBuilder的append方法进行扩展
(22)final可以修饰类,成员变量,方法以及本地变量
[1]不允许被继承的类
[2]不允许修改引用的域对象
[3]不允许被重写的方法
[4]不允许重新复制的局部变量
[5]避免上下文重复使用一个变量,使用final可以强制重新定义一个变量方便更好的重构
(23)慎用Object的clone方法拷贝对象,(默认为浅拷贝)
(24)类成员与方法访问控制从严 严控访问范围
[1]若不允许外部直接通过new创建对象,那么构造方法必须是private
[2]工具类中不允许有public或则default构造方法
[3]类非static成员变量且与子类共享时,必须时protected
[4]仅在本类中使用的成员变量,必须时private
[5]仅在本类中使用的方法必须是private
[6]类的成员变量支队继承类公开,那么限制为protected -
集合处理
(1)关于hashCode和equals的处理
[1]只要重写equals 就必须重写hashCode
[2]set存储的不重复对象,是根据hashCode和equals进行判断,所以set存储的对象必须重写这俩方法
[3]自定义对象作为Map的键 那么必须重写HashCode和equals
(2)ArrayList的subList结果不可强制转为ArrayList,否则会抛出ClassCastException异常
(3)使用Map的方法 keySet()/values()/ entrySet()返回集合对象时不能对其进行添加元素,否则会抛出UnsupportedOperationException异常。
(4)Collections类返回的对象,不能对其进行添加和删除操作
(5)在subList场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生ConcurrentModificationException 异常。
(6)使用集合转数组的方法,必须使用集合的toArray(T[] array)传入类型完全一致,长度为0的空数组
(7)在使用Collection接口实现任何类的addAll()方法时,都要对输入的接参数进行NPE判断
(8)使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常
(9) 泛型通配符 来接收返回的数据,这样不能使用add()方法,而不能使用get方法，作为接口调用赋值时易出错
(10) 在无泛型限制定义的集合赋值给泛型限制的集合是,需要进行instanceof判断,避免出现ClassCastException异常
(11) 不要再foreach循环中进行元素remove/add操作.remove操作使用Iterator方式,并发需要对Iterator进行加锁
(14)初始化集合时,指定集合大小
(15) 使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历。 -
并发处理
(1)获取单例对象需要保证线程安全,其中的方法也要保证线程安全
(2)创建线程或者线程池,指定有意义的线程名称
(3)线程资源必须通过线程池提供,不允许在营中显示创建线程
(4)线程池不允许使用Executorys去创建,而是通过ThreadPoolExecutor方式
(5)SimpleDateFormat是线程不安全的类,一般不要定义为static变量,否则要加锁
(6)必须回收自定义的ThreadLocal变量,尤其是线程池场景下 否则有内存泄漏的可能
(7)高并发时同步调用应考虑锁的性能损耗,尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用RPC方法。
(8) 对多个资源数据库,对象同时加锁时,要保持一致的加锁顺序.
(9)必须在try代码块之外加锁,且在加锁方法和try之间没有任何可能抛出异常的方法调用,避免在finally中无法解锁
(10)使用尝试方式获取锁的方式中,进入业务代码前必须判断当前线程是否加锁.所得释放规则与锁的阻塞规则是一致的
(11)并发修改同一记录时,避免更新丢失,需要加锁,要么应用层加锁,要么缓存加锁,要么在数据库层使用乐观锁
(12)多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，如果在处理定时任务时使用ScheduledExecutorService则没有这个问题。
(13)资金相关的敏感信息,使用悲观锁策略
(14)使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法被执行到，避免主线程无法执行至await方法，直到超时才返回结果。
(15)避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。
(18) HashMap在容量不够进行resize时由于高并发可能出现死链，导致CPU飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。 -
控制语句
(1)switch中,每个case都要通过continue/break/return等来终止,且必须包含default
注意break是退出switch语句块，而return是退出方法体。
(2)当switch括号内的变量类型为string时,要先进行null判断
(3)在if/else/for/while/do语句中必须使用大括号。即使只有一行代码
(4) 在高并发中禁止使用等于作为判断条件,应使用大于或者小于的区间进行判断
(5)表达异常分支时,少用if…else… 请勿超过三层
(6) 除常用方法（如getXxx/isXxx等）外,不要再条件判断中执行其他复杂语句,将复杂的逻辑判断结果赋值给一个有意义的布尔变量名提高可读性
(7) 不要在其他表达式中插入赋值语句
(8)循环体中的语句要考量性能, 如定义对象、变量、获取数据库连接，进行不必要的try-catch操作等
(9) 避免采用取反逻辑运算
(11) 以下场景要进行参数校验
[1]调用频次低
[2]执行时间开销大,校验时间可忽略不计
[3]需要极高可用性和稳定性方法
[4]对外开放的接口
[5]敏感权限入口
(12)不需要入参校验的方法
[1]极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
[2]底层调用频率比较高方法,在最后一层暴露问题的可能性不是很大的
[3]被声明成private只会被自己代码所调用的方法 -
注释规约
(1)类、类属性、类方法的注释必须使用Javadoc规范，使用/** 内容 **/格式，不得使用//xxxx方式
(2)所有的抽象方法（包括接口中的方法/）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
(3)所有的类都必须添加创建者和创建日期
(4)方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
(5)所有的枚举类型字段必须要有注释，说明每个数据项的用途。
(6)与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
(7) 代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
(8)无用的代码请删除，不要注释。
(9)第一、能够准确反映设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。
(10) 好的命名、代码结构是自解释的，注释力求精简准确、表达到位
(11)特殊注释标记，请注明标记人与标记时间。 -
其他
(5)获取当前毫秒数System.currentTimeMillis();
(9)及时清理不再使用的代码段或配置信息。
二,异常日志
-
异常处理
(1)java类库中可以通过预检查方式规避RuntimeException异常不要使用try…catch 方式处理
如:NullPointerException，IndexOutOfBoundsException等
(2)异常不要用来做流程控制,或条件控制,异常处理的效率比条件判断方式要低很多
(3)catch时请分清异常代码和稳定代码,对大段代码进行try…catch…无法根据不同的问题做出正确的反应,也不利于定位问题
(4)捕获的异常必须处理,如果不想处理应把他抛给它的调用者,
(5)有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。
(6)finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。
(7)不要在finally块中使用return。
(8)捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
(9)在调用RPC、二方包、或动态生成类的相关方法时，捕捉异常必须使用Throwable类来进行拦截。
(10)方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。
(11)防止NPE是程序员的基本修养
[1]返回基本类型,return包装数据类型的对象时,自动拆箱可能产生NPE
例如:：public int f() { return Integer对象}如果为null，自动解箱抛NPE。
[2]数据库的查询结果可能为null
[3]集合里的元素即使isNotEmpty，取出的数据元素也可能为null
[4]远程调用返回对象时,一律要求进行空指针判断,防止NPE
[5]对于session中获取数据,建议使用NPE检查,防止空指针
[6]级联调用容易产生NPE
(12)定义时区分unchecked / checked 异常，避免直接抛出new RuntimeException()，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。
(13)对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess()方法、“错误码”、“错误简短信息”。
(14) 避免出现重复代码,必要时提供公共方法或者抽象公共类,甚至组件化. -
日志规约
(1)应用中不能直接使用日志系统(Log4j,Logback)中的API,而应依赖使用日志框架中的SLF4J中的API,使用门面模式的日志框架,有利于维护和各个类的日志统一处理
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);
(2)日志中所有的文件至少保存15天, 因为有些异常具备以周为频次发生的特点,import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);
(3)应用中使用扩展日志命名方式,有利于归类查找
(4)在日志输出时,字符串变量之间的拼接使用占位符的方式,拼接有一定的性能损耗,使用占位符只是替换,可以提高性能
例如: logger.debug(“Processing trade with id: {} and symbol: {}”, id, symbol);
(5)对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断
(6)避免重复打印日志,浪费磁盘空间,务必在log4j.xml中设置additivity=false
(7)异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。
(8)生产环境禁止输出debug日志, 选择输出info日志,
(10)尽量使用英文描述日志错误信息,如果描述不清,可以使用中文
三,单元测试
(1)好的单元测试,必须遵循AIR原则. A：Automatic（自动化） I：Independent（独立性） R：Repeatable（可重复）
(2)单元测试应该时全自动执行的,单元测试中禁止使用System.out来进行人肉验证，必须使用assert来验证。
(3)保持单元测试的独立性,为了保证单元测试的稳定性可靠性,单元测试之间禁止相互调用
(4)单元测试可以重复执行,不能受到外部环境的影响
(5)单元测试的粒度要足够小,有助于精度定位问题
(6)核心业务、核心应用、核心模块的增量代码确保单元测试通过。
(7)单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下。
源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。
(8) 单元测试的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支覆盖率都要达到100%
(9)编写单元测试代码遵守BCDE原则，以保证被测试模块的交付质量。
[.]B:边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。
[.]C：Correct，正确的输入，并得到预期的结果。
[.]D：Design，与设计文档相结合，来编写单元测试。
[.]E：Error，强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。
(10)对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。
(11)和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。
(13)在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例。
(14)在项目提测前完成单元测试，不建议项目发布后补充单元测试用例。
四,安全规约
(1)隶属于用户个人的页面或者功能必须进行权限控制校验。防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容、修改他人的订单。
(2)用户敏感数据禁止直接展示，必须对展示数据进行脱敏 例如: 手机号隐藏中间四位
(3)禁止字符串拼接SQL访问数据库,防止sql注入攻击
(4)用户传入的任何参数都要做有效性验证
(5)禁止向HTML页面输出未经安全过滤或未正确转义的用户数据。
(8)发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。
五,MySql数据库
-
建表规约
(1)表达是与否概念的字段,必须使用 is_xxx命名,unsigned tinyint（1表示是，0表示否）。
注意: POJO类中的任何布尔类型的变量，都不要加is前缀,，所以，需要在设置从is_xxx到Xxx的映射关系
(2)表名,字段名,必须使用小写字母或者数字,禁止数字开头,禁止两个下划线间只出现数字.数据库字段名的修改代价很大,所以字段名要慎重.
(3)表名不使用复数名词
(4)禁用sql保留字
(5)主键索引名为pk_字段名；唯一索引名为uk_字段名；普通索引名则为idx_字段名。
(6)小数类型为decimal，禁止使用float和double。
(7)如果存储的字符串长度几乎相等，使用char定长字符串类型
(8)varchar是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
(9)表必备三字段：id, create_time, update_time。
(10)表的命名最好是遵循“业务名称_表的作用”。
(11)库名与应用名称尽量一致。
(14)单表行数超过500万行或者单表容量超过2GB，才推荐进行分库分表。
(15)合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。 -
索引规约
(1)业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
(2)超过三个表禁止join ,需要join的字段,数据类型,必须绝对一致,多表关联查询时,保证被关联的字段需要索引
(3)在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。
(4)页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决
(5)如果有order by的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort的情况，影响查询性能。
(6)利用覆盖索引来进行查询操作，避免回表。
(7)利用延迟关联或者子查询优化超多分页场景 -
sql语句
(1)不要使用count(列名)或者count(常量)来代替count(*)
count(*)会统计NULL的行 count(列名)不会统计此列为null值的行
(2)count(distinct col) 计算该列除NULL之外的不重复行数,注意 count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。
(3)当一列全为null时,count(col)的返回值为0 但sum(col)结果为null,因此使用sum时注意NPE问题
(4)使用isnull()来判断是否为null值
(5)代码中写分页逻辑时,若count为0应直接返回,避免执行后面的分页语句
(6)禁止设用 外键与级联,一切外键概念在应用层解决.
(7)禁止使用存储过程
(8)数据订正时,要先select,避免出现误删除,确认无误才能删除
(9)尽量不用in操作 没法避免是尽量控制集合元素数量在1000以内.
(10) 字符串表示尽量使用utf-8 -
ORM映射
(1)在查询中不要使用*作为查询字段的列表,需要那些字段必须明确说明
(2)pojo类的布尔属性不能加is 数据库中字段必须加is 要求在resultMap中进行字段与属性之间的映射
(3)每个表都有一个POJO类与之对应
(4)sql.xml配置中不能使用${} 只能使用#{}
(6)不允许直接拿HashMap或者Hashtable作为查询结果
(7)更新数据表记录时，必须同时更新记录对应的gmt_modified字段值为当前时间。
(8)不要写一个大而全的数据接口
(9)@Transactional事务不要滥用。事务会影响数据库的QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。