HDFS 常用命令与 Java API 编程实践

二、HDFS 的 Web 页面

在配置好 Hadoop 集群之后，可以通过浏览器登录'http://[NameNodeIP]:9870'访问 HDFS，其中， [NameNodeIP] 表示名称节点的 IP 地址。例如我们在本地机器上完成 Hadoop 伪分布式安装后，可以登录'http://localhost:9870'来查看文件系统信息。

通过该 Web 页面，我们可以查看当前文件系统中各个节点的分布信息，浏览名称节点上的存储、登录等日志，以及下载某个数据节点上某个文件。该 Web 页面的所有功能都能通过 Hadoop 提供的 Shell 命令或者 Java API 来等价实现。例如通过 Web 页面中的'Browse the filesystem'查看目录。我们也可以通过如下命令实现同样的功能：

hadoop fs -ls/

三、HDFS 常用 Java API 及应用实例

Hadoop 主要是使用 Java 语言编写实现的，Hadoop 不同的文件系统之间通过调用 Java API 进行交互。上面介绍的 Shell 命令，本质上就是 Java API 的应用。这里将介绍 HDFS 中进行文件上传、复制、下载等操作常用的 Java API 及其编程实例。

（一）常用 Java API 介绍

HDFS 编程的主要 Java API 如下。

• org.apache.hadoop.fs.FileSystem。一个通用文件系统的抽象基类，可以被分布式文件系统继承。所有可能使用 Hadoop 文件系统的代码都要使用到这个类。Hadoop 为 FileSystem 这个抽象类提供了多种具体的实现，如 LocalFileSystem、DistributedFileSystem、HftpFileSystem、HsftpFileSystem、HarFileSystem、KosmosFileSystem、FtpFileSystem 和 NativeS3FileSystem 等。
• org.apache.hadoop.fs.FileStatus。一个接口，用于向客户端展示系统中文件和目录的元数据，具体包括文件大小、块大小、副本信息、所有者、修改时间等，可通过 FileSystem.listStatus() 方法获得具体的实例对象。
• org.apache.hadoop.fs.FSDataInputStream。文件输入流，用于读取 Hadoop 文件。
• org.apache.hadoop.fs.FSDataOutputStream。文件输出流，用于写 Hadoop 文件。
• org.apache.hadoop.conf.Configuration。访问配置项。所有的配置项的值，如果在 core-site.xml 中有对应的配置，则以 core-site.xml 为准。
• org.apache.hadoop.fs.Path。用于表示 Hadoop 文件系统中的一个文件或者一个目录的路径。
• org.apache.hadoop.fs.PathFilter。一个接口，通过实现方法 PathFilter.accept(Path path) 来判定是否接收路径 path 表示的文件或目录。

（二）应用实例

接下来通过一个简单的实例介绍上述 Java API 的使用方法。

1. 在 Eclipse 中创建项目

启动 Eclipse。当 Eclipse 启动以后，会弹出界面提示设置工作空间（workspace）。可以直接采用默认的设置'/home/hadoop/workspace'，点击'Launch'按钮。可以看出，由于当前是采用 hadoop 用户登录了 Linux 系统，因此，默认的工作空间目录位于 hadoop 用户目录'/home/hadoop'。Eclipse 启动以后，会呈现主界面。

选择'File->New->Java Project'菜单，开始创建一个 Java 工程。在'Project name'后面输入工程名称'HDFSExample'。选中'Use default location'，让这个 Java 工程的所有文件都保存到'/home/hadoop/workspace/HDFSExample'目录下。在'JRE'这个选项卡中，可以选择当前的 Linux 系统中已经安装好的 JDK，比如 jdk1.8.0_371。然后，点击界面底部的'Next>'按钮，进入下一步的设置。

2. 为项目添加需要用到的 JAR 包

需要在这个界面中加载该 Java 工程所需要用到的 JAR 包，这些 JAR 包中包含了可以访问 HDFS 的 Java API。这些 JAR 包都位于 Linux 系统的 Hadoop 安装目录下。对于本文而言，就是在'/usr/local/hadoop/share/hadoop'目录下。点击界面中的'Libraries'选项卡。点击界面右侧的'Add External JARs…'按钮。

在该界面中，为了编写一个能够与 HDFS 交互的 Java 应用程序，一般需要向 Java 工程中添加以下 JAR 包：

