关于架构师:架构师日记如何写的一手好代码

作者：京东批发 刘慧卿

一 前言

在日常工作中，我常常听到局部同学埋怨代码品质问题，潜台词是：“除了本人的代码，其他人写的都是垃圾，得送到绞刑架上，重构！”。明天就来聊一聊，如何写的一手好代码。要答复这个问题之前，得先弄清楚一个问题，好代码的规范是什么？易浏览，可扩大，高内聚，低耦合，编程范式，设计准则 ……，要求不少，却很难度量。实则代码和文章一样，正所谓文无第一，武无第二。

这里不打算从规定宝典，最佳实际等方面动手，因为那将陷入到有数的规定细节中去，容易不得要领。这也是很多同学，学了很多当下最新技术，把握了 N 门编程语言，却始终没有显著晋升的起因。对于技术而言，底层的原理和运行法则是基本，它和编程语言，语法等应用层的重要水平是不一样的，切记不要进入这个误区。

技能的把握个别须要经验学习、模拟、思考、翻新四个过程，上面就分几个阶段来探讨一下，到底该如何疾速学习成长。

二 学习进去的代码

学习意识

如果说人生有什么捷径，寻找前人走进去的路，就算是捷径了吧。前人须要花了几年，甚至穷其毕生钻研的成绩，摆在那里，用还是不必？答案应该是必定的，接下来要做的，只是如何把它们找进去，联合当下的情景，在泛滥的解决方案中选出卓有成效的就能够了。Henry Spencer 曾说：“不懂 Unix 的人注定最终还要反复创造一个撇脚的 Unix”。

所以有必要建设这种意识：无效的学习是升高指标老本的最佳策略之一。这比本人摸着石头过河，在工夫老本上，会有很大的节俭，这还没思考物质和精力上的投入，各种试错，就更划算了。

抉择楷模

既然是取经学习，就要学习优良的，胜利的教训，如此，雷同的精力投入，取得的回报往往更高。科班出身，或者正在和你同行的都不是好的抉择，你不晓得他们最终会不会误入歧途。所以抉择楷模时，肯定要跳出圈子，去找你能找到的最优质的的那些，你的抉择能够涵盖历史上，行业里，公司中各个维度。

学习的过程中，带着批评的思维去消化，只有这样能力改良翻新，所有的清规戒律都有其限定范畴，当限定边界突破了，之前的正确性，就值得你去狐疑。举个例子，很多编码标准里都有那么一条：“一行代码长度, 不超过 80 个字符”。

它的来历是这样的：在很久很久以前，有一个很风行的人机交互接口（终端）叫 VT100，用来解决字符 / 文本，起初其它的很多终端都是以它为规范。这个终端屏幕 24 行、80 列，编辑器菜单还占了 4 行。所以，代码编写倡议是一个逻辑的解决代码，20 行最佳、每行字符长度不超过 80 列。目标就是为了可视性（目之所能及）、可维护性。而现在显示终端的分辨率普遍提高了，所以降级调整标准并无不可，比方：“每行 120 个字符，每个函数体代码 80 行以内”。

所以，很多历史教训，理解其背地的运行逻辑，能力施展出它本来的作用。

学以致用

大家常说万事开头难，到底难在哪里？难在信心上，难在门槛上。信心能够通过痛点和指标来牵引，门槛能够通过指标拆解来升高。高质量的实现某件事情，有很多迷信的工具和办法，比方：PDCA 循环，SMART 准则等，有趣味的，能够拓展学习。

这里想要表白的是，领有痛点和指标是可能坚持不懈的前提，因为在学习实际的过程中，可能练习中进行利用，并能取得实在反馈和回报，这是可能保持精进的原动力。否则就容易陷入，相似咱们背诵四级利用单词‘’“abandon”的魔咒，也不晓得从它开始背诵了多少遍了。

再举个例子，咱们须要做零碎模块解耦，调研下来，应用音讯队列 MQ 中间件，可能很好的解决咱们目前面临的问题。

1. 第一步，开始学习无关 MQ 的常识，理解各种 MQ 中间件的实用场景，联合应用场景，给出具体中间件的选型；
2. 第二步，将 MQ 中间件引入到咱们的零碎中。应用的过程，就是一个一直发现问题，钻研起因，修复问题，总结经验的过程。

如果没有实在的利用场景，往往会始终停留在第一步，重复开始，直到失去急躁，最终放弃。

小结

想要写好代码，须要有学习的意识，至多可能晓得什么样的代码是好的，什么样的代码是有改良空间的。这种判断能力，须要通过一直的浏览各种类型的代码，从中找出楷模。材料的起源能够是经典书籍，好的开源我的项目，甚至是你身边的优良我的项目。同时也须要躲避一些误区：

