惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

Forbes - Security
Forbes - Security
L
Lohrmann on Cybersecurity
Simon Willison's Weblog
Simon Willison's Weblog
P
Proofpoint News Feed
P
Privacy International News Feed
The Hacker News
The Hacker News
AWS News Blog
AWS News Blog
S
Securelist
P
Proofpoint News Feed
Recent Announcements
Recent Announcements
GbyAI
GbyAI
B
Blog RSS Feed
A
About on SuperTechFans
C
CXSECURITY Database RSS Feed - CXSecurity.com
Y
Y Combinator Blog
Microsoft Azure Blog
Microsoft Azure Blog
H
Hackread – Cybersecurity News, Data Breaches, AI and More
Cyberwarzone
Cyberwarzone
I
Intezer
T
Tor Project blog
T
The Blog of Author Tim Ferriss
The GitHub Blog
The GitHub Blog
云风的 BLOG
云风的 BLOG
Recorded Future
Recorded Future
aimingoo的专栏
aimingoo的专栏
Cisco Talos Blog
Cisco Talos Blog
Cyber Security Advisories - MS-ISAC
Cyber Security Advisories - MS-ISAC
钛媒体:引领未来商业与生活新知
钛媒体:引领未来商业与生活新知
W
WeLiveSecurity
D
DataBreaches.Net
U
Unit 42
Project Zero
Project Zero
Martin Fowler
Martin Fowler
V
V2EX
The Last Watchdog
The Last Watchdog
Security Archives - TechRepublic
Security Archives - TechRepublic
C
Cisco Blogs
Threat Intelligence Blog | Flashpoint
Threat Intelligence Blog | Flashpoint
K
KPMG report finds enterprise disconnect between AI and its ROI | CIO
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
V2EX - 技术
V2EX - 技术
Hacker News - Newest:
Hacker News - Newest: "LLM"
T
Threat Research - Cisco Blogs
cs.CV updates on arXiv.org
cs.CV updates on arXiv.org
T
Tenable Blog
F
Full Disclosure
T
The Exploit Database - CXSecurity.com
H
Heimdal Security Blog
Latest news
Latest news
Webroot Blog
Webroot Blog

Jiajun的技术笔记

你好,2026! TiDB 源码阅读(六):TiDB Coprocessor 源码解析 性能优化的核心思想 TiDB 源码阅读(五):索引 TiDB 源码阅读(四):AST、逻辑计划、物理计划 CockroachDB Serverless Architecture podman 无故退出 Cursor Control-L (CTRL-L) Keyboard Shortcuts in Terminal Replace docker with podman Using xmonad with xfce4 A RC script for freebsd frpc 自己动手写一个k8s controller AI 会取代你的(编程)岗位吗? 自建DERP服务器提升Tailscale连接速度(使用Nginx转发) 自动升级Docker容器 再读《程序员修炼之道-从小工到专家》 让浏览器下载文件 再读《软件随想录》/《黑客与画家》/《软技能》 HTTP 压力测试中的 Coordinated Omission 2的补码 编程语言中的 context 是什么? flutter macOS 构建出错 Flatpak 使用小记 Golang CAS 操作是怎么实现的 PostgreSQL 当MQ来使用 Clash 结合 工作VPN 的网络设计 使用 PostgreSQL 搭建 JuiceFS PostgreSQL 配置优化和日志分析 有GitHub Copilot?那就可以搭建你的ChatGPT4服务 窗口函数的使用(以PG为例) 读《为什么学生不喜欢上学》 OpenAI Prompt Engineering 摘录和总结 读《打造真正的新产品》 VueJS 总结 Linux 自动挂载 alist 提供的webdav FreeBSD 使用 vm-bhyve 安装Debian虚拟机 FreeBSD 和 Linux 网卡聚合实现提速 GPT 帮我搞定了时区转换问题 长任务系统如何处理? macOS/Linux 编译 InputLeap 使用开源软KVM - synergy-core 解决 macOS 终端hostname一直变化问题 KVM 共享 Intel 集成显卡 PromQL 备忘 读《格鲁夫给经理人的第一课》 读《打开心智》 为什么要把复杂的联表操作拆成多个单表查询? 红包系统的设计 MySQL Index Condition Pushdown Optimization Go mod 简明教程 OpenWRT 使用 Android/iOS USB 网络 搭建旁路由 Golang gRPC 错误处理 编写可维护的单元测试代码 OAuth 2 详解(六):Authorization Code Flow with PKCE OAuth 2 详解(五):Device Authorization Flow OAuth 2 详解(三):Resource Owner Password Credentials Grant OAuth 2 详解(四):Client Credentials Flow OAuth 2 详解(二):Implict Grant Flow OAuth 2 详解(一):简介及 Authorization Code 模式 ElasticSearch 学习笔记 三种git流程以及发版模型 错误处理实践 权限模型(RBAC/ABAC) OIDC(OpenID Connect) 简介 任务队列简介 PostgreSQL 操作笔记 使用Drone CI构建CI/CD系统 Golang migrate 做数据库变更管理 使用PostgreSQL做搜索引擎 Nginx 源码阅读(三): 连接池、内存池 Nginx 源码阅读(二): 请求处理 Nginx 源码阅读(一): 启动流程 Go 泛型简明教程 KVM 显卡穿透给 Windows 使用 HTTP Router 处理 Telegram Bot 按钮回调 使用反射(reflect)对结构体赋值 GIN 是如何绑定参数的 你好 2022(2021 年终总结) 用Go导入大型CSV到PostgreSQL 使用 OpenWRT 搭建软路由 使用软KVM切换器 barrier 共享键鼠 SQL 防注入及原理 使用 gomock 测试 Go 代码 gevent不是黑魔法(二): gevent 实现 gevent不是黑魔法(一): greenlet 实现 用 entgo 替代 gorm 应用内使用crontab不是那么方便 单测时要不要 mock 数据库? Sentry 自建指南 用selenium完成自动化任务 用闲置的安卓手机做垃圾电话短信过滤 推荐三个时间管理工具 一次事故反思 当JS遇到uint64:JS整数溢出问题 SQLite3 存储以及ACID原理 Redis源码阅读:pub/sub实现 Redis源码阅读:zset实现 Redis源码阅读:bitmap 位图的运算 Redis源码阅读:set是怎么做交并集运算的?
如何阅读源代码
Jiajun Huang · 2018-08-04 · via Jiajun的技术笔记

