Zookeeper源码分析(一)-源码阅读环境搭建

背景

本文介绍如何在idea上搭建源码阅读环境,环境搭建成功后可以在源码上增加注释,便于学习并可供日后多次阅读

fork源代码

1. 首先从github上forkapache/zookeeper到自己的远程仓库中
2. 从远程仓库中将代码git clone到本地

注意,不要直接git clone apache/zookeeper的源码,而要先将源码fork到远程仓库,再从远程仓库克隆代码,因为zookeeper的源码我们没有push权限,即使日后修改了源码也不能push到apache/zookeeper的远程仓库,但是如果apache/zookeeper的源码修改了,我们如何才能获取到的最新的代码呢?详见同步一个 fork,步骤如下

1. 给fork配置一个remote
   git remote add upstream https://github.com/apache/zookeeper.git
2. 从上游仓库 fetch 分支和提交点，传送到本地，并会被存储在一个本地分支 upstream/master
   git fetch upstream
3. 把 upstream/master 分支合并到本地 master 上，这样就完成了同步，并且不会丢掉本地修改的内容。
   git merge upstream/master
4. 将合并后的内容更新到github的fork上
   git push origin master

编译

最头疼的地方就是编译,zookeeper使用ant进行编译,而我一直使用的是maven,趁着这个机会也学习了一下ant,虽然下面两个步骤就可以将ZooKeeper编译为eclipse项目后导入idea,但是建议学习下ant和ivy的知识,这样下次遇到用ant编译的项目也会上手快一点,学习之后发现ant虽然麻烦点,但功能非常强大.

1. 使用ant对源码编译成eclipse工程
   ant eclipse
2. 通过idea导入eclipse工程
   

总结

执行上述两步后,源码阅读环境已经搭建完毕,接下来就可以进行源码的学习了,可以尽情的在源码上编写注释.

参考

• Zookeeper源码分析（一） —– 源码运行环境搭建
• 【Zookeeper源码一】Zookeeper 源码环境搭建
• 同步一个 fork
• 常用 Git 命令清单
• 廖雪峰官方教程