1. 工作上遇到的大部分问题，只有去寻找，都是有解决方案的。须要亲自下场试错，发明答案的场景，很少；
2. 教训都是有实用边界的，照搬的教训不肯定就适宜咱们，这须要理解教训背地的撑持逻辑，灵便的做出调整；
3. 学习指标的抉择是须要机会的，要有适合的实际场景，否则，往往会事倍功半，甚至大功告成；

三 模拟进去的代码

认知陷阱

所谓代码模拟，不是简略的照猫画虎。而是遇到问题了，能够基于之前的学习积攒，可能疾速的找到优良的解决方案，并加以利用。能够是一个技术点，能够是一种模式策略，能够是一种解决方案，甚至是一种编程思维。

这个阶段通常处于认知模型的第二层：“晓得本人不晓得”。也是冲破认知极限，疾速成长的阶段。直观感触就是一个问题接一个问题，一个概念接一个概念，要了解和学习的常识太多了。这对集体的毅力和急躁是一个考验，很多人就是在这个阶段进入认知陷阱，最终转行了。

以终为始

在实际过程中，会面临着要学的常识，要补的课，太多了：“计算机网络，应用服务，数据存储 ……”。计算机网络又蕴含运营商，光纤，电缆，域名，cdn，交换机，代理服务，http 协定，客户端，浏览器，会话 …，每一个节点又能够往下拆下去，感觉没有止境。

是须要全副弄懂再去入手吗？我到底是要做一个专才，还是成为一个全才？这个问题还要以倒退的眼光来看。上面就以市场人才发展观为例，开展探讨一下。

• T 型人才

事实中往往是“T 型人才”比拟受用，” 一 ” 示意有博大的知识面，”|” 示意常识的深度。两者的联合，就是传说中的一专多能。特地是大公司，员工岗位分工比拟细，像螺丝钉一样，只有做好眼前的事件就好了。如果专之外加上多能，在横向上具备比拟宽泛的一般性常识涵养，而且在纵向的专业知识上具备较深的理解能力和独到见解，就有了较强的创新能力。

• π 型人才

咱们晓得，因为行业的疾速迭代，叠加各种不确定性，有些岗位的合理性受到不同水平的挑战，失去竞争力，遭逢下岗的境遇。业内又喊出了“π 型人才”的概念。

π 型人才是源于新加坡的一种人才观，在 T 型人才的根底上，进一步进化。π 比 T 多进去的一竖，个别是源于兴趣爱好或工作所需，孵化进去的第二事业线。“两条腿走路”，势必有更强的抗危险能力，和更强的市场变动应答能力。

• 梳子型人才

梳子型人才更加形象了，多条腿走路，即在多个业余有深刻的专业知识，同时在顶层放弃一个一生学习的习惯。它代表着弱小的底层思维和逻辑能力，它决定了你是否具备常识迁徙能力，肯定要先夯实它，否则很容易变成三天打鱼两天晒网。

人的精力和能力是无限的，机会也不是人人都能碰上的，所以梳子型人才往往不是咱们的第一指标。咱们能够先从 T 型人才开始致力，时机成熟之后再往 π 型，甚至梳子型人才上迈进。

以终为始，能力看得清脚下的路。对于技术的学习和利用也是如此，以后须要什么，就学习什么，深挖什么。有余力了，机会来了，就能够被动转身，再创辉煌。

小结

学习实际阶段处于比拟吃力的爬坡过程。考验的是对实现目标的毅力和信心，意识到这一点至关重要。技术的钻研方向，深刻水平，还是倡议循序渐进，结合实际利用场景，先在以后畛域扎深扎透，再伺机倒退，多条腿并行。

四 设计进去的代码

编程思维

所谓编程思维，就是“了解问题，找出门路”的思维过程，它由合成、模式识别、形象、算法四个步骤组成。

1. 一个简单问题会先被拆解成一系列好解决的小问题；
2. 每一个小问题被独自检视、思考，搜寻解决方案；
3. 聚焦几个重要节点，漠视小细节，造成解决思路；
4. 最初，设计步骤，执行，直至问题解决。

编程思维并不是编写程序的技巧，而是一种高效解决问题的思维形式。

编码准则

计算机是人造的学科，编码准则就三个字：好保护。如果思考指标诉求，可能还能够追加一条：“运行快”，但目前大部分利用场景，计算机性能曾经足够快了，很多时候，第二条往往被疏忽掉了。

