写点什么

黄山归来不看岳:《Java 开发手册(黄山版)》新增 11 条规约

作者:琦彦
  • 2022 年 10 月 05 日
    河南
  • 本文字数:1766 字

    阅读完需:约 6 分钟

孤尽老师有话说

五岳归来不看山,黄山归来不看岳!从 2015 年到 2022 年,希望这是爱因斯坦的第三个小板凳,点点滴滴,希望对大家的程序员生涯有帮助

《Java开发手册(黄山版)》下载

1. 聊聊版本沿革

最初的版本,没有名称,只有版本号,从 1.0.0 开始,后来感觉并不利于传播,改成以五岳来命名。因为华山最有武侠渊源,所以第一个版本叫做《华山版》,边上的码出真功有点向周星驰电影功夫最后的场景《如来神掌》致敬的味道;华山之后,去五岳至尊泰山朝圣,感受东海日出的壮观;泰山之后,去往嵩山,因为那里有一个金庸先生笔下武功最高的人物——扫地僧,所以封面用了扫地僧的原型。印象最深的是封面,太阳下的扫地僧在台阶上的影子,来来回回还改了好几次,为了逼真,我觉得影子需要有点折子的感觉,表达这是台阶上的影子;嵩山之后,不出意外是恒山版,为此还去了悬空寺,结果无意中发现恒山和衡山的发音居然完全相同,这个在表达上是大忌,增加无谓的共同成本;为此还公开征集下一个版本名称,收到:天山版,屏峰版,玉山版,黄山版...,最后选择了黄山版,是那句诗:五岳归来不看山,黄山归来不看岳,那就遗忘掉以前的版本。


2. 以上四个版本的共同之处?

第一、都是使用了武侠的水墨画风格;第二、都是使用的红色印章的方式表达版本号;第三、推广中国元素和风景区;

3. 黄山版的更新之处?

一、排版上

统一字号改小一号,条目之间统一留出 0.5 行的间距,即使本次新增 11 条,总页数还是从嵩山版的 63 页减少到本次的 55 页:



二、内容上的其他更新如最后的版本历史所示:


回归初心,码出高效,码出质量,码出快乐,从 2015 到 2022,痛并快乐着,坚持公益,坚持我的,一路走到黄山。无论是排版,样式,说明,正反例,过年也是仔仔校对,细细勘察,相信黄山归来不看岳,《Java 开发手册(黄山版)》,相信我辈程序员值得拥有哈~


以上内容节选https://www.zhihu.com/question/514550687/answer/2335435300

《Java 开发手册(黄山版)》

孤尽老师,一直是我的榜样。你看,即使是在 2022 年的春节大联欢的时候,他还在“内卷”,于 2 月 3 日整理发布出《Java 开发手册(黄山版)》。


记得从《Java 开发手册》刚发布时,自己拿到时的欣喜感,像是“捡了个大便宜”--终于有一个国产的 JAVA 编码的系统总结。基于此,自己也在团队中组织培训了多次。


特别是其中的编码规约--并发处理,对于刚工作的开发人员,提前规避了很多坑,也帮助自身快速熟悉了 JUC 常见集合的原理和异常处理。而对于高级开发人员,其中的设计规约,从刚开始的理论熟悉,慢慢有了心悦诚服的认可。


所以,当《Java 开发手册(黄山版)》发布后,我也迫不及待的通读了一遍,我知道这又是一个“修武”的好机会,哈哈。


看完《Java 开发手册(黄山版)》,有三大感受: 例子更详实了,说明更醒目了,规约更完善了(多了 11 条,下文会一一列举)


期待后面的版本有分布式,架构图,系统设计更多的内容。(哈哈,免费的,还这么贪心)

1. 例子更详实了

1.1 常量定义-魔法值

1.2 OOP 规约--构造方法

1.3 日期时间

1.4 并发处理-线程池

2. 说明更醒目了

2.1 代码格式


3. 规约更完善了

3.1 浮点数类型的数值后缀统一为大写的 D 或 F

3.2 枚举 enum(括号内)的属性字段必须是私有且不可变

3.3 【推荐】为了保护用户隐私,日志文件中的用户敏感信息需要进行脱敏处理。

3.4【强制】对于文件上传功能,需要对于文件大小、类型进行严格检查和控制。

3.5【强制】配置文件中的密码需要加密。

3.6 【强制】在数据库中不能使用物理删除操作,要使用逻辑删除。

3.7 【强制】二方库定制包的命名方式,在规定的版本号之后加“-英文说明[序号]”,英文说明可以是部门简称、业务名称,序号直接紧跟在英文说明之后,表示此定制包的顺序号。

3.8【强制】调用远程操作必须有超时设置。

说明:类似于 HttpClient 的超时设置需要自己明确去设置 Timeout。根据经验表明,无数次的故障都是因为没有设置


超时时间。

3.9【推荐】客户端设置远程接口方法的具体超时时间(单位 ms)

超时设置生效顺序一般为:1)客户端 Special Method;2)客户端接口级别;3)服务端 Special Method;4)服务端接口级别。

3.10【推荐】了解每个服务大致的平均耗时,可以通过独立配置线程池,将较慢的服务与主线程池隔离开,免得不同服务的线程同归于尽。

3.11 【强制】系统设计时要准确识别出弱依赖,并针对性地设计降级和应急预案,保证核心系统正常可用。


发布于: 刚刚阅读数: 4
用户头像

琦彦

关注

孤独的技术没有价值 2019.08.24 加入

还未添加个人简介

评论

发布
暂无评论
黄山归来不看岳:《Java开发手册(黄山版)》新增 11 条规约_Java_琦彦_InfoQ写作社区