mac系统上hdfs java api的简单使用

逃离我推掉我的手 2024-03-26 16:13 36阅读 0赞

#### 文章目录 ####

*  1、背景
 *  2、环境准备
 *  3、环境搭建
 *   *  3.1 引入jar包
     *  3.2 引入log4j.properties配置文件
     *  3.3 初始化Hadoop Api
 *  4、java api操作
 *   *  4.1 创建目录
     *  4.2 上传文件
     *  4.3 列出目录下有哪些文件
     *  4.4 下载文件
     *  4.5 删除文件
     *  4.6 检测文件是否存在
 *  5、完整代码

## 1、背景 ##

在上一节中，我们简单学习了在命令行上如何操作`hdfs shell api`，此处我们通过`java`程序来操作一下。

## 2、环境准备 ##

1.  需要在本地环境变量中 配置 `HADOOP_HOME` 或在程序启动的时候通过命令行指定`hadoop.home.dir`的值，值为HADOOP的home目录地址。可通过`org.apache.hadoop.util.Shell#checkHadoopHome`方法验证。
2.  我们的`HADOOP`最好是`自己在本地系统进行重新编译`，不然可能运行部分`java api`会出现问题。

## 3、环境搭建 ##

### 3.1 引入jar包 ###

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.junit</groupId>
                <artifactId>junit-bom</artifactId>
                <version>5.7.1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.apache.hadoop</groupId>
            <artifactId>hadoop-client</artifactId>
            <version>3.3.4</version>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter</artifactId>
            <scope>test</scope>
        </dependency>
    
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.14.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.14.1</version>
        </dependency>
    </dependencies>

### 3.2 引入log4j.properties配置文件 ###

log4j.appender.console = org.apache.log4j.ConsoleAppender
    log4j.appender.console.Target = System.out
    log4j.appender.console.layout = org.apache.log4j.PatternLayout
    log4j.appender.console.layout.ConversionPattern = [%-5p] %d{ HH:mm:ss,SSS} [%t]:%m%n
    
    log4j.rootLogger = debug,console

`引入这个配置是为了，当hadoop报错时，更好的排查问题`

### 3.3 初始化Hadoop Api ###

@TestInstance(TestInstance.Lifecycle.PER_CLASS)
    class HdfsApiTest {
        
    
        private FileSystem fileSystem;
    
        private static final Logger log = LoggerFactory.getLogger(HdfsApiTest.class);
    
        @BeforeAll
        public void setUp() throws IOException, InterruptedException {
        
            // 1、将 HADOOP_HOME 设置到环境变量中
    
            Configuration configuration = new Configuration();
            // 2、此处的地址是 NameNode 的地址
            URI uri = URI.create("hdfs://192.168.121.140:8020");
            // 3、设置用户
            String user = "hadoopdeploy";
    
            // 此处如果不设置第三个参数，指的是客户端的身份，默认获取的是当前用户，不过当前用户不一定有权限，需要指定一个有权限的用户
            fileSystem = FileSystem.get(uri, configuration, user);
        }
    
        @AfterAll
        public void tearDown() throws IOException {
        
            if (null != fileSystem) {
        
                fileSystem.close();
            }
        }
    }

`此处我们需要注意的是，需要设置客户端操作的 用户，默认情况下获取的是当前登录用户，否则很有可能会出现如下错误`

![客户端用户使用不对][57a8b8d294ee4b878cc1326241d61389.png]  
`解决办法：`  
1、修改目录的访问权限。  
2、修改客户端的用户，比如此处修改成`hadoopdeploy`

## 4、java api操作 ##

### 4.1 创建目录 ###

@Test
    @DisplayName("创建hdfs目录")
    public void testMkdir() throws IOException {
        
        Path path = new Path("/bigdata/hadoop/hdfs");
        if (fileSystem.exists(path)) {
        
            log.info("目录 /bigdata/hadoop/hdfs 已经存在,不在创建");
            return;
        }
        boolean success = fileSystem.mkdirs(path);
        log.info("创建目录 /bigdata/hadoop/hdfs 成功:[{}?]", success);
    }

### 4.2 上传文件 ###

@Test
    @DisplayName("上传文件")
     void uploadFile() throws IOException {
        
         /**
          * delSrc: 文件上传后，是否删除源文件 true:删除 false:不删除
          * overwrite: 如果目标文件存在是否重写 true:重写 false:不重写
          * 第三个参数：需要上传的文件
          * 第四个参数：目标文件
          */
         fileSystem.copyFromLocalFile(false, true,
                 new Path("/Users/huan/code/IdeaProjects/me/spring-cloud-parent/hadoop/hdfs-api/src/test/java/com/huan/hadoop/HdfsApiTest.java"),
                 new Path("/bigdata/hadoop/hdfs"));
     }

### 4.3 列出目录下有哪些文件 ###

@Test
    @DisplayName("列出目录下有哪些文件")
     void testListFile() throws IOException {
        
         RemoteIterator<LocatedFileStatus> iterator = fileSystem.listFiles(new Path("/bigdata"), true);
         while (iterator.hasNext()) {
        
             LocatedFileStatus locatedFileStatus = iterator.next();
             Path path = locatedFileStatus.getPath();
             if (locatedFileStatus.isFile()) {
        
                 log.info("获取到文件: {}", path.getName());
             }
         }
     }

### 4.4 下载文件 ###

@Test
    @DisplayName("下载文件")
     void testDownloadFile() throws IOException {
        
         fileSystem.copyToLocalFile(false, new Path("/bigdata/hadoop/hdfs/HdfsApiTest.java"),
                 new Path("/Users/huan/HdfsApiTest.java"), true);
     }

### 4.5 删除文件 ###

@Test
    @DisplayName("删除文件")
    public void testDeleteFile() throws IOException {
        
        fileSystem.delete(new Path("/bigdata/hadoop/hdfs/HdfsApiTest.java"), false);
    }

### 4.6 检测文件是否存在 ###

@Test
    @DisplayName("检查文件是否存在")
     public void testFileExists() throws IOException {
        
         Path path = new Path("/bigdata/hadoop/hdfs/HdfsApiTest.java");
         boolean exists = fileSystem.exists(path);
         log.info("/bigdata/hadoop/hdfs/HdfsApiTest.java 存在:[{}]", exists);
     }

## 5、完整代码 ##

[https://gitee.com/huan1993/spring-cloud-parent/blob/master/hadoop/hdfs-api/src/test/java/com/huan/hadoop/HdfsApiTest.java][https_gitee.com_huan1993_spring-cloud-parent_blob_master_hadoop_hdfs-api_src_test_java_com_huan_hadoop_HdfsApiTest.java]

[57a8b8d294ee4b878cc1326241d61389.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/453c1697a76349c9acaefb347635b7cb.png
[https_gitee.com_huan1993_spring-cloud-parent_blob_master_hadoop_hdfs-api_src_test_java_com_huan_hadoop_HdfsApiTest.java]: https://gitee.com/huan1993/spring-cloud-parent/blob/master/hadoop/hdfs-api/src/test/java/com/huan/hadoop/HdfsApiTest.java