devstory

Le Tutoriel de Java Commons IO

  1. La bibliothèque
  2. IOUtils
  3. FileUtils
  4. FilenameUtils
  5. FileSystemUtils
  6. Line iterator
  7. File filters (Des filtres de fichiers)
  8. File comparators (Des comparateurs de fichier)
  9. Streams

1. La bibliothèque

Maven Dependency
<!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.8.0</version>
</dependency>

2. IOUtils

IOUtils est une classe utilitaire pour aider à traiter le flux plus rapidement. Si vous utilisez le java.io standard, vous pouvez faire ce que vous voulez. Mais si vous souhaitez coder plus rapidement et économiser du temps, utilisez IOUtils.
Voir Javadoc d' IOUtils ici:
Regardez le code qui est traité de la manière habituelle (en utilisant ce qui est disponible dans JDK).
InputStream in = new URL("http://commons.apache.org").openStream();
try {
    InputStreamReader inR = new InputStreamReader(in);
    BufferedReader buf = new BufferedReader(inR);
    String line;
    while ((line = buf.readLine()) != null) {
        System.out.println(line);
    }
} finally {
    in.close();
}
Voici le code qui a utilisé la classe IOUtils:
InputStream in = new URL("http://commons.apache.org").openStream();
try {
    System.out.println(IOUtils.toString(in));
} finally {
    IOUtils.closeQuietly(in);
}
En regardant les deux codes ci-dessus, nous pouvons voir clairement avec le même but, mais utiliser IOUtils est beaucoup plus rapidement.
ReadURL1.java
package org.o7planning.tutorial.commonsio.io;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.MalformedURLException;
import java.net.URL;

public class ReadURL1 {

   public static void readURL() throws MalformedURLException, IOException {
       InputStream in = new URL("http://commons.apache.org").openStream();
       try {
           InputStreamReader inR = new InputStreamReader(in);
           BufferedReader buf = new BufferedReader(inR);
           String line;
           while ((line = buf.readLine()) != null) {
               System.out.println(line);
           }
       } finally {
           in.close();
       }
   }

   public static void main(String[] args) {
       try {
           readURL();
       } catch (Exception e) {
           e.printStackTrace();
       }
   }
}
ReadURL2.java
package org.o7planning.tutorial.commonsio.io;

import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;

import org.apache.commons.io.IOUtils;

public class ReadURL2 {

   public static void readURL() throws MalformedURLException, IOException {
       InputStream in = new URL("http://commons.apache.org").openStream();
       try {
           System.out.println(IOUtils.toString(in));
       } finally {
           IOUtils.closeQuietly(in);
       }
   }

   public static void main(String[] args) {
       try {
            readURL();
       } catch (Exception e) {
           e.printStackTrace();
       }
   }
}

3. FileUtils

La classe FileUtils contient des méthodes utilitaire pour travailler avec des objets Fichier. Ceux-ci comprennent la lecture, l'écriture, la copie et la comparaison de fichiers.
Voir Javadoc de FileUtils à:
FileUtilsReadFile.java
package org.o7planning.tutorial.commonsio.fileutils;


import java.io.File;
import java.io.IOException;
import java.util.List;

import org.apache.commons.io.FileUtils;

public class FileUtilsReadFile {

   
   public static void readFile() throws IOException  {
       File file= new File("D:/test.txt");
       List<String>  lines= FileUtils.readLines(file);
       
       for(String s: lines)  {
           System.out.println(s);
       }
   }
   
   public static void main(String[] args) {
       try {
           readFile();
       } catch (IOException e) {
           e.printStackTrace();
       }
   }
   
}
FileUtilsTouchFile.java
package org.o7planning.tutorial.commonsio.fileutils;

import java.io.IOException;
import org.apache.commons.io.FileUtils;
import java.io.File;

public class FileUtilsTouchFile {

