读懂开源项目| 青训营笔记

93 阅读3分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 6 天

前言

学习他人优秀的开源项目应该是每一个程序员的必经之路,这一点大家都应该很清楚,也知道要去主动寻找这些项目去学习。然而这件事情似乎并不好落地,痛点在于很多同学没有经验,拉取完别人的项目之后就不知道从何下手了。
怎么解决这个问题呢?

项目学习五步走

  • 第一步,查看这个项目的readme.md文件。
  • 第二步,让克隆下来的项目在本地跑起来。
  • 第三步,理清项目结构。
  • 第四步,寻找代码重点区域。
  • 第五步,结合自身所需,精准学习。

看说明

第一步,先大概过一遍这个项目的readme.md文件。

知名且开源的项目的readme.md文件都是写的很清晰的,这个文档大概会说明该项目使用到了哪些技术栈,我们可以根据自己的需要决定是否需要去学习该项目;

当我们确定需要学习该项目之后,继续往下看,我们往往会发现其中还包含了该项目的使用说明,这些说明可以很好地指导我们后续的操作。

跑项目

第二步,先让项目在自己的环境下跑起来。

很多同学把项目克隆下来了之后就直接上手看代码了,这肯定是不合适的,我们需要先项目运行起来,先大概了解这个项目实现了哪些东西,这样才能让我们有针对性地学习。相反,如果我们还不清楚这个项目有哪些东西就开始研究源码,那我们肯定是要看得一头雾水了。

理架构

第三步,观察项目的结构,弄明白项目有哪些文件,它们在项目里的职责是什么。

以Java的经典架构为例,controller就是web层,负责数据的获取与转发;service层就是业务逻辑层,作为项目的核心部分;dao层就是数据持久层,负责处理数据库的操作......

把项目的架构理清楚,才能让我们对项目的整体有比较清楚的认知。

找核心

什么东西都有一个核心,项目也不例外。

现在的项目肯定少不了配置,这些配置如果不是我们所需要重点关注的就应该去忽略。

抓重点

要知道,许多开源项目都有不止一人进行开发和维护,同时随着时间的推移项目会变得越来越庞大,引用的技术也会越来越多,因此想要短时间内将整个项目完全掌握是很困难的,我们应该有所侧重。

例如,一个项目它分了前端和后端,我们如果只是想学习后端的技术,就可以把重心放在项目后台的业务逻辑上。

以上是我个人对学习开源项目的一些经验,实际上需要结合自身情况进行处理。

如有疏漏,还望海涵。