• '/usr/local/hadoop/share/hadoop/common'目录下的所有 JAR 包，包括 hadoop-common-3.3.5.jar、hadoop-common-3.3.5-tests.jar、haoop-nfs-3.3.5.jar、haoop-kms-3.3.5.jar 和 hadoop-registry-3.3.5.jar，注意，不包括目录 jdiff、lib、sources 和 webapps；
• '/usr/local/hadoop/share/hadoop/common/lib'目录下的所有 JAR 包；
• '/usr/local/hadoop/share/hadoop/hdfs'目录下的所有 JAR 包，注意，不包括目录 jdiff、lib、sources 和 webapps；
• '/usr/local/hadoop/share/hadoop/hdfs/lib'目录下的所有 JAR 包。

全部添加完毕以后，就可以点击界面右下角的'Finish'按钮，完成 Java 工程 HDFSExample 的创建。

3. 编写 Java 应用程序

下面编写一个 Java 应用程序，用来检测 HDFS 中是否存在一个文件。

请在 Eclipse 工作界面左侧的'Package Explorer'面板中，找到刚才创建好的工程名称'HDFSExample'。然后在该工程名称上点击鼠标右键，在弹出的菜单中选择'New Class'菜单。

在该界面中，只需要在'Name'后面输入新建的 Java 类文件的名称，这里采用名称'MergeFile'，其他都可以采用默认设置。然后，点击界面右下角'Finish'按钮。

Eclipse 自动创建了一个名为'MergeFile.java'的源代码文件，请在该文件中输入以下代码：

import java.io.IOException;
import java.io.PrintStream;
import java.net.URI;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.*;

/**
 * 过滤掉文件名满足特定条件的文件
 */
class MyPathFilter implements PathFilter {
    String reg = null;

    MyPathFilter(String reg) {
        this.reg = reg;
    }

    public boolean accept(Path path) {
        if (!(path.toString().matches(reg))) return true;
        return false;
    }
}

/**
 * 利用 FSDataOutputStream 和 FSDataInputStream 合并 HDFS 中的文件
 */
public class MergeFile {
    Path inputPath = null; // 待合并的文件所在的目录的路径
    Path outputPath = null; // 输出文件的路径

    public MergeFile(String input, String output) {
        this.inputPath = new Path(input);
        this.outputPath = new Path(output);
    }

    public void doMerge() throws IOException {
        Configuration conf = new Configuration();
        conf.set("fs.defaultFS", "hdfs://localhost:9000");
        conf.set("fs.hdfs.impl", "org.apache.hadoop.hdfs.DistributedFileSystem");
        FileSystem fsSource = FileSystem.get(URI.create(inputPath.toString()), conf);
        FileSystem fsDst = FileSystem.get(URI.create(outputPath.toString()), conf);
        // 下面过滤掉输入目录中后缀为.abc 的文件
        FileStatus[] sourceStatus = fsSource.listStatus(inputPath, new MyPathFilter(".*\\.abc"));
        FSDataOutputStream fsdos = fsDst.create(outputPath);
        PrintStream ps = new PrintStream(System.out);
        // 下面分别读取过滤之后的每个文件的内容，并输出到同一个文件中
        for (FileStatus sta : sourceStatus) {
            // 下面打印后缀不为.abc 的文件的路径、文件大小
            System.out.print("路径：" + sta.getPath() + " 文件大小：" + sta.getLen() + " 权限：" + sta.getPermission() + " 内容：");
            FSDataInputStream fsdis = fsSource.open(sta.getPath());
            byte[] data = new byte[1024];
            int read = -1;
            while ((read = fsdis.read(data)) > 0) {
                ps.write(data, 0, read);
                fsdos.write(data, 0, read);
            }
            fsdis.close();
        }
        ps.close();
        fsdos.close();
    }

    public static void main(String[] args) throws IOException {
        MergeFile merge = new MergeFile("hdfs://localhost:9000/user/hadoop/", "hdfs://localhost:9000/user/hadoop/merge.txt");
        merge.doMerge();
    }
}

4. 编译运行程序

在开始编译运行程序之前，请一定确保 Hadoop 已经启动运行。然后，要确保 HDFS 的'/user/hadoop'目录下已经存在 file1.txt、file2.txt、file3.txt、file4.abc 和 file5.abc，每个文件里面有内容。这里，假设文件内容如下表所示。