   public static void main(String[] args) {

       try {
           // E:/test not exist on disk
           File testFile = new File("E:/test.txt");

           // Get last modify time

           long fileTimestamp = testFile.lastModified();
           System.out.println("Time in milis " + fileTimestamp);

           // Using the touch() operation
           // If file not exists, it create file.
           // It change the file date and time stamps
           FileUtils.touch(testFile);

           System.out.println("Time in milis updated "
                   + testFile.lastModified());

       } catch (IOException ex) {
           ex.printStackTrace();
       }

   }
}
L'exécution pour la première fois (Lorsque E:/test.txt n'existe pas encore sur le dish dur)
L'exécution pour la deuxième fois (Lorsque E:/test.txt a étécréé et mis à jour la dernière date de motification)
L'utilisation FileUtils vous permet de copier et coller facilement des fichiers à partir d'un certain endroit vers un autre endroit ou de copier les fichiers du dossier vers un autre dossier.
FileUtilsCopyDirectory.java
package org.o7planning.tutorial.commonsio.fileutils;

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;

public class FileUtilsCopyDirectory {

   public static void main(String[] args) {
       File srcDir = new File("C:/test");
       File destDir = new File("D:/test/abc");
       try {
           FileUtils.copyDirectory(srcDir, destDir);
       } catch (IOException e) {
           e.printStackTrace();
       }
   }

}

4. FilenameUtils

