《深入解析YARN架构设计与实现原理》第1章 环境准备【1.3】

javazx

1.3 搭建Hadoop源代码阅读环境
) O. g5 _0 [# v* y9 J8 I" e1.3.1 创建Hadoop工程
" @* x6 T4 q2 U5 ^3 ]本节将介绍如何创建一个Hadoop源代码工程以方便阅读源代码。 总体上说， 目前存在两种Hadoop源代码阅读环境搭建方法， 分别是构建Maven工程和构
建Java工程。 两种方法各有利弊： 前者可通过网络自动下载依赖的第三方库， 但源代码会被分散到多个工程中进而带来阅读上的不便； 后者可将所有源代码
: K$ a4 j# p8 b' A组织在一个工程中， 但需要自己添加依赖的第三方库， 大家可根据自己的喜好选择一种方法。 本节将依次介绍这两种方法。
" X" p7 h2 t' x: b（ 1） 构建Maven工程
# c# X7 y5 e2 b5 J' F  T通过Maven工程搭建Hadoop源代码阅读环境的步骤如下：
$ C1 V& o; [/ Y% _. q步骤1 解压缩Hadoop源代码。
将下载到的Hadoop源代码压缩包解压到工作目录下， 比如hadoop-2.0-src.tar.gz（ 注意， 为了方便， 此处直接使用版本号2.0， 实际下载到的源代码版本号
$ K9 b4 Z  r. @: w: c并不是这样的， 可能是2.2.0， 这样压缩包的名字实际为hadoop-2.2.0-src.tar.gz） 。
6 f. S6 f/ h) k步骤2 导入Maven工程。
在Eclipse中， 依次选择"File"→"Import"→"Maven"→"Existing Maven Project"， 在弹出的对话框中的"Root Directory"后面， 选择Java源代码所在的目录。
: D) Z* J  b5 x  w8 R单击"Next"按钮， 在弹出的对话框中选择"Resolve All Later"， 并单击"Finish"按钮完成Maven项目导入。 之后， Eclipse会自动通过网络从Maven库中下载依赖
的第三方库（ JAR包等） 。 注意， 你所使用的电脑必须能够联网。
& F) C. D  j# F7 g+ j1 U  s2 W将Hadoop 2.0源代码导入Maven项目后， 会生成50个左右的工程， 这些都是通过Maven构建出来的， 每个工程是一个代码模块， 且彼此相对独立， 可以单
/ c: R' |0 y2 l+ v4 y6 s8 }% g! S2 n独编译。 你可以在某个工程下的"src/main/java"目录下查看对应的源代码。
（ 2） 构建Java工程
通过Java工程搭建Hadoop源代码阅读环境的步骤如下：
步骤1 解压缩Hadoop源代码。
同“构建Maven工程”中的步骤1类似。
6 h8 x" P! d! ~: C步骤2 新建Java工程。
, h+ \* h6 V) C" {) E5 m' V打开Eclipse， 进入Eclipse可视化界面后， 如图1-1所示， 依次单击"File"→"New"→"Java Project"， 并在弹出的对话框中去掉"Use default location"前的勾号， 然
后选择Hadoop安装目录的位置， 默认情况下， 工程名称与Hadoop安装目录名称相同， 用户可自行修改。 单击“完成”按钮， Hadoop源代码工程创建完毕。
图1-1 新建Hadoop工程
回到Eclipse主界面后， 打开新建的Hadoop工程， 可看到整个工程按图1-2所示组织代码： 按目录组织源代码， 且每个目录下以JAR包为单位显示各个Java
  R9 z8 j" d+ x) e文件。
