openplanning

Hướng dẫn và ví dụ Java Commons IO

  1. Thư viện
  2. IOUtils
  3. FileUtils
  4. FilenameUtils
  5. FileSystemUtils
  6. Line iterator
  7. File filters (Bộ lọc file)
  8. File comparators (Bộ so sánh File)
  9. Streams (Luồng vào ra dữ liệu)

1. Thư viện

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 là một class tiện ích hỗ trợ để xử lý vào ra dữ liệu một cách nhanh chóng hơn. Nếu bạn sử dụng java.io chuẩn của java bạn có thể làm được những thứ mình muốn. Nhưng muốn viết code nhanh hơn, tiết kiệm thời gian hơn, hãy sử dụng IOUtils.
Xem Javadoc của IOUtils tại đây:
Hãy xem một đoạn code được xử lý theo cách thông thường (Dùng những gì có sẵn trong 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();
}
Và đây là đoạn code sử dụng class IOUtils:
InputStream in = new URL("http://commons.apache.org").openStream();
try {
    System.out.println(IOUtils.toString(in));
} finally {
    IOUtils.closeQuietly(in);
}
Nhìn vào 2 đoạn code trên chúng ta thấy rõ ràng cùng làm một mục tiêu, nhưng sử dụng IOUtils ngắn gọn hơn hẳn.
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

Class FileUtils chứa các method tiện ích để làm việc với các đối tượng File. Bao gồm đọc, viết, copy, và so sánh các file.
Tra cứu Javadoc của 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.txt chưa có trên hệ thống.
           File testFile = new File("E:/test.txt");

           // Lấy ra thời gian sửa đổi lần cuối của file.

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

           // Sử dụng method touch(...)
           // Nếu file chưa tồn tại nó sẽ tạo ra file rỗng
           // Và thay đổi thời gian sửa lần cuối của file bằng thời gian hiện tại.
           FileUtils.touch(testFile);

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

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

   }
}
Chạy lần đầu tiên (Lúc E:/test.txt thực sự chưa tồn tại trên ổ cứng)
Chạy lần thứ 2 (Khi E:/test.txt đã được tạo ra và được sét đặt thời gian sửa đổi lần cuối trước đó)
Sử dụng FileUtils cho phép bạn dễ dàng copy và paste file từ nơi nọ sang nơi kia, hoặc copy các file từ thư mục nọ sang thư mục kia.
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

Class FilenameUtils có các method hữu ích để làm việc với tên tập tin mà không sử dụng các đối tượng File. Class này nhằm mục đích phù hợp ở giữa Unix và Windows, để hỗ trợ quá trình chuyển đổi giữa các môi trường tổng hợp (chẳng hạn như di chuyển từ môi trường lập trình phát triển sang môi trường sản phẩm hoàn chỉnh).
FilenameUtils javadoc:
Ví dụ minh họa, bỏ đi hai dấu chấm trên đường dẫn file:
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);
   }

}
Chạy và nhận kết quả:
FilenameUtils có tới hơn 40 method tiện ích, chi tiết bạn có thể xem trong Javadoc.

5. FileSystemUtils

