如何根据开源项目去学习

最近看了下如何根据开源项目去学习，觉得这两位讲的不错，可以参考，和大家分享！

作者：姜宁

链接：https://www.zhihu.com/question/19637879/answer/13545260

来源：知乎

著作权归作者所有，转载请联系作者获得授权。

 

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

 

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

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

 

2.示例代码与单元测试

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

 

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

• 由于一个单元测试一般也就是几个小时的开发工作量，你很容易就能读懂相关的代码。
• 每个单元测试都是可以独立运行的，这样节省你跟踪调试的时间。
• 单元测试在很大程度定义了软件的功能，可以帮助你快速掌握项目的相关API。
• 如果你修改的开源项目的代码，你可以通过修改单元测试来验证你的修改是否正确。
• 单元测试里面也蕴含架构的技巧，如果被测试对象没有很好解耦你是很难写出精简的测试代码的。

3.架构文档

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

作者：javaniu

链接：https://www.zhihu.com/question/19637879/answer/51507188

来源：知乎

著作权归作者所有，转载请联系作者获得授权。

 

你有个任务，需要用到某个开源项目;或者老大交代你一个事情，让你去了解某个东西。怎么下手呢？如何开始呢？我的习惯是这样：

 

1.首先，查找和阅读该项目的博客和资料，通过google你能找到某个项目大体介绍的博客，快速阅读一下就能对项目的目的、功能、基本使用有个大概的了解。

 

2.阅读项目的文档，重点关注类似Getting started、Example之类的文档，从中学习如何下载、安装、甚至基本使用该项目所需要的知识。

 

3.如果该项目有提供现成的example工程，首先尝试按照开始文档的介绍运行example，如果运行顺利，那么恭喜你顺利开了个好头;如果遇到问题，首先尝试在项目的FAQ等文档里查找答案，再次，可以将问题（例如异常信息）当成关键词去搜索，查找相关的解决办法，你遇到了，别人一般也会遇到，热心的朋友会记录下解决的过程;最后，可以将问题提交到项目的邮件列表，请大家帮你看看。在没有成功运行example之前，不要尝试修改example。

 

4.运行了第一个example之后，尝试根据你的理解和需要修改example，测试高级功能等。

 

5.在了解基本使用后，需要开始深入的了解该项目。例如项目的配置管理、高级功能以及最佳实践。通常一个运作良好的项目会提供一份从浅到深的用户指南，你并不需要从头到尾阅读这份指南，根据时间和兴趣，特别是你自己任务的需要，重点阅读部分章节并做笔记（推荐evernote）。

 

6.如果时间允许，尝试从源码构建该项目。通常开源项目都会提供一份构建指南，指导你如何搭建一个用于开发、调试和构建的环境。尝试构建一个版本。

 

7.如果时间允许并且有兴趣，可以尝试阅读源码：

（1）阅读源码之前，查看该项目是否提供架构和设计文档，阅读这些文档可以了解该项目的大体设计和结构，读源码的时候不会无从下手。

（2）阅读源码之前，一定要能构建并运行该项目，有个直观感受。

（3）阅读源码的第一步是抓主干，尝试理清一次正常运行的代码调用路径，这可以通过debug来观察运行时的变量和行为。修改源码加入日志和打印可以帮助你更好的理解源码。

（4）适当画图来帮助你理解源码，在理清主干后，可以将整个流程画成一张流程图或者标准的UML图，帮助记忆和下一步的阅读。

（5）挑选感兴趣的“枝干”代码来阅读，比如你对网络通讯感兴趣，就阅读网络层的代码，深入到实现细节，如它用了什么库，采用了什么设计模式，为什么这样做等。如果可以，debug细节代码。

（6）阅读源码的时候，重视单元测试，尝试去运行单元测试，基本上一个好的单元测试会将该代码的功能和边界描述清楚。

（7）在熟悉源码后，发现有可以改进的地方，有精力、有意愿可以向该项目的开发者提出改进的意见或者issue，甚至帮他修复和实现，参与该项目的发展。

 

8.通常在阅读文档和源码之后，你能对该项目有比较深入的了解了，但是该项目所在领域，你可能还想搜索相关的项目和资料，看看有没有其他的更好的项目或者解决方案。在广度和深度之间权衡。

 

以上是我个人的一些习惯，我自己也并没有完全按照这个来，但是按照这个顺序，基本上能让你比较高效地学习和使用某个开源项目。