La classe FilenameUtils contient des méthodes d'utilité pour travailler avec des noms de fichiers sans utiliser d'objets File. Cette classe vise à être cohérente entre Unix et Windows, pour faciliter les transitions entre ces environnements (comme le passage du développement à la production d'un produit complet).
FilenameUtils javadoc:
Par exemple, pour normaliser le nom de fichier en supprimant les segments de deux points:
FilenameUtilsNormalize.java
package org.o7planning.tutorial.commonsio.filenameutils;

import org.apache.commons.io.FilenameUtils;

public class FilenameUtilsNormalize {

   public static void main(String[] args) {
       String filename = "C:/commons/io/../lang/project.xml";
       String normalized = FilenameUtils.normalize(filename);
       System.out.println(normalized);
   }

}
Exécuter et recevoir des résultats:
FilenameUtils possède plus de 40 méthodes utilitaires, vous pouvez voir des détails dans le Javadoc.

5. FileSystemUtils

La classe FileSystemUtils comprend des méthodes utilitaires pour travailler avec le système de fichier afin d'accéder à une fonctionnalité non prise en charge par le JDK. Actuellement, la seule méthode consiste à obtenir l'espace libre sur un lecteur. Notez que cela utilise command line, pas le code natif (native code).
FileSystemUtilsFreeSpaceKb.java
package org.o7planning.tutorial.commonsio.filesystemutils;

import java.io.IOException;

import org.apache.commons.io.FileSystemUtils;

public class FileSystemUtilsFreeSpaceKb {
   public static void main(String[] args) {
       try {
           Long kb = FileSystemUtils.freeSpaceKb("C:/");
           System.out.println("Free Space: " + kb + "KB");
       } catch (IOException e) {
           e.printStackTrace();
       }
   }
}

6. Line iterator

La classe org.apache.commons.io.LineIterator fournit une manière flexible de travailler avec un fichier basé sur une ligne. Une instance peut être créée directement ou via des méthodes sur FileUtils ou IOUtils. Le modèle d'utilisation recommandé est:
LineIterator it = FileUtils.lineIterator(file, "UTF-8");
try {
    while (it.hasNext()) {
        String line = it.nextLine();
        // / do something with line
    }
} finally {
    LineIterator.closeQuietly(it);
}
LineIteratorExample.java
package org.o7planning.tutorial.commonsio.lineiterator;

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.LineIterator;

public class LineIteratorExample {
   public static void main(String[] args) {
       try {
           File file = new File("D:/test.txt");
           LineIterator it = FileUtils.lineIterator(file, "UTF-8");
           try {
               while (it.hasNext()) {
                   String line = it.nextLine();
                   //
                   if (line != null && line.startsWith("##")) {
                       System.out.println(line.substring(2));
                   }
               }
           } finally {
               LineIterator.closeQuietly(it);
           }
       } catch (IOException e) {
           e.printStackTrace();
       }
   }
}

7. File filters (Des filtres de fichiers)

Le package org.apache.commons.io.filefilter définit une interface (IOFileFilter) qui fusionne 2 interfaces: java.io.FileFilter et java.io.FilenameFilter. En plus, le package offre une série d'implémentations prêtes à l'utiliser de l'interface IOFileFilter, y compris une implémentation qui vous permet de combiner d'autres filtres (FileFilterUtils). Ces filtres peuvent être utilisés pour énumérer des fichiers ou dans FileDialog
Par exemple, java.io.FileFilter peut être utilisé pour filtrer le fichier (File) que vous voulez dans un dossier précis. Mais pour le mieux, vous pouvez utiliser les classe dans le progiciel org.apache.commons.io.filefilter. Il existe plusieurs fichiers disponiblè à vous donner.
Observez un exemple qui n'utilise pas org.apache.commons.io.filefilter
FileFilterExample1.java
package org.o7planning.tutorial.commonsio.filefilter;

import java.io.File;
import java.io.FileFilter;

public class FileFilterExample1 {

   public static void main(String[] args) {

       FileFilter filter = new MyFileFilter();

       File dir = new File("C:/test");

       // Get file with extension js or css.
       File[] list = dir.listFiles(filter);

       for (File file : list) {
           System.out.println("File " + file.getAbsolutePath());
       }
   }

   // Filter accept files (*.js , *.css)
   static class MyFileFilter implements FileFilter {

       public boolean accept(File pathname) {
           String abstractPath = pathname.getAbsolutePath();
           
           if (abstractPath.endsWith(".js") || abstractPath.endsWith(".css")) {
               return true;
           }
           return false;
       }

   }
}
Et par exemple, l'utilisation de la classe SuffixFileFilter, située dans le package org.apache.commons.io.filefilter
HiddenFileFilterExample.java
package org.o7planning.tutorial.commonsio.filefilter;

import java.io.File;

import org.apache.commons.io.filefilter.HiddenFileFilter;

public class HiddenFileFilterExample {

   public static void main(String[] args) {
       File dir = new File("C:/test");
       String[] files = dir.list(HiddenFileFilter.HIDDEN);
       for (int i = 0; i < files.length; i++) {
           System.out.println(files[i]);
       }
   }
}
FileFilterExample2.java
package org.o7planning.tutorial.commonsio.filefilter;

import java.io.File;
import java.io.FileFilter;

import org.apache.commons.io.filefilter.SuffixFileFilter;

public class FileFilterExample2 {

    public static void main(String[] args) {
        String[] suffixs = new String[] { ".js", ".css" };
        FileFilter filter = new SuffixFileFilter(suffixs);

        File dir = new File("C:/test");
        
        // Get file with extension js or css.
        File[] list = dir.listFiles(filter);

        for (File file : list) {
            System.out.println("File " + file.getAbsolutePath());
        }
    }
}
Par exemple, la combinaison de 2 filtres ensemble:
CombineTwoFilterExample.java
package org.o7planning.tutorial.commonsio.filefilter;

import java.io.File;
import java.io.FileFilter;

import org.apache.commons.io.filefilter.FileFilterUtils;
import org.apache.commons.io.filefilter.HiddenFileFilter;
import org.apache.commons.io.filefilter.IOFileFilter;
import org.apache.commons.io.filefilter.SuffixFileFilter;

public class CombineTwoFilterExample {

    public static void main(String[] args) {

        String[] suffixs = new String[] { ".js", ".css" };
        IOFileFilter filter1 = new SuffixFileFilter(suffixs);
        //
        IOFileFilter filter2 = HiddenFileFilter.VISIBLE;
        //
        // Filter accept file with extension (js,css) and Visible.
        IOFileFilter newFilter = FileFilterUtils
                .andFileFilter(filter1, filter2);

        File dir = new File("C:/test");

        File[] list = dir.listFiles((FileFilter) newFilter);

        for (File file : list) {
            System.out.println("File " + file.getAbsolutePath());
        }

    }
}

8. File comparators (Des comparateurs de fichier)

Le package org.apache.commons.io.comparator fournit certaines implémentations java.util.Comparator pour java.io.File. Ces comparateurs (comparators) peuvent être utilisées pour trier des listes et des étalages de fichiers.
SizeFileComparatorExample.java
package org.o7planning.tutorial.commonsio.comparator;

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

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.comparator.SizeFileComparator;

public class SizeFileComparatorExample {

    public static void main(String[] args) throws IOException {
        // Current directory
        File directory = new File(".");
        File[] files = directory.listFiles();

        System.out.println("Default order");
        displayFiles(files);

        Arrays.sort(files, SizeFileComparator.SIZE_COMPARATOR);
        System.out
                .println("\nSizeFileComparator.SIZE_COMPARATOR (Ascending, directories treated as 0)");
        displayFiles(files);

        Arrays.sort(files, SizeFileComparator.SIZE_REVERSE);
        System.out
                .println("\nSizeFileComparator.SIZE_REVERSE (Descending, directories treated as 0)");
        displayFiles(files);

        Arrays.sort(files, SizeFileComparator.SIZE_SUMDIR_COMPARATOR);
        System.out
                .println("\nSizeFileComparator.SIZE_SUMDIR_COMPARATOR (Ascending, directory size used)");
        displayFilesWithDirectorySizes(files);

        Arrays.sort(files, SizeFileComparator.SIZE_SUMDIR_REVERSE);
        System.out
                .println("\nSizeFileComparator.SIZE_SUMDIR_REVERSE (Descending, directory size used)");
        displayFilesWithDirectorySizes(files);
    }

    public static void displayFiles(File[] files) {
        for (File file : files) {
            System.out.printf("%-20s Size:" + file.length() + "\n",
                    file.getName());
        }
    }

    public static void displayFilesWithDirectorySizes(File[] files) {
        for (File file : files) {
            if (file.isDirectory()) {
                System.out.printf(
                        "%-20s Size:" + FileUtils.sizeOfDirectory(file) + "\n",
                        file.getName());
            } else {
                System.out.printf("%-20s Size:" + file.length() + "\n",
                        file.getName());
            }
        }
    }
}
Résultats de l'exécution de la classe SizeFileComparatorExample:
Default order
.classpath           Size:1431
.project             Size:569
.settings            Size:4096
pom.xml              Size:547
src                  Size:0
target               Size:0
test.txt             Size:0

SizeFileComparator.SIZE_COMPARATOR (Ascending, directories treated as 0)
.settings            Size:4096
src                  Size:0
target               Size:0
test.txt             Size:0
pom.xml              Size:547
.project             Size:569
.classpath           Size:1431

SizeFileComparator.SIZE_REVERSE (Descending, directories treated as 0)
.classpath           Size:1431
.project             Size:569
pom.xml              Size:547
.settings            Size:4096
src                  Size:0
target               Size:0
test.txt             Size:0

SizeFileComparator.SIZE_SUMDIR_COMPARATOR (Ascending, directory size used)
test.txt             Size:0
.settings            Size:489
pom.xml              Size:547
.project             Size:569
.classpath           Size:1431
src                  Size:11307
target               Size:22433

SizeFileComparator.SIZE_SUMDIR_REVERSE (Descending, directory size used)
target               Size:22433
src                  Size:11307
.classpath           Size:1431
.project             Size:569
pom.xml              Size:547
.settings            Size:489
test.txt             Size:0

9. Streams

Le package org.apache.commons.io.input et le package org.apache.commons.io.output comprennent diverses implémentations utiles de flux. Ceux-ci inclus:

Java Basic

Show More

Java Basic

Show More

Articles les plus récents

Show More