Standardowy zwięzły sposób na skopiowanie pliku w Javie?

Zawsze niepokoiło mnie, że jedynym sposobem na skopiowanie pliku w Javie jest otwarcie strumieni, zadeklarowanie bufora, odczytanie jednego pliku, zapętlenie go i zapisanie go w innej parze. Sieć jest zaśmiecona podobnymi, ale wciąż nieco różnymi implementacjami tego typu rozwiązania.

Czy istnieje lepszy sposób, który mieści się w granicach języka Java (co oznacza, że ​​nie wymaga wykonywania poleceń specyficznych dla systemu operacyjnego)? Być może w jakimś niezawodnym pakiecie narzędziowym typu open source, który przynajmniej zasłoniłby tę podstawową implementację i zapewniłby rozwiązanie jednowierszowe?

Jak wspomniano powyżej, zestaw narzędzi Apache Commons IO jest najlepszym rozwiązaniem, w szczególności FileUtils . copyFile () ; poradzi sobie z każdym ciężkim podnoszeniem.

I jako postscript zauważ, że najnowsze wersje FileUtils (takie jak wydanie 2.0.1) dodały użycie NIO do kopiowania plików; NIO może znacznie zwiększyć wydajność kopiowania plików , w dużej mierze, ponieważ procedury NIO odraczają kopiowanie bezpośrednio do systemu operacyjnego / plików zamiast obsługiwać je poprzez odczytywanie i zapisywanie bajtów przez warstwę Java. Więc jeśli szukasz wydajności, warto sprawdzić, czy korzystasz z najnowszej wersji FileUtils.

Unikałbym używania mega api, takich jak apache commons. Jest to operacja uproszczona i jest wbudowana w JDK w nowym pakiecie NIO. W pewnym sensie było to już związane z poprzednią odpowiedzią, ale kluczową metodą w interfejsie NIO są nowe funkcje „transferTo” i „transferFrom”.

http://java.sun.com/javase/6/docs/api/java/nio/channels/FileChannel.html#transferTo(long,%20long,%20java.nio.channels.WritableByteChannel)

Jeden z powiązanych artykułów pokazuje świetny sposób na zintegrowanie tej funkcji z Twoim kodem za pomocą metody transferFrom:

public static void copyFile(File sourceFile, File destFile) throws IOException {
    if(!destFile.exists()) {
        destFile.createNewFile();
    }

    FileChannel source = null;
    FileChannel destination = null;

    try {
        source = new FileInputStream(sourceFile).getChannel();
        destination = new FileOutputStream(destFile).getChannel();
        destination.transferFrom(source, 0, source.size());
    }
    finally {
        if(source != null) {
            source.close();
        }
        if(destination != null) {
            destination.close();
        }
    }
}

Nauka NIO może być trochę trudna, więc możesz zaufać tej mechanice, zanim pójdziesz i spróbujesz nauczyć się NIO przez noc. Z własnego doświadczenia bardzo trudno jest się nauczyć, jeśli nie masz doświadczenia i zostałeś wprowadzony do IO za pośrednictwem strumieni java.io.

Teraz w Javie 7 możesz użyć następującej składni try-with-resource:

public static void copyFile( File from, File to ) throws IOException {

    if ( !to.exists() ) { to.createNewFile(); }

    try (
        FileChannel in = new FileInputStream( from ).getChannel();
        FileChannel out = new FileOutputStream( to ).getChannel() ) {

        out.transferFrom( in, 0, in.size() );
    }
}

Lub jeszcze lepiej, można to również osiągnąć za pomocą nowej klasy Files wprowadzonej w Javie 7:

public static void copyFile( File from, File to ) throws IOException {
    Files.copy( from.toPath(), to.toPath() );
}

Dość sprytny, co?

• Metody te są opracowywane pod kątem wydajności (integrują się z natywnymi operacjami wejścia / wyjścia systemu operacyjnego).
• Te metody działają z plikami, katalogami i łączami.
• Każdą z dostarczonych opcji można pominąć - są one opcjonalne.

Klasa użyteczności

package com.yourcompany.nio;

class Files {

