如何研读开源项目代码

今天在微博上看到庄表伟在知呼上回答的如何更有效地学习开源项目的代码？

我很认同他总结的 “学习开源，就尽可能在代码里找答案，而不是在代码之外找答案，那些都是二手的，而且很可能是不准确的。”  但是如何读好，读懂代码，我这边还是有不同的认识。

 

1. 需要从代码管理库下载完整的源代码，而不是简单的源代码文件包或者source.jar.

    这样做有很多好处，一个是你可以获取代码的修改记录，还有你可以获取到完整的测试代码，当你要提交patch的时候，你可以借助版本管理工具生成针对不同版本的patch。

 

2. 示例代码与单元测试

    示例代码可以帮助你学会使用相关开源项目的API。很多朋友在使用开源项目的时候遇到一个小问题就发信给开发者要这样或者那样的示例代码，其实他们没有发现大部分的开源项目在开发的过程中，为了验证其实现的功能，都会写很多单元测试代码。这些代码其实非常好的示例代码。可能是下源码，建工程会花费你几个小时的时间，但是如果你想深入了解开源项目的话，这点投资还是很有价值的。

 

     其实读单元测试的好处太多了，这里简单给大家列一下：

• 由于一个单元测试一般也就是几个小时的开发工作量，你很容易就能读懂相关的代码。
• 每个单元测试都是可以独立运行的，这样节省你跟踪调试的时间。
• 单元测试在很大程度定义了软件的功能，可以帮助你快速掌握项目的相关API。
• 如果你修改的开源项目的代码，你可以通过修改单元测试来验证你的修改是否正确。

3. 架构文档

     其实大部分的开源项目都会对其架构有一定的描述，这些描述可能会有点过时，但是通读一下会让你项目有一个比较深入的认识。这样做好比是让你对北京的二环，三环，四环，五环有个大体的认识。这样在你要对代码的某块内容进行详细研究的时候（例如找中关村的位置的时候，知道西北四环）就能很快定位了。