图1-2 Hadoop工程展示（ 部分） 源代码方式
6 ~( {; e8 y& J% O除了使用源代码压缩包导入Eclipse工程的方法外， 读者可也尝试直接从Hadoop SVN上导入Hadoop源代码。
需要注意的是， 通过以上方法导入Hadoop 2.0源代码后， 很多类或者方法找不到对应的JAR包， 为了解决这个问题， 你需要将第三方JAR包导入工程中，
/ t) R7 ]+ L) J; q. ^2 }' z如图1-3所示， 方法如下： 解压存放JAR包的压缩包， 然后右击Project名称， 在弹出的快捷菜单中选择"Properties"命令， 将会弹出一个界面， 然后在该界面中
依次选择"Java Build Path"→"Libraries"→"Add External JARs..."， 将解压目录中share/hadoop目录下各个子目录中lib文件夹下的JAR包导入工程。
前面提到CDH版本将源代码和JAR包放到了一起， 因此， 如果使用CDH版本， 则直接按照上述方法将源代码导入Eclipse工程即可。
细心的读者在阅读源代码过程中仍会发现部分类或者函数无法找到， 这是因为Hadoop 2.0使用了Protocol Buffers定义了RPC协议， 而这些Protocol Buffers文
件在Maven编译源代码时才会生成对应的Java类， 因此若其他类在源代码中引用这些类则暂时无法找到， 解决方法是先编译Hadoop 2.0源代码再倒入Eclipse工
程， 具体方法如下（ 注意， 进行以下步骤之前， 需先完成1.6.1节中的准备工作） 。
首先， 使用以下命令安装Elicpse插件hadoop-maven-plugins：
- ?, e4 U# b: d7 \5 d5 m! v图1-3 导入依赖的第三方JAR包
$ cd ${HADOOP_HOME}/hadoop-maven-plugins
2 s8 B9 l: P% k7 p! d$ mvn install
然后生成Eclipse工程文件：
$ cd ${HADOOP_HOME}
$ mvn eclipse:eclipse -DskipTests
7 C$ Y* W  D5 l" U最后在Eclipse中按照以下流程导入源代码： "File"→"Import"→"Existing Projects into Workspace"。
1.3.2 Hadoop源代码阅读技巧
0 B( O9 q2 f) G2 V3 _( ]* C, V本节介绍在Eclipse下阅读Hadoop源代码的一些技巧， 比如： 如何查看一个基类有哪些派生类， 一个方法被其他哪些方法调用等。
（ 1） 查看一个基类或接口的派生类或实现类
8 J8 t$ n" U* j9 \  Z6 `% [在Eclipse中， 选中某个基类或接口名称， 右击， 在弹出的快捷菜单中选择"Quick Type Hierarchy"， 可在新窗口中看到对应的所有派生类或实现类。
例如， 如图1-4所示， 打开hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java目录下org.apache.hadoop.mapred包中的
InputFormat.java文件， 查看接口InputFormat的所有实现类， 结果如图1-5所示。
6 V; ~/ n, @# p4 `8 S+ \! _  W) L（ 2） 查看函数的调用关系
在Eclipse中， 选中某个方法名称， 右击， 在弹出的快捷菜单中选择"Open Call Hierarchy"， 可在窗口"Call Hierarchy"中看到所有调用该方法的函数。
5 U% x! S9 x1 B& `图1-4 在Eclipse中查看Hadoop源代码中接口InputFormat的所有实现类
" ?( D' |; M! ?. w# J3 N图1-5 Eclipse列出接口InputFormat的所有实现类
0 L! K; d4 |% `7 L6 F/ k' a7 M例如， 如图1-6所示， 打开hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java目录下org.apache.hadoop.mapred包中的
Task.java文件， 查看调用getJobID方法的所有函数， 结果如图1-7所示。
图1-6 在Eclipse中查看Hadoop源代码中所有调用Task.java中getJobID方法的函数
图1-7 Eclipse列出所有调用getJobID方法的函数
（ 3） 快速查找类对象的相关信息
5 Z; Z# b1 j- S与前两个小节类似， 选中类对象， 右击， 在弹出的快捷菜单中选择"Open Declaration"， 可跳转到类定义； 选择"Quick Outline"， 可查看类所有的成员变量
& D0 z: k) q6 ~和成员方法， 具体细节在此不做详细介绍， 读者自行尝试。  

$ N# [' J5 M: E6 V4 X
3 B9 A1 F& {7 V) t4 l4 M2 j