阅读优秀代码是提升开发人员修为的一种捷径（转载）

原文做者Alan Skorkin是一名软件开发人员，他在博客中分享对软件开发相关的心得，其中有不少优秀的文章，本文是其中的另外一篇。Alan认为：阅读优秀代码是提升开发人员修为的一种捷径。如下是全文。我忽然想起来，不少程序员都讨厌阅读代码。来吧，认可吧！ 每一个人都喜欢编写代码，编代码是件趣事。 另外一方面，阅读代码也不容易。 不只不容易（编注：参见《微软资深软件工程师：阅读代码不容易》）， 并且还很是枯燥，我们要面对这一事实。任何不是你的代码都不怎样。（虽然咱们没有说出来，但咱们都是这样想的。）

编者按：即使是你本身几个小时以前写的代码，也会看起来很烂。时间越久，看起来越烂。 因此，为何你要浪费时间去看其余人的糟糕代码，而你彻底能够利用这段时间编写你本身的优秀代码。 其实咱们能够一试，几个小时以后回头再看，看看你的代码是否还依旧优秀。 若是你不能吸取前辈大师的经验知识，那你永远都没法成为一位大师。 成为大师的方法之一是，找到一位大师，让其倾囊传授其所知。 有这种可能么？固然了，有这可能，虽然机会不大，但你必须极其走运。 不过你没必要十分走运，由于咱们幸运地处于这样一个职业，一个充满着大师知识和技能的职业，等待咱们去汲取吸取，这些东西就在他们所编写的代码中。 你要作的就是去阅读代码，固然了，这或许耗时很多，毕竟没有人坐在那里给你讲解，但这种方法的成效还很高。 打个比方，要想成为一名卓越的木匠，得观察大量结构优良的家具。

我喜好阅读代码，个人直觉告诉我，你也会从中获益颇丰。虽然阅读过程恼人并烦人，但其回报是很是值得你为之努力的。 说到这个，若是你想成为一名卓越的做家，你会专一于写做么？ 你或许已经尝试，但你并无走得很远。 大多数的伟大做家也是如饥似渴的读者，这是一个广泛事实。 在你能写出任何拿得出手的东西以前，你须要品读其余伟大做家，吸取不一样的风格，看看前辈已尝试过的东西，从中吸收精华。 你的知识会慢慢增加，你本身的做品最终会透露出些许成熟，你也会找到一种“感受”。 编写代码和写做没什么不一样，若是你都没有阅读过任何卓越的代码，你为何指望本身能写出像样的代码呢？ 你显然不该该那样。对于程序员来讲，阅读卓越代码就如同做家阅读优秀书籍同样重要（这话可不是我说的，这是Peter Norvig（Google研究院总监）说的，他很是优秀，你们也要向他学习了）。

即使全部这些都没法让你信服，那这里有一个不可置否的事实。 对你做为一名专业开发人员的生存来讲，善于阅读代码相当重要。 现在，任何有必定规模的项目，都是团队的成果。因此，你一般要处理、修改和扩展大量不是你写的代码。 所以，阅读代码多是你能掌握的最经常使用并最有用的技能。挺过这个难关，好好掌握。

如何阅读代码？像某些人同样……

我已经记不清有多少次看到程序员（用鼠标）滚上滚下地看着不熟悉的代码，几分钟事后，他们的脸上浮现出不悦的表情。 他们不久后会宣告说，那代码不值一读，为何要浪费时间呢？咱们只能用其余方法解决问题。 我不肯定（他们）在期待什么，是经过潜移默化来吸取代码的含义，仍是集中精神盯着代码来获得启发？ 你不能只靠长时间盯着代码来阅读代码，你要理解它并化为己用。 这里有一些我喜欢用的技巧，虽然这不是一份详尽的列表，但我发现其中有些特别有用。

1.尽力构建并运行代码。 这一般是一个简单的步骤，就像你在看可运行的代码（这和随机代码相反）。不过，并不是老是如此。经过构建和执行代码，你能从中学到不少上层代码结构。 说到工做代码，你是否很是熟悉如何构建你的当前项目？ 虽然构建一般很是复杂，但经过构建并生成可执行的代码，你能学到不少。

2. 不要只注重细节。 你要作的第一件事是，在你正阅读的代码中，找到代码结构和风格的。 首先浏览一下代码，尽力理解不一样代码段要作什么。这会让你熟整个代码的上层结构，你也能领会到你正处理的代码的一些构思（良好架构和意大利面条等）。 这时候，你能够找到切入点（无论它是什么，主函数、servlet或控制器等），并查看代码如何在那里分支。 不要在这上面花过多的时间，随着你越发熟悉代码，你能够随时回来查看。

3. 确信本身理解全部结构。 除非你碰巧是所用编程语言的首席专家，不然该语言有些它能作的事你可能还不知道。当你在浏览代码时，记下全部你或许不熟悉的结构。 若是有不少不熟悉的结构，你要作的下一步很是明显。 若是你不知道代码要作什么，那你就走不了很远。 即使只有几个你不熟悉的结构，你应当深刻查看。 你如今是在探索你所用编程语言中你之前不知道的东西，为此花几个小时来阅读代码，我也很是乐意。