现在就可以编译运行上面编写的代码。可以直接点击 Eclipse 工作界面上部的运行程序的快捷按钮。当把鼠标移动到该按钮上时，在弹出的菜单中选择'Run As'，继续在弹出来的菜单中选择'Java Application'。

在该界面中，点击界面右下角的'OK'按钮，开始运行程序。程序运行结束后，会在底部的'Console'面板中显示运行结果信息。同时，'Console'面板中还会显示一些类似'log4j:WARN…'的警告信息，可以不用理会。

如果程序运行成功，这时，可以到 HDFS 中查看生成的 merge.txt 文件，比如，可以在 Linux 终端中执行如下命令：

cd /usr/local/hadoop
./bin/hdfs dfs -ls /user/hadoop
./bin/hdfs dfs -cat /user/hadoop/merge.txt

可以看到如下结果：

this is file1.txt this is file2.txt this is file3.txt 

5. 应用程序的部署

下面介绍如何把 Java 应用程序生成 JAR 包，部署到 Hadoop 平台上运行。

在 Hadoop 安装目录下新建一个名称为 myapp 的目录，用来存放我们自己编写的 Hadoop 应用程序，可以在 Linux 的终端中执行如下命令：

cd /usr/local/hadoop
mkdir myapp

请在 Eclipse 工作界面左侧的'Package Explorer'面板中，在工程名称'HDFSExample'上点击鼠标右键，在弹出的菜单中选择'Export'。

在该界面中，选择'Runnable JAR file'，然后，点击'Next>'按钮。

在该界面中，'Launch configuration'用于设置生成的 JAR 包被部署启动时运行的主类，需要在下拉列表中选择刚才配置的类'MergeFile-HDFSExample'。在'Export destination'中需要设置 JAR 包要输出保存到哪个目录，比如，这里设置为'/usr/local/hadoop/myapp/HDFSExample.jar'。在'Library handling'下面选择'Extract required libraries into generated JAR'。然后，点击'Finish'按钮。

可以忽略该界面的信息，直接点击界面右下角的'OK'按钮，启动打包过程。打包过程结束后，会出现一个警告信息界面，可以忽略该界面的信息，直接点击界面右下角的'OK'按钮。至此，已经顺利把 HDFSExample 工程打包生成了 HDFSExample.jar。可以到 Linux 系统中查看一下生成的 HDFSExample.jar 文件，可以在 Linux 的终端中执行如下命令：

cd /usr/local/hadoop/myapp
ls

可以看到，'/usr/local/hadoop/myapp'目录下已经存在一个 HDFSExample.jar 文件。

由于之前已经运行过一次程序，已经生成了 merge.txt，因此，需要首先执行如下命令删除该文件：

cd /usr/local/hadoop
./bin/hdfs dfs -rm /user/hadoop/merge.txt

现在，就可以在 Linux 系统中，使用 hadoop jar 命令运行程序，命令如下：

cd /usr/local/hadoop
./bin/hadoop jar ./myapp/HDFSExample.jar

上面程序执行结束以后，可以到 HDFS 中查看生成的 merge.txt 文件，比如，可以在 Linux 终端中执行如下命令：

cd /usr/local/hadoop
./bin/hdfs dfs -ls /user/hadoop
./bin/hdfs dfs -cat /user/hadoop/merge.txt

可以看到如下结果：

this is file1.txt this is file2.txt this is file3.txt 

总结

本文详细介绍了在 Linux 操作系统中使用 HDFS 的常用方法，包括通过 Shell 命令操作 HDFS，通过 Web 页面查看和管理 HDFS，以及使用 Java API 进行 HDFS 文件操作。对于 Shell 命令，介绍了 hadoop fs、hadoop dfs 和 hdfs dfs 三种方式，并列出了常用的文件操作命令如 ls、cat、mkdir、cp、mv、rm 等。通过 Web 页面，可以直观地查看和管理 HDFS 文件系统。对于 Java API，介绍了主要的类如 FileSystem、FileStatus、FSDataInputStream 和 FSDataOutputStream，并提供了一个合并 HDFS 文件的实例，详细讲解了从创建项目、添加 JAR 包、编写代码到部署运行的整个过程。