Class FileSystemUtils có các method hữu ích để làm việc với hệ thống tập tin để truy cập vào các chức năng không được hỗ trợ bởi JDK. Hiện tại, class này mới chỉ có các method để có được không gian trống trên ổ đĩa. Chú ý là nó sử dụng các lệnh command line. Không sử dụng mã tự nhiên (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

Class org.apache.commons.io.LineIterator Cung cấp một cách linh hoạt để làm việc với một tập tin dựa trên dòng. Một ví dụ có thể được tạo ra trực tiếp, hoặc thông qua các method của FileUtils hoặc IOUtils. Bạn nên sử dụng theo cách:
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 (Bộ lọc file)

Package org.apache.commons.io.filefilter định nghĩa ra một interface (IOFileFilter) kết hợp của cả 2 interface: java.io.FileFilter và java.io.FilenameFilter. Bên cạnh đó nó có sẵn một loạt các class thực hiện (implements) IOFileFilter để bạn sẵn sàng sử dụng, và nó cũng có class (FileFilterUtils) tiện ích, cho phép bạn kết hợp các bộ lọc (filters) đó với nhau để tạo ra bộ lọc mới. Chúng được sử dụng để lọc danh sách file theo yêu cầu của bạn hoặc sử dụng trong FileDialog
Ví dụ, java.io.FileFilter có thể được dùng để bạn lọc lấy ra các File theo ý bạn trong 1 thư mục nào đó. Nhưng sẽ là tốt hơn nếu bạn sử dụng các lớp có trong package org.apache.commons.io.filefilter. Nó có nhiều cái viết sẵn cho bạn, và chỉ cần sử dụng.
Hãy xem một ví dụ không sử dụng 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");

      // Lấy ra danh sách file có phần mở rộng js hoặc css
      File[] list = dir.listFiles(filter);

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

  // Bộ lọc chấp nhận các file kiểu (*.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;
      }

  }
}
Và ví dụ sử dụng class SuffixFileFilter, nằm trong 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");
     
      // Danh sách các file có phần mở rộng js hoặc css nằm trong thư mục C:/test
      File[] list = dir.listFiles(filter);

      for (File file : list) {
          System.out.println("File " + file.getAbsolutePath());
      }
  }
}
Ví dụ kết hợp 2 bộ lọc với nhau:
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;
       //
       // Bộ lọc mới chấp nhận các file có đuôi js, css và phải là file không ẩn.
       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 (Bộ so sánh File)

Package org.apache.commons.io.comparator cung cấp một số class thực hiện java.util.Comparator cho java.io.File. Các bộ so sánh (comparators) này có thể dùng để sắp xếp danh sách hoặc một mảng các file.
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 {
      // Thư mục hiện tại (Thư mục của project)
      File directory = new File(".");
      File[] files = directory.listFiles();

      System.out.println("Sap xep mac dinh");
      displayFiles(files);

      Arrays.sort(files, SizeFileComparator.SIZE_COMPARATOR);
      System.out
              .println("\nSizeFileComparator.SIZE_COMPARATOR (Tang dan, thu muc coi nhu kich thuoc bang 0)");
      displayFiles(files);

      Arrays.sort(files, SizeFileComparator.SIZE_REVERSE);
      System.out
              .println("\nSizeFileComparator.SIZE_REVERSE (Giam dan, thu muc coi nhu kich thuoc bang 0)");
      displayFiles(files);

      Arrays.sort(files, SizeFileComparator.SIZE_SUMDIR_COMPARATOR);
      System.out
              .println("\nSizeFileComparator.SIZE_SUMDIR_COMPARATOR (Tang dan, su dung kich thuoc thu muc)");
      displayFilesWithDirectorySizes(files);

      Arrays.sort(files, SizeFileComparator.SIZE_SUMDIR_REVERSE);
      System.out
              .println("\nSizeFileComparator.SIZE_SUMDIR_REVERSE (Giam dan, su dung kich thuoc thu muc)");
      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());
          }
      }
  }
}
Kết quả chạy class SizeFileComparatorExample:
Sap xep mac dinh
.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 (Tang dan, thu muc coi nhu kich thuoc bang 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 (Giam dan, thu muc coi nhu kich thuoc bang 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 (Tang dan, su dung kich thuoc thu muc)
test.txt             Size:0
.settings            Size:489
pom.xml              Size:547
.project             Size:569
.classpath           Size:1431
src                  Size:11611
target               Size:22459

SizeFileComparator.SIZE_SUMDIR_REVERSE (Giam dan, su dung kich thuoc thu muc)
target               Size:22459
src                  Size:11611
.classpath           Size:1431
.project             Size:569
pom.xml              Size:547
.settings            Size:489
test.txt             Size:0

9. Streams (Luồng vào ra dữ liệu)

Package org.apache.commons.io.input và org.apache.commons.io.output chứa một vài các class xử lý vào ra dữ liệu. Chúng bao gồm:

Java cơ bản

Show More

Java cơ bản

Show More