如何阅读源代码

今天我们来简单的谈谈应该如何去阅读源代码。阅读源代码是每个程序员都要做的事情,毕竟成为master的先前一步, 就是 follow the master

学会如何使用

要想知道一个东西怎么实现的,我们首先要有一个大概的认知,例如,是什么,大概是怎么用的。所以我们需要先去熟悉这个项目,通常 我们可以这样做:

  • 读文档

阅读已有的,优秀的文档,可以加快了解整个项目的使用,坑和架构,这样可以快速建立起自己对该项目的认知。

  • 写demo

如果阅读的是一个库的代码呢?我们可以引用这个库,写一些简单的demo,这也是为了加快我们建立对项目的认知。

  • 熟悉如何使用

接下来要做的事情就是多写demo,多使用,当使用该项目到达一定程度的时候,就可以开始阅读源代码,而阅读源代码本身又可以促进 对项目的熟悉程度。但是,在什么时候应当开始阅读源代码,因人而异,并没有一个通用的度,而且会因为自身经验的积累而变化。 我个人建议当可以写出demo并且知道demo的每一行都在做什么的时候,就可以开始一边阅读源代码了,如果发现看不懂,则可以继续加深 对项目使用的熟悉程度,然后再次尝试。

通常注意,项目越大,开始阅读源代码所面临的难度其实会越高,一定要有信心。

接下来我们主要聊聊一些常用的阅读源代码的技巧。

从main函数入手

你的程序是怎么运行的?一定是从某个入口点(entrypoint)开始执行。例如 Python 可能是 if __name__ == "__main__" 或者 python 后面接的那个脚本名,例如 Go 通常是 main 函数,C亦然。如果是阅读一个已有的项目而非库,那么我们可以从入口函数开始跟踪代码, 看具体都做了一些什么,如果是一个库,那么我们可以从我们的demo的入口处开始跟踪源代码。

但是注意,从上而下和从下而上这两种阅读源代码的方法论,并没有哪一种更好,从上而下是从概貌到细节,从下而上是从实现细节到 概况。通常来说,都是结合两者,但是我个人通常以自上而下为主,了解了概貌之后,才会去了解具体的实现。

打断点

为了跟踪代码具体执行步骤,我们可以利用调试器,单步跟踪,这样我们可以看到每一步的执行。我个人并不是特别喜欢这种方式,因为 单步跟踪通常来说都会比较的细节化。例如阅读Go的runtime时,就可以用这种手法,在我们自己的main函数处打一个断点,然后单步跟踪 这样就可以看到runtime是如何进行初始化的。

打印调用栈

打印调用栈这是我最喜欢用的方式,因为我主要使用Go和Python,而这两门语言对打印调用栈这个操作都比较友好。通过调用栈,我们就可以 一眼看出函数是怎么从main函数到最后调用到栈顶的。例如阅读Flask的代码时,我们就可以在某个handler出直接把调用栈打印出来,可以 借助日志库,也可以借助调试器打印,然后我们就可以很轻易的看出程序都是如何从 app.run 一直到具体的handler的。

打印日志

有时候我们还可以借助日志来观察程序,根据日志可以大概看出程序都做了什么,根据日志的粒度可以从概貌和细节上都有不同程度的 了解。通常日志都会分成 DEBUG, INFO, WARN, ERROR, FATAL 五个级别。通常对于分布式应用,这是一种比较好用的调试和 了解执行顺序的方式。

合理使用跳转

跳转?编辑器用户可享受不到这种福利。那可不行,Vim作为强大的编辑器,可以通过YouCompleteMe或者是微软贡献的Languange Server Protocol来进行定义跳转。

阅读较为经典的代码(比较老旧的提交)

一个软件随着不断地演化,新功能的增加,bug的修复,通常会变的比较晦涩难懂,所以我们可以尝试从比较早的提交里开始阅读,比如 tag 0.1, tag 1.0, 最开始的10个提交之类的。比较早的提交通常是最简单的版本,但是同一个项目,万变不离其宗,这也是有利于 我们理解项目的。