【commons-pool2源码】写前思考
写作的初衷
工作4年多, 一直没有系统的阅读过优秀的开源代码, 所以从今年开始做一些尝试, 阅读源码并且试着将自己的理解以文章的形式输出, 从而达到以下目的:
- 通过阅读源码提升自身的技术水准, 通过写作来巩固和加深理解.
- 希望给工作1-2年的同学带来一些启发.
- 希望遇到同频的人.
文章标准
在写作初期, 给文章制定了以下几项准标:
- 逻辑清晰, 并用大白话表达, 文章最重要的就是让人看懂.
- 分主次. 每篇文章应该有主要表达的观点, 以及文章所处的上下文环境, 做好必要的克制.
- 举例论证严谨, 丰富, 辅助理解.
第一个系列文章
【源码】系列的第一部作品选择了讲解Apache开源的commons-pool2. 开源库的选择上, 需要满足两点, 一是开源项目需要足够大牌, 注释够多, 被使用的够多. 二是该项目的依赖项足够少, 减少阅读初期带来的难度. 所以最终选择了commons-pool2.
但是执行过程遇到的问题. 源码类的文章写的太浅就变成了Javadoc. 首先写之前就得完整的阅读并理解项目, 写作之前就需要花很多时间整理, 然后才能动笔写, 再获得反馈进行调整, 整个闭环周期太长, 无法阶段性的获得正反馈, 导致焦虑的产生, 甚至导致最后放弃写作. 所以我就需要一个更具可行性的执行逻辑.
我将【源码】系列文章划分为4种状态.
- 思考状态. 用于记录在写作时遇到问题的思考或者根据反馈来的复盘.例如:
【commons-pool2源码】写前思考. - 准备状态. 记录一些在阅读源码过程中遇到的不了解的知识点. 但只是停留在对知识点的认识以及使用, 如果要深入则另开系列文章. 例如:
【commons-pool2源码】_pre JMX. - 进行状态. 系统性的写对源码的理解.例如:
【commons-pool2源码】_ing 对象状态详解. - 拓展状态. 主要看下当前项目在其他知名项目中的应用.例如:
【commons-pool2源码】_ex commons-pool2在Jedis中的应用.
按四种状态的方式执行写作, 在阅读源码初期遇到一些知识点就可以写, 不至于从开始阅读源码到进行状态之间都没有文章产出, 既可以锻炼写作的熟练度, 也能为真正写源码解析做更充足的准备.
