微信号:tomcat0000

介绍:由从事应用服务器核心研发的工程师维护.文章深入Tomcat源码,分析应用服务器的实现细节,工作原理.以及与之相关的技术,使用技巧,工作实战等.起于Tomcat,但不止于此.同时会分享JVM、并发等,内容多为原创...

怎样阅读源代码?

2016-04-26 23:34 侯树成


软件工程师磨炼技艺的方式有许多,而读优秀项目的源码,是这些方式中学习其他人的经验和方法,快速进步的很重要一种方式。古人云:


独学而无友,则必孤陋寡闻!


读优秀的源码,就如同和高手交谈,无形中有胜过若干书的感觉。在代码中,我们能看到高手对于软件的设计,代码的组织,变量和方法的方法的命名,甚至通过多个版本能观察到作者对于项目不同时期的思考,对问题的修订方式,或者注释中流露出的幽默!


前面的文章中,我们提到过一般项目调试环境的搭建(感兴趣的看这里怎样调试Tomcat源码)。


环境搭好之后,一切就绪,剩下的就是深入源码了。我们今天来谈关于源代码的阅读。


以下是我个人对于源码阅读的一些体会,欢迎朋友们在文末留言交流!


首先,源码的阅读是以目的为导向的不同的目的决定了阅读源码的方式的不同。

例如,为了解决某个使用某个框架中存在的问题,你可能会从问题的出发点,逐步深入到相关的类与方法,而在解决了问题之后,可能就不会有兴趣再把夫关的代码再读下去了。


而如果是以深入分析某个软件的原理这个点出发,则会对软件的各个部分都有兴趣,从而深入各个模块,分析实现。


还有些时候,是为了特定的目的,比如为了针对面试中可能遇到的源码问题,会看一下HashMap,ArrayList等JDK源码的实现。


就我个人而言,这几种情形也都遇到过。当时在使用Spring data jpa的时候,框架的某个特定版本,对于@Column这个注解,如果只指定了length,而没有指定对应的name,这个时候,生成的sql就会有问题。为了解决这个问题读过这部分相关的源码。


而之前由于从事应用服务器的开发,所以需要了解应用服务器的运行原理,就需要深入下去,去读开源的应用服务器实现,像GlassFish/Jetty/Tomcat这些,当然,看的最多的还是Tomcat。


还有一次,在开发一个应用服务器监控应用的时候,为了通过MBean Server来获取对应服务器的监控数据,需要attach到相应的JVM上。我们的一个老的版本并没有提供对应的MBean Server的JMXURL,这个时候,观察到JConsole可以通过某个JVM进程,直接attach到这个进程上,并不需要url,为了学习和使用这种实现方式,从OpenJDK中把JConsole的源码找了出来。一读才发了解了,原来是JVM自带的attach机制,通过VirtualMachine连接上去。这JVM的进程,是通过指定的temp.dir中的pid文件来获取的,阅读源码后,让功能的实现更快速清楚。


以上是从阅读源码的不同目的来看源码的阅读,读源码的方式,到底要怎么读下去呢?


还是接着上面的目的来说,只关心某个类或实现方式,可以找特定范围内的内容进行阅读即可。而对于想深入了解某一类的软件的运行及实现原理时,就需要按功能主线进行入手,不能眉毛胡子一把抓。


例如读Tomcat的源码时,启动流程是一条线,部署流程是一条线,请求响应是另一条线。抓住一条线后,进行阅读,但此时不需要特别深入每一个细节,先把主要的点把握住之后,再深入一条线中的某个线段。例如启动的时候其实也会涉及到应用的部署,也会涉及到应用的类加载器,甚至是配置文件的解析,多个配置文件的merge等。

而请求响应时,又会涉及到参数的解析,对于不同请求后缀的响应处理,请求资源的初始化等。


点会有很多,在有了大致思路后,再深入各个点,最终各个点会相互促进理解,多个点连成一条线。


其次,源码的阅读,也是磨炼调试技巧的过程。在阅读源码的过程中,为了从某个功能点来深入一条线的流程,就需要各种加断点,debug,增加log,画图等,各种调试手段的综合使用,更能快速流畅的读源码。


最后,源码的文档、单测都是很好的下手材料。当拿到一堆代码不知道从何入手时,可以先看看文档,或者直接从单测入手。单测中以更细粒度的功能点组织,可以快速看到某个功能相关的类。


欢迎留言交流!


文本福利

对于Tomcat的源码阅读,官方的文档里提供了几个有用的材料,具体在这里:


TOMCAT_HOME\webapps\docs\architecture


目录内,包含启动流程和请求处理的流程,想深入阅读的朋友可以直接看这个,虽然还是老版本的,但整体流程并没有改变,可以辅助阅读。





题图:Apache License2 信息截图








Tomcat那些事儿

本公众号由从事应用服务器核心研发的工程师维护。文章深入Tomcat源码,分析应用服务器的实现细节,工作原理及与之相关的技术,使用技巧,工作实战等。起于Tomcat但不止于此。同时会分享并发、JVM等,内容多为原创,欢迎关注。


扫描或长按下方二维码,即可关注!




 
Tomcat那些事儿 更多文章 谁是Tomcat? 干嘛的? Tomcat 与Apache/Nginx有啥区别? 透过Tomcat配置认识其内部组件 如何加入Tomcat邮件组和开发者对话? 你可能不知道的几个java小工具
猜您喜欢 听说你需要一个云笔记,正好我们这里有一个 35行代码搞定事件研究法(下) 100offer的坚持:年轻人挑工作 腾讯资深FPS策划分享:解密FPS PVE设计(BOSS篇) 听播客:一边学Python编程 一边学英语