Java文件遍历那些事

一、简要概述

文件遍历基本上是每个编程语言具备的基本功能，Java语言也不例外。下面我们以java原生实现，Apache common-io、spring框架实现为例来比较各自实现的异同。

二、文件遍历几种实现

为了方便比较，我们以window OS的系统图片文件目录为例，来进行遍历。

1. java实现

import java.io.File;
import java.io.FileFilter;
import java.io.FilenameFilter;
import java.util.Arrays;
import java.util.stream.Stream;

import org.apache.commons.io.filefilter.DirectoryFileFilter;
import org.apache.commons.io.filefilter.FileFileFilter;
import org.apache.commons.lang3.StringUtils;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import lombok.extern.slf4j.Slf4j;

/**
 * 文件遍历
 */
@Slf4j
public class FileListByJava
{
    String path = System.getenv().get("USERPROFILE") + "\\Pictures\\";
    
    File searchFile = new File(path);
    
    @BeforeEach
    public void before()
    {
        log.info(path);
    }
    
    /**
     * 遍历文件
     */
    @Test
    public void testList()
    {
        Arrays.stream(searchFile.list()).forEach(System.out::println);
    }
    
    /**
     * 遍历文件
     */
    @Test
    public void testFile()
    {
        File[] files = searchFile.listFiles((FileFilter)FileFileFilter.FILE);
        Stream.of(files).forEach(System.out::println);
        
        // 等价lambda写法
        files = searchFile.listFiles((file) -> file.isFile());
        Stream.of(files).forEach(System.out::println);
    }
    
    /**
     * 遍历目录
     */
    @Test
    public void testDirectory()
    {
        File[] files = searchFile.listFiles((FileFilter)DirectoryFileFilter.DIRECTORY);
        Stream.of(files).forEach(System.out::println);
        
        // 等价lambda写法
        files = searchFile.listFiles((file) -> file.isDirectory());
        Stream.of(files).forEach(System.out::println);
    }
    
    /**
     * 自定义文件名过滤遍历
     */
    @Test
    public void testFileName()
    {
        File[] files = searchFile.listFiles(new FilenameFilter()
        {
            @Override
            public boolean accept(File dir, String name)
            {
                // 广义的文件包含目录，name为文件（包含目录）名称
                return StringUtils.endsWithAny(name, "abc", ".jpg", ".png");
            }
        });
        Stream.of(files).forEach(System.out::println);
        
        // 等价lambda写法
        files = searchFile.listFiles((d, s) -> StringUtils.endsWithAny(s, "abc", ".jpg", ".png"));
        Stream.of(files).forEach(System.out::println);
    }
}

2. Apache common-io

import java.io.File;
import java.util.Collection;
import java.util.concurrent.atomic.AtomicInteger;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.DirectoryFileFilter;
import org.apache.commons.io.filefilter.FileFilterUtils;
import org.apache.commons.io.filefilter.NotFileFilter;
import org.apache.commons.io.filefilter.TrueFileFilter;
import org.junit.jupiter.api.Test;

public class FileListByApache
{
    String path = System.getenv().get("USERPROFILE") + "\\Pictures\\";
    
    File searchFile = new File(path);
    
    /**
     * 遍历文件目录
     * 
     */
    @Test
    public void testListFilesAndDirs001()
    {
        Collection<File> files = FileUtils.listFilesAndDirs(searchFile, new NotFileFilter(TrueFileFilter.TRUE), DirectoryFileFilter.DIRECTORY);
        files.stream().forEach(System.out::println);
    }
    
    /**
     * 遍历文件目录
     * 
     */
    @Test
    public void testListFilesAndDirs002()
    {
        Collection<File> files = FileUtils.listFilesAndDirs(searchFile, TrueFileFilter.TRUE, DirectoryFileFilter.DIRECTORY);
        files.stream().forEach(System.out::println);
    }
    
    /**
     * 遍历文件
     * 
     */
    @Test
    public void testListFiles001()
    {
        // 搜索子目录
        Collection<File> pics = FileUtils.listFiles(searchFile, new String[] {"jpg", "png"}, true);
        pics.stream().forEach(System.out::println);
        
        // 搜索子目录
        Collection<File> pngs = FileUtils.listFiles(searchFile, FileFilterUtils.suffixFileFilter("png"), TrueFileFilter.INSTANCE);
        pngs.stream().forEach(System.out::println);
    }
    
    /**
     * 遍历文件
     * 
     */
    @Test
    public void testListFiles002()
    {
        // 不搜索子目录
        Collection<File> pics = FileUtils.listFiles(searchFile, new String[] {"jpg", "png"}, false);
        pics.stream().forEach(System.out::println);
        
        // 不搜索子目录
        Collection<File> pngs = FileUtils.listFiles(searchFile, FileFilterUtils.suffixFileFilter("png"), null);
        pngs.stream().forEach(System.out::println);
    }
    
    /**
     * 遍历文件
     * 
     */
    @Test
    public void testListFiles003()
    {
        // 下面用法区别?
        AtomicInteger count = new AtomicInteger();
        FileUtils.listFiles(searchFile, TrueFileFilter.TRUE, DirectoryFileFilter.DIRECTORY).stream().peek(f -> System.out.print(count.incrementAndGet() + ".\t")).forEach(System.out::println);
        
        count.set(0);
        FileUtils.listFiles(searchFile, TrueFileFilter.TRUE, TrueFileFilter.INSTANCE).stream().peek(f -> System.out.print(count.incrementAndGet() + ".\t")).forEach(System.out::println);
    }
}

并且内置了多种文件过滤器实现

3. Spring

import java.io.IOException;
import java.util.Arrays;

import org.junit.jupiter.api.Test;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

public class FileListBySpring
{
    PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
    
    String userProfile = "file:" + System.getenv().get("USERPROFILE");
    
    /**
     * 遍历文件
     * 
     * @throws IOException
     */
    @Test
    public void testList()
        throws IOException
    {
        // 外部文件
        Resource[] jpgs = resolver.getResources(userProfile + "/Pictures/**/*.jpg");
        Arrays.stream(jpgs).forEach(System.out::println);
        
        // 外部文件
        Resource[] pngs = resolver.getResources(userProfile + "/Pictures/**/*.png");
        Arrays.stream(pngs).forEach(System.out::println);
        
        // 工程或jar内文件
        Resource[] xmls = resolver.getResources("classpath*:**/*.xml");
        Arrays.stream(xmls).forEach(System.out::println);
    }
}

三、最终结论

1. java原生文件遍历只支持同级目录遍历文件或目录，支持定制过滤规则
2. Apache common-io功能是最强大的，支持当前目录及子目录递归遍历，支持定制过滤规则
3. Spring 也支持当前目录及子目录递归遍历，但是只支持同一种文件类型的过滤，假如你需要同时处理多种文件后缀格式，e.g: 需要同时搜索jpg、png两种格式文件，处理比较麻烦，同时支持外部、工程或jar内文件，并且工程内文件和Jar内文件实现了调用方式的统一。

各位同学可根据不同场合和需要，选择使用！

---

有任何问题和建议，都可以向我提问讨论,大家一起进步，谢谢!

-over-