    static int copyRecursive(Path source, Path target, boolean prompt, CopyOptions options...) {
        CopyVisitor copyVisitor = new CopyVisitor(source, target, options).copy();
        EnumSet<FileVisitOption> fileVisitOpts;
        if (Arrays.toList(options).contains(java.nio.file.LinkOption.NOFOLLOW_LINKS) {
            fileVisitOpts = EnumSet.noneOf(FileVisitOption.class) 
        } else {
            fileVisitOpts = EnumSet.of(FileVisitOption.FOLLOW_LINKS);
        }
        Files.walkFileTree(source[i], fileVisitOpts, Integer.MAX_VALUE, copyVisitor);
    }

    private class CopyVisitor implements FileVisitor<Path>  {
        final Path source;
        final Path target;
        final CopyOptions[] options;

        CopyVisitor(Path source, Path target, CopyOptions options...) {
             this.source = source;  this.target = target;  this.options = options;
        };

        @Override
        FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) {
        // before visiting entries in a directory we copy the directory
        // (okay if directory already exists).
        Path newdir = target.resolve(source.relativize(dir));
        try {
            Files.copy(dir, newdir, options);
        } catch (FileAlreadyExistsException x) {
            // ignore
        } catch (IOException x) {
            System.err.format("Unable to create: %s: %s%n", newdir, x);
            return SKIP_SUBTREE;
        }
        return CONTINUE;
    }

    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
        Path newfile= target.resolve(source.relativize(file));
        try {
            Files.copy(file, newfile, options);
        } catch (IOException x) {
            System.err.format("Unable to copy: %s: %s%n", source, x);
        }
        return CONTINUE;
    }

    @Override
    public FileVisitResult postVisitDirectory(Path dir, IOException exc) {
        // fix up modification time of directory when done
        if (exc == null && Arrays.toList(options).contains(COPY_ATTRIBUTES)) {
            Path newdir = target.resolve(source.relativize(dir));
            try {
                FileTime time = Files.getLastModifiedTime(dir);
                Files.setLastModifiedTime(newdir, time);
            } catch (IOException x) {
                System.err.format("Unable to copy all attributes to: %s: %s%n", newdir, x);
            }
        }
        return CONTINUE;
    }

    @Override
    public FileVisitResult visitFileFailed(Path file, IOException exc) {
        if (exc instanceof FileSystemLoopException) {
            System.err.println("cycle detected: " + file);
        } else {
            System.err.format("Unable to copy: %s: %s%n", file, exc);
        }
        return CONTINUE;
    }
}

Kopiowanie katalogu lub pliku

long bytes = java.nio.file.Files.copy( 
                 new java.io.File("<filepath1>").toPath(), 
                 new java.io.File("<filepath2>").toPath(),
                 java.nio.file.StandardCopyOption.REPLACE_EXISTING,
                 java.nio.file.StandardCopyOption.COPY_ATTRIBUTES,
                 java.nio.file.LinkOption.NOFOLLOW_LINKS);

Przenoszenie katalogu lub pliku

long bytes = java.nio.file.Files.move( 
                 new java.io.File("<filepath1>").toPath(), 
                 new java.io.File("<filepath2>").toPath(),
                 java.nio.file.StandardCopyOption.ATOMIC_MOVE,
                 java.nio.file.StandardCopyOption.REPLACE_EXISTING);

Kopiowanie katalogu lub pliku rekurencyjnie

long bytes = com.yourcompany.nio.Files.copyRecursive( 
                 new java.io.File("<filepath1>").toPath(), 
                 new java.io.File("<filepath2>").toPath(),
                 java.nio.file.StandardCopyOption.REPLACE_EXISTING,
                 java.nio.file.StandardCopyOption.COPY_ATTRIBUTES
                 java.nio.file.LinkOption.NOFOLLOW_LINKS );

W Javie 7 jest to łatwe ...

File src = new File("original.txt");
File target = new File("copy.txt");

Files.copy(src.toPath(), target.toPath(), StandardCopyOption.REPLACE_EXISTING);

Aby skopiować plik i zapisać go na docelowej ścieżce, możesz użyć poniższej metody.

