Hadoop-0.20.2源码学习（4）——初见Main函数及打印package信息

最新推荐文章于 2021-11-12 09:36:12 发布

周五见

最新推荐文章于 2021-11-12 09:36:12 发布

阅读量222

点赞数

分类专栏：大数据实践学习

大数据实践学习专栏收录该内容

21 篇文章 4 订阅

订阅专栏

参考： JeffreyZhou的博客园
《Hadoop权威指南》第四版

4.1 main函数概览

根据前一节中整理的main函数位置，我们先大概的打开main函数看一下。

NameNode.java中的main函数：

public static void main(String args[]) {
    try {
      StringUtils.startupShutdownMessage(NameNode.class, args, LOG);
      NameNode namenode = createNameNode(args, null); //NameNode中类型换成NameNode
      if (NameNode != null)
        NameNode.join();
    } catch (Throwable e) {
      LOG.error(StringUtils.stringifyException(e));
      System.exit(-1);
    }
  }

DataNode.java中的main函数：

public static void main(String args[]) {
    try {
      StringUtils.startupShutdownMessage(DataNode.class, args, LOG);
      DataNode datanode = createDataNode(args, null); //NameNode中类型换成NameNode
      if (datanode != null)
        datanode.join();
    } catch (Throwable e) {
      LOG.error(StringUtils.stringifyException(e));
      System.exit(-1);
    }
  }

很明显的可以看到，他俩形式差不多，按照这些字面意思，是先对开启和关闭的信息进行记录和log操作，再创建一个Node，如果不为空，则将该线程join()，然后捕获异常。

不知道 join() 方法的同学可以自己去查一查，大概用处就是：
如果在线程A中调用了线程B的 join() 方法，知道线程B执行完毕后，才会继续执行线程A，而不是正常的无序分片运行。

4.2 打印包信息

可以尝试的单步调试，运行第一句，就可以发现，控制台输出了一些信息（参考来源中盗的图）：

在这里插入图片描述
运行每一个程序时，头上都会在控制台或日志文件中输出这一段话。信息内容主要是描述启动了哪个类，主机，参数，版本，以及编译信息。

那么就来看看这个信息是咋来的吧。

在eclipse中，选中函数，按F3键，就会跳转到对应的函数定义中去。

4.3 startupShutdownMessage函数

进入StringUtils.startupShutdownMessage类中：

public static void startupShutdownMessage(Class<?> clazz, String[] args,
                                     final org.apache.commons.logging.Log LOG) {
    final String hostname = getHostname();
    final String classname = clazz.getSimpleName();
    LOG.info(
        toStartupShutdownString("STARTUP_MSG: ", new String[] {
            "Starting " + classname,
            " host = " + hostname,
            " args = " + Arrays.asList(args),
            " version = " + VersionInfo.getVersion(),
            " build = " + VersionInfo.getUrl() + " -r "
                         + VersionInfo.getRevision()
                         + "; compiled by '" + VersionInfo.getUser()
                         + "' on " + VersionInfo.getDate()}
        )
      );
 
    Runtime.getRuntime().addShutdownHook(new Thread() {
      public void run() {
        LOG.info(toStartupShutdownString("SHUTDOWN_MSG: ", new String[]{
          "Shutting down " + classname + " at " + hostname}));
      }
    });
  }

这里的LOG.info()是用log4j组件（日志写入组件）进行了输出，，然后就是直接获取类名（classname）、主机（hostname）、参数（args），问题不大。

中间碰到的Version.getXxx()函数待会再讲。

往下捋，可以看到getRuntime().addShutdownHook()函数，这里是在进程上加了一个勾子，来捕获关闭事件，然后在关闭时，可以输出关闭信息，毕竟人家白纸黑字写的是“Shutting down”。

（同学可以自己试一下，在控制台运行，然后按Ctrl+C停止，我这里就直接盗图来用了…）：

4.4 VersionInfo类

好，刚才跳过的那几行代码，中间都是调用的Version.getXxx()函数，那么这个到底是啥呢，打开来看看（这真是自己的图了，毕竟远程连接不容易，谅解哈）。

在这里插入图片描述

可以看到，这里使用了一个叫HadoopVersionAnnotation的注解。

关于java中自定义annotation的介绍，见本文后记

那就顺藤摸瓜，去看看这个HadoopVersionAnnotation是啥吧。

4.5 HadoopVersionAnnatation接口

在这里插入图片描述

可以看到第18行，包为 org.apache.hadoop，这就是此Annatation所附加的包，去打开看看，有surprise。

在这里插入图片描述

看路径，找到这个包目录下，有一个package-info.java的文件，看里面是不是就是我们想要的信息。

// 该注解的生命周期---运行周期内
@Retention(RetentionPolicy.RUNTIME)
// 所修饰的对象范围---附加在 包（package）上
@Target(ElementType.PACKAGE)

还有一点问题，这个package-info.java文件是哪来的呢？

4.6 saveVersion.sh文件

打开hadoop/src文件夹，可以看到一个saveVersion.sh文件

在这里插入图片描述

对源码进行编译时，就是通过这个文件，得到的package-info.java文件。

4.x 后记

总结一下，关于比较混乱的 MSG 的思路。

在这里插入图片描述

4.x.1 java中的Annotation简介

原文：https://blog.csdn.net/qq496013218/article/details/69258247

@Target

@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了@Target可更加明晰其修饰的目标。

@Target作用：用于描述注解的使用范围，即被描述的注解可以用在什么地方

@Target取值(ElementType)

CONSTRUCTOR：用于描述构造器
FIELD：用于描述域
LOCAL_VARIABLE：用于描述局部变量
METHOD：用于描述方法
PACKAGE：用于描述包
PARAMETER：用于描述参数
TYPE：用于描述类、接口(包括注解类型) 或enum声明
@Retention
@Retention定义了该Annotation的生命周期：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。@Retention有唯一的value作为成员。

@Retention

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

@Retention取值来自java.lang.annotation.RetentionPolicy的枚举类型值

SOURCE:在源文件中有效（即源文件保留）
CLASS:在class文件中有效（即class保留）
RUNTIME:在运行时有效（即运行时保留）

@Documented

用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。@Documented是一个标记注解，没有成员。

@Inherited
是一个标记注解。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个Annotation将被用于该class的子类。

自定义Annotation

实际项目中，经常会碰到下面这种场景，一个接口的实现类或者抽象类的子类很多，经常需要根据不同情况（比如根据配置文件）实例化并使用不同的子类。典型的例子是结合工厂使用职责链模式。
此时，可以为每个实现类加上特定的Annotation，并在Annotation中给该类取一个标识符，应用程序可通过该标识符来判断应该实例化哪个子类。

示例：

/**
 * 定义一个Annotation
 */
public @interface Login { 

}

class LoginTest{
    /**
     * 使用Annotation
     */
    @Login
　　 public void login(){
      
    }
}

Annotation与Interface的异同

Annotation类型使用关键字@interface而非interface。注意开头的@符号
Annotataion的方法定义是受限制的。其方法必须声明为无参数、无异常抛出的。这些方法同时也定义了Annotation的成员——方法名即为成员名，而方法返回类型即为成员类型。方法返回类型必须为Java基础类型、Class类型、枚举类型、Annotation类型或者相应的一维数组。方法后面可以使用default关键字和一个默认数值来声明成员的默认值，null不能作为成员默认值。成员一般不能是泛型，只有当其类型是Class时可以使用泛型，因为此方法能够用类型转换将各种类型转换为Class
Annotation和interface都可以定义常量、静态成员类型，也都可以被实现或者继承。