开闭准则，KISS 准则，组合准则，依赖反转，繁多职责准则等大部分设计准则都是围绕着这个根本准则开展的。如果你感觉你的编码设计比拟顺当，老得腾出精力来调整保护，那么大概率这个设计是不合理的，你得想方法让本人从中解放出来。

理论编码过程中的各种标准束缚，比方：代码标准，设计模式，日志打印标准，异样解决策略，接口设计规范，圈复杂度等，参照根本编码准则去了解，就能想的通了。

抽丝剥茧

所有的技巧都是建设在相熟的根底上，对于程序员来说，就是代码。浏览海量的代码，编写海量的代码，在这个过程中，一直的改良调优，是练就硬功夫的前提。上面就以案例的模式，为大家展示一下该如何浏览源码，借此晋升本人的设计能力。

案例是取自 RocketMQ 开源我的项目，你能设想上面这段代码为什么这么写吗？

        代码出处：org.apache.rocketmq.store.logfile.DefaultMappedFile#warmMappedFile

• 背景介绍

RocketMQ 应用文件预热优化后，在进行内存映射后，会事后写入数据到文件中，并且将文件内容加载到 page cache，当音讯写入或者读取的时候，能够间接命中 page cache，防止屡次缺页中断。这个办法的作用就是文件预热。

• 提出问题

1. 什么是缺页中断，对性能有怎么的影响？
2. 为什么循环次数是 4K，为什么往 ByteBuffer 中写 0？
3. 为什么 Thread.sleep 代码块，正文上写着：prevent gc？

• 刨根问底

1）先探讨第一个问题，对于缺页中断的原理，属于计算机组成原理的领域，这里不开展具体介绍，大略流程能够参照上面这张图：

简略解释一下这个流程：

• 过程通过 CPU 拜访虚拟地址 VA，通过 MMU 找到对应的物理地址（主存），当内存页在物理内存中没有对应的页帧或者存在但无对应的拜访权限，在这种状况下，CPU 就会报告一个缺页的谬误；

• 物理内存中没有对应的页帧，须要 CPU 关上磁盘设施读取到物理内存中，再让 MMU 建设 VA 和 PA 的映射；

• 缺页对性能的影响，也得看具体情况，参照下图：

◦ 从磁盘替换区中调入缺页：百 μ s 至几十 ms

◦ 从磁盘文件区中调入缺页；几十甚至几百毫秒

◦ 从磁盘缓冲区中调入缺页：数百 ns

如果不加载任何 MappedFile 数据至内存中的话，依照最坏的影响，1GB 的 CommitLog 须要产生 26w 屡次缺页中断。所以通过代码设计，缩小缺页的状况呈现，会大大晋升利用响应效率。2）咱们再来看第二个问题，为什么循环次数是 4K，为什么往 ByteBuffer 中写 0？

传统 HDD 扇区单位始终习惯于 512Byte，有些文件系统默认保留前 63 个扇区，也就是前 512 * 63 / 1024 = 31.5KB，假如闪存 Page 和簇（OS 读写根本单位）都大小为 4KB，那么一个 Page 对应着 8 个扇区，用户数据将于第 8 个 Page 的第 3.5KB 地位开始写入，导致之后的每一个簇都会跨两个 Page，读写处于超界处，这对于闪存会造成更多的读损及读写开销。

除了 OS 层的 4K 对齐至关重要以外，在文件写入过程中依然须要关注 4K 对齐的问题。假如 Page 大小依然为 4KB，向一个空白文件写入 5KB 数据，此时须要 2 个 Page 来存储数据，Page 1 写满了 4KB，而 Page2 只写入 1KB，当再次向文件程序写入数据时，须要将 Page2 数据事后读出来，而后与新写入数据在内存中合并后再写入新的 Page 3 中，之前的 Page 2 则标记为 stale 期待被 GC。这种带来的开销被称为写入放大 WA（Write Amplification）。为了避免写入放大的情景呈现，咱们会提前将 Page 空间，用 0 填充写满。

3）最初，咱们再来看第三个问题，为什么 Thread.sleep 代码块，正文上写着：prevent gc？

这段程序表白的意思很容易了解，每执行 1000 次循环，执行一次 Thread.sleep(0) 语句。但背地的目标确没那么显著。即 Thread.sleep(0) 能够让线程进入 Safepoint，从而触发 GC。

这就得理解一下平安点（Safepoint），用户程序执行时，并非在代码指令流的任意地位都可能停顿下来，开始垃圾收集，而是强制要求必须执行达到平安点后才可能暂停。意思就是在可数循环（Counted Loop）的状况下，HotSpot 虚拟机有一个优化，就是等循环完结之后，线程才会进入平安点。代码中 int 类型就属于可数循环，当然 Long 类型属于不可数循环。

