最早接触 《Java 开发手册》大概是 2020 年的时候,那个时候刚出** 嵩山版 **, 当时也就是大致扫了一遍,对于一些约定其实也不了解,并没有太在意。随着开发经验的积累,从当初埋头写业务的大头兵,到现在成为了一个带领小团队的负责人,逐渐意识到一套完善的规范制度,对于团队协作以及项目稳定的重要性。
结合公司项目情况,以及项目环境制定了一套我们自己的开发规范,这其中大部分借鉴了《Java开发手册》,正如手册提到的这是 Java 社区爱好者的集体智慧结晶和经验总结,经历了多次大规模一线实战的检验及不断完善,最终整理成册。
所以我想着借此机会重新精读一下最新的 黄山版,在此纪录一下心得感受。
如果需要《Java开发手册》(黄山版) 原文档,可以私聊我领取,无任何套路。
手册分七个章节,编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约。
这里先介绍一下几个附录, 附录一:列举了手册的历史版本,附录三:记录了蚂蚁的相关错误码,不多废话,
重点来看一下附录二:一些专有名称的解释,这个其实也是正常开发和同事交流时会用到的一些名称,如果不清楚,还是熟悉一下比较好,以免沟通出现障碍。
- POJO(Plain Ordinary Java Object):POJO 专指只有 setter / getter / toString 的简单类,包括 DO / DTO / BO / VO 等,POJO 不等于 PO。
- DO(Data Object):数据库映射对象,此对象与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。
- PO(Persistent Object):同 DO 一样,只是叫法不同,本质一模一样。
- DTO(Data Transfer Object ):数据传输对象,Service 或 Manager 向外传输的对象。一般微服务项目中,不同服务件交互时传输时会定义成 DTO。
- BO(Business Object):业务对象,可以由 Service 层输出的封装业务逻辑的对象。
- Query:数据查询对象,各层接收上层的查询请求。注意超过 2 个参数的查询封装,禁止使用 Map 类来传输。 其实一般一个也建议使用对象封装,便于日后扩展。
- VO(View Object):显示层对象,通常是 Web 向模板渲染引擎层传输的对象。简单理解就是返回给前端的数据对象。
- CAS(Compare And Swap):解决多线程并行情况下使用锁造成性能损耗的一种机制,这是硬件实现的原子操作。 CAS 操作包含三个操作数:内存位置、预期原值和新值。如果内存位置的值与预期原值相匹配,那么处理器会自动将该 位置值更新为新值。否则,处理器不做任何操作。
- GAV(GroupId、ArtifactId、Version):Maven 坐标,是用来唯一标识 jar 包。
- OOP(Object Oriented Programming):本文泛指类、对象的编程处理方式。
- AQS(AbstractQueuedSynchronizer):利用先进先出队列实现的底层同步工具类,它是很多上层同步实现类的基 础,比如:ReentrantLock、CountDownLatch、Semaphore 等,它们通过继承 AQS 实现其模版方法,然后将 AQS 子类作为同步组件的内部类,通常命名为 Sync。
- ORM(Object Relation Mapping):对象关系映射,对象领域模型与底层数据之间的转换,本文泛指 iBATIS, mybatis 等框架。
- NPE(java.lang.NullPointerException):空指针异常。
- OOM(Out Of Memory):源于 java.lang.OutOfMemoryError,当 JVM 没有足够的内存来为对象分配空间并且垃 圾回收器也无法回收空间时,系统出现的严重状况。
- GMT(Greenwich Mean Time):指位于英国伦敦郊区的皇家格林尼治天文台的标准时间,因为本初子午线被定义 在通过那里的经线。地球每天的自转是有些不规则的,而且正在缓慢减速,现在的标准时间是协调世界时(UTC), 它由原子钟提供。
- 一方库:本工程内部子项目模块依赖的库(jar 包)。
- 二方库:公司内部发布到中央仓库,可供公司内部其它应用依赖的库(jar 包)。
- 三方库:公司之外的开源库(jar 包)。
接下来就可以开始阅读具体内容了,毕竟是规范类手册,难免枯燥,大家尽量保持耐心,和我一起建立自己的开发规范,相信我早晚用得着。