4. 既然你对大多数结构已有很好了解，那如今是该作些随机深刻研究了。 就像步骤2，开始浏览代码，当此次 要挑选一些随机函数或类，并开始逐行详细查看。 这是硬仗开始的地方，但也是你要取得主要成功的地方。 这里的构想，会造成你正在查看的代码库的思惟模式。 也不要在这上面花过长的时间，但在继续前行以前，你要尽力并极大吸取一些有内容的代码块。 这个步骤，你也能够随时反复回过头来，每次你都会了解更多的背景，并收获更多。

5. 毫无疑问，在前面这些步骤中，确定有你困惑的地方，因此这是你作些测试的最佳时间。 在测试的时候，你的麻烦可能会更少，同时你也能理解代码。 我一直感到奇怪，开发人员忽略一套写得很好很全面的测试代码，而尽力去阅读并理解某些代码。 固然了，有时候并无测试。

6. 若是你说没有测试，那这听起来是编写测试的时候了。 （编写测试）有不少益处，有助于你本身的理解，有助于你提高代码库，阅读代码时也能编写代码，这是该你出手作些事的时候。 即使已经有了测试，一般你也能够编写一些测试，你总能受益的。 测试代码一般须要换种方式思考问题，那些你之前不太明了的概念也会变得更清晰。

7. 提取奇特的代码，使其成为单独的程序。我发现阅读代码是个很是有趣的练习，即使只为节奏变化。即使你不了解代码的底层细节，你或许能知道一些代码在上层结构上要作什么。 什么不提取一些特定的函数，单独列为独立的程序。 当你在执行小段程序时，调试也会更简单。反过来讲，可能还须要一些额外的步骤，才能理解你正查看的代码。

8. 代码不干净？有异味？ 为何不重构它？ 我并不建议你重写整个代码库，但重构部分代码，真的有助于你理解层次上升一层。 把你理解的函数拿出来，改为独立的函数。 在你知道以前，原来的大函数看起来易管理，你能够在脑海中修改它。 重构容许你把代码变成本身的，无需完成重写代码。 若是有好的测试，有助于重构，但即使你没有好的测试，抽取你肯定的函数并作测试。 即使测试看起来彻底不充分，但做为一个开发人员，你得学着相信你的技能，有时候你只需努力去作（重构）。（若是你必须重构，你一般均可以把代码恢复原 状。）

9. 若是没什么能帮上忙，那你就找个阅读代码的同伴。或许并不是只有你一我的能从这代码中获益，因此去找一个 人，一块儿阅读代码吧。 但你别找专家，他们会从上层结构上，向你解释全部东西，你会错失那些你本身详细查看代码时所能学到的细微差异。 然而，若是不见效的话，你也不能理解，有时候，你能作的最好的事就是去问。 向你的同事请教，若是你正在阅读开源代码，能够在互联网上找人问问。 可是你要记住，这是最后一步，而不是第一步。

若是我时间紧迫，须要快速合理地理解某些代码，而且我只能挑选上述步骤的其中一个，那我会选择“重构”（即：第8个步骤）。 虽然你能理解的东西不会不少，但那些你领会的东西，你会紧紧记住的。 总之，有件事你须要记在内心。 若是你新接触一个重要的代码库，你不可能当即能理解它。 这须要数天、数周和数月的潜心努力，接受这个事实。 即使有一位专家和你在一块儿，也不能明显地缩短期（。然而，当涉及到代码库时，若是你能耐心并有条不紊地阅读（和编写）代码，你最终能熟悉项目的方方面面，你能成为大牛。 你或者是逃避阅读代码，常常寻求某人帮你讲解某事。 我知道我会成为哪种人。

寻找阅读代码的机遇 – 不要错失

咱们喜欢编写新代码，是由于咱们此次能正确处理问题。 好吧，也许不是此次，但必定是下次。 事实上是，你常常改进你的技术，但你从没有恰当地处理问题。 这就是编写新代码的价值所在，你能够历练并磨练你的技能，但阅读和把玩其余人编写的代码，（若是没有更多的价值，）也是有一样多的价值。你不只能从中得到一些有价值的技术知识，也能收获领域知识，领域知识一般仍具更多价值（毕竟，代码是文档的最终形式）。

即使代码写得很神秘，无任何惯例可言，但仍是有价值。 你知道我在说的代码，它几乎看起来晦涩难懂，但不是有意而为之（因某些缘由，Perl语言代码一般是这样的）。 无论何时我看到那样的代码，我都会这样想： 把它想象成只有你破译它后才能学到的东西。 是的，这是主要的痛楚之处，但要接受它，有时候你本身也会因琐碎的缘由而写出那种令人困惑的代码（否定没有用，你知道这是真的）。 好了，若是你花些时间来阅读那样的代码，你更有可能最终写出一样的代码。并不说你将会写出那样的代码，但你有能力写出那样的代码。 最后，态度一般是最重要的（编注：态度决定一切）。 若是你视阅读代码为平常繁琐的工做，那它就是（繁琐的工做），而且你会逃避，但若是你视其为一个机遇，那好事终将到来。

编者后话

你会常常去阅读优秀的开源代码么？欢迎在评论中和你们分享。