总结一下，这段代码的目标就是，在预热数据的时候，每写入 1000 个字节，让该线程立刻从运行阶段进入就绪队列, 开释 CPU 工夫, 能够让操作系统切换其余线程来执行，比方 GC 线程的执行。这也侧面的反映出零碎设计者对数据响应效率的谋求，通过人工染指 GC 频率，防止出现超长工夫 GC 状况的呈现，影响刹时的吞吐效率。

小结

程序编写，依照不同的维度视角，有很各种各样的准则和倡议。其本质还是以下两个方面：

1. 着眼于人：容易保护；
2. 着眼于机器：运算速度快；

分明的意识到程序实质，是可能进行翻新的根底。

最初，通过一个理论案例，简略的展示了一下如何浏览代码，以及如何从他人的代码中学习程序设计，其外围还是要有刨根问底的好奇心，领有触类旁通的思考与积淀。

五 重构进去的代码

意识重构

重构（Refactoring）就是通过调整程序代码改善软件的品质、性能，使其程序的设计模式和架构更趋正当，进步软件的扩展性和维护性。更狭义的了解，就是突破原有的组织模式，依照新的规范进行重新组合。

从实践和理论教训来讲，零碎或代码的重构往往是集体能力实现疾速晋升的良好契机。雷同条件下，有重构教训的同学和没有重构教训的同学，对很多概念和规定的了解深度会有很大区别。这就是典型的习得性经验，通过教学很难把握。生存场景中的游泳，骑自行车就是习得性经验的代表。

对于重构相干的要点，以思维导图的形式出现，如下图：

独当一面

现实情况中，整个团队梯队建设个别是金字塔型的，即高中低职级的同学一起对我的项目负责。不同职级的同学，对技术的要求和规范也不一样，要都依照高标准来执行，对低职级的同学显然是不偏心的，反之也是一样。所以如何解决这个矛盾，是咱们不得不面对的问题。

抓大放小，就是要依照业务辨别外围和非核心，流程辨别上游和上游，零碎辨别 0 级和 n 级 ……，重要的尽量依照高标准来执行，个别的依照一般规范来执行，并投入与之相匹配的资源。举个例子，比方，B 端的某些经营工具，咱们对它的 QPS，可用率要求和 C 端用户的是不一样的，影响决策的根据是边际老本和收益。

• 常见误区一：对性能优化的执念。“优良的程序员应该榨干每一字节内存”，听起来很有情理，不是吗？但经济学上来讲，边际效应决定了一次我的项目中，越优化性价比越低。有一个很容易被疏忽的事实：硬件其实比程序员要便宜。

• 常见误区二：对设计模式的崇拜。设计模式当然是好货色，但如果像强迫症一样应用它们，就会导致按图索骥，强行让问题去适应设计模式，而不是让解决方案针对问题，这就轻重倒置了。

所谓“甲之蜜糖，乙之毒药”。对于某款产品，稳定性，高吞吐就是其立身之本，间接影响着市场份额和收益，那么投入精力去做性能优化就是划算的。如果你的产品是一个提效工具，对代码的性能和扩展性，往往就没有那么高的要求，过于奢求反而没有必要。

小结

重构尽管对集体和业务都是有莫大益处，但思考到实际成本问题，很多重构都是没有必要的。总结一下重构的要点：

◦ 重构的前提：重构是为了满足业务诉求而不得不做的最佳计划；

◦ 重构的最大危险就是：低估了施行难度。思考兼容现有业务，同时撑持好将来布局。负重前行，要比重启新我的项目要简单的多，如果新我的项目的难度是 0 到 1，那么重构就是从 - 1 到 1；

◦ 重构最大难度是：指标制订和过程治理。

“晓得本人晓得”，就会对技术会有一些本人的思考和翻新，不容易的随声附和，可能基于现状和指标，做出决策，即所谓的独当一面。

六 总结

本文次要从如何疾速学习把握编码技能开展，强调了认知对学习的重要性，提出了抉择方向，建立楷模，学以致用等学习门路。同时针对成长过程中遇到的困惑和职业倒退方向，做了论述，借事成长，择时登程，防止进入一些认知误区。以代码浏览案例，直观的展示了如何在代码浏览中学习和思考。最初，介绍了重构的意义和局部准则。总体上，是依照学习成长路线来进行论述的，心愿可能缩小咱们路上，那些成长的懊恼！

注：本文局部图片和案例来自网上