public void copy(File src, File dst) throws IOException {
    InputStream in = new FileInputStream(src);
    try {
        OutputStream out = new FileOutputStream(dst);
        try {
            // Transfer bytes from in to out
            byte[] buf = new byte[1024];
            int len;
            while ((len = in.read(buf)) > 0) {
                out.write(buf, 0, len);
            }
        } finally {
            out.close();
        }
    } finally {
        in.close();
    }
}

Zauważ, że wszystkie te mechanizmy kopiują tylko zawartość pliku, a nie metadane, takie jak uprawnienia. Więc jeśli miałbyś skopiować lub przenieść plik wykonywalny .sh na Linuksie, nowy plik nie byłby wykonywalny.

Aby naprawdę skopiować lub przenieść plik, tj. Aby uzyskać taki sam wynik jak kopiowanie z wiersza poleceń, w rzeczywistości musisz użyć rodzimego narzędzia. Albo skrypt powłoki, albo JNI.

Najwyraźniej można to naprawić w java 7 - http://today.java.net/pub/a/today/2008/07/03/jsr-203-new-file-apis.html . Skrzyżowane palce!

Biblioteka Google Guava ma również metodę kopiowania :

publiczna statyczna nieważna kopia ( Plik  z,
                         Plik  do)
                 zgłasza wyjątek IOException

Kopiuje wszystkie bajty z jednego pliku do drugiego.

Ostrzeżenie: jeśli toreprezentuje istniejący plik, plik ten zostanie zastąpiony zawartością from. Jeśli toi fromodnoszą się do tego samego pliku, zawartość tego pliku zostanie usunięta.

Parametry:from - plik źródłowy to- plik docelowy

Zgłasza: IOException - jeśli wystąpi błąd we / wy IllegalArgumentException- jeślifrom.equals(to)

Dostępny standardowo w Javie 7, path.copyTo: http://openjdk.java.net/projects/nio/javadoc/java/nio/file/Path.html http://java.sun.com/docs/books/ tutorial / essential / io / copy.html

Nie mogę uwierzyć, że tyle czasu zajęło im ujednolicenie czegoś tak powszechnego i prostego, jak kopiowanie plików :(

Trzy możliwe problemy z powyższym kodem:

1. Jeśli getChannel zgłosi wyjątek, możesz wyciec otwarty strumień.
2. W przypadku dużych plików możesz próbować przesłać więcej plików naraz niż system operacyjny może obsłużyć.
3. Ignorujesz wartość zwracaną przez transferFrom, więc może to być kopiowanie tylko części pliku.

To dlatego org.apache.tools.ant.util.ResourceUtils.copyResourcejest takie skomplikowane. Zauważ też, że chociaż transferFrom jest w porządku, transferTo psuje się w JDK 1.4 w Linuksie (patrz Bug ID: 5056395 ) - Jesse Glick Jan

Jeśli korzystasz z aplikacji internetowej, która już korzysta z Spring i nie chcesz dołączać Apache Commons IO do prostego kopiowania plików, możesz użyć FileCopyUtils z Spring.

Oto trzy sposoby łatwego kopiowania plików za pomocą jednego wiersza kodu!

Java7 :

java.nio.file.Files # copy

private static void copyFileUsingJava7Files(File source, File dest) throws IOException {
    Files.copy(source.toPath(), dest.toPath());
}

Appache Commons IO :

FileUtils # copyFile

private static void copyFileUsingApacheCommonsIO(File source, File dest) throws IOException {
    FileUtils.copyFile(source, dest);
}

Guawa :

Pliki # kopiuj

private static void copyFileUsingGuava(File source,File dest) throws IOException{
    Files.copy(source,dest);          
}

public static void copyFile(File src, File dst) throws IOException
{
    long p = 0, dp, size;
    FileChannel in = null, out = null;

    try
    {
        if (!dst.exists()) dst.createNewFile();

        in = new FileInputStream(src).getChannel();
        out = new FileOutputStream(dst).getChannel();
        size = in.size();

        while ((dp = out.transferFrom(in, p, size)) > 0)
        {
            p += dp;
        }
    }
    finally {
        try
        {
            if (out != null) out.close();
        }
        finally {
            if (in != null) in.close();
        }
    }
}

Według mojego testu kopia NIO z buforem jest najszybsza. Zobacz działający kod poniżej z mojego projektu testowego na https://github.com/mhisoft/fastcopy

import java.io.Closeable;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.text.DecimalFormat;


public class test {

private static final int BUFFER = 4096*16;
static final DecimalFormat df = new DecimalFormat("#,###.##");
public static void nioBufferCopy(final File source, final File target )  {
    FileChannel in = null;
    FileChannel out = null;
    double  size=0;
    long overallT1 =  System.currentTimeMillis();

    try {
        in = new FileInputStream(source).getChannel();
        out = new FileOutputStream(target).getChannel();
        size = in.size();
        double size2InKB = size / 1024 ;
        ByteBuffer buffer = ByteBuffer.allocateDirect(BUFFER);

        while (in.read(buffer) != -1) {
            buffer.flip();

            while(buffer.hasRemaining()){
                out.write(buffer);
            }

            buffer.clear();
        }
        long overallT2 =  System.currentTimeMillis();
        System.out.println(String.format("Copied %s KB in %s millisecs", df.format(size2InKB),  (overallT2 - overallT1)));
    }
    catch (IOException e) {
        e.printStackTrace();
    }

    finally {
        close(in);
        close(out);
    }
}

private static void close(Closeable closable)  {
    if (closable != null) {
        try {
            closable.close();
        } catch (IOException e) {
            if (FastCopy.debug)
                e.printStackTrace();
        }    
    }
}

}

Szybko i współpracuj ze wszystkimi wersjami Java, także Android:

private void copy(final File f1, final File f2) throws IOException {
    f2.createNewFile();

    final RandomAccessFile file1 = new RandomAccessFile(f1, "r");
    final RandomAccessFile file2 = new RandomAccessFile(f2, "rw");

    file2.getChannel().write(file1.getChannel().map(FileChannel.MapMode.READ_ONLY, 0, f1.length()));

    file1.close();
    file2.close();
}

Trochę za późno na imprezę, ale tutaj jest porównanie czasu kopiowania pliku przy użyciu różnych metod kopiowania plików. Zapętlałem metody 10 razy i brałem średnią. Najgorszym kandydatem wydaje się transfer plików przy użyciu strumieni IO:

Oto metody:

private static long fileCopyUsingFileStreams(File fileToCopy, File newFile) throws IOException {
    FileInputStream input = new FileInputStream(fileToCopy);
    FileOutputStream output = new FileOutputStream(newFile);
    byte[] buf = new byte[1024];
    int bytesRead;
    long start = System.currentTimeMillis();
    while ((bytesRead = input.read(buf)) > 0)
    {
        output.write(buf, 0, bytesRead);
    }
    long end = System.currentTimeMillis();

    input.close();
    output.close();

    return (end-start);
}

private static long fileCopyUsingNIOChannelClass(File fileToCopy, File newFile) throws IOException
{
    FileInputStream inputStream = new FileInputStream(fileToCopy);
    FileChannel inChannel = inputStream.getChannel();

    FileOutputStream outputStream = new FileOutputStream(newFile);
    FileChannel outChannel = outputStream.getChannel();

    long start = System.currentTimeMillis();
    inChannel.transferTo(0, fileToCopy.length(), outChannel);
    long end = System.currentTimeMillis();

    inputStream.close();
    outputStream.close();

    return (end-start);
}

private static long fileCopyUsingApacheCommons(File fileToCopy, File newFile) throws IOException
{
    long start = System.currentTimeMillis();
    FileUtils.copyFile(fileToCopy, newFile);
    long end = System.currentTimeMillis();
    return (end-start);
}

private static long fileCopyUsingNIOFilesClass(File fileToCopy, File newFile) throws IOException
{
    Path source = Paths.get(fileToCopy.getPath());
    Path destination = Paths.get(newFile.getPath());
    long start = System.currentTimeMillis();
    Files.copy(source, destination, StandardCopyOption.REPLACE_EXISTING);
    long end = System.currentTimeMillis();

    return (end-start);
}

Jedyną wadą, jaką widzę podczas korzystania z klasy kanału NIO, jest to, że nadal nie mogę znaleźć sposobu na pokazanie postępu kopiowania plików pośrednich.