Làm cách nào để tạo một thư mục / thư mục tạm thời trong Java?

Có một cách tiêu chuẩn và đáng tin cậy để tạo một thư mục tạm thời bên trong một ứng dụng Java không? Có một mục trong cơ sở dữ liệu vấn đề của Java , có một chút mã trong các bình luận, nhưng tôi tự hỏi liệu có một giải pháp tiêu chuẩn nào được tìm thấy trong một trong các thư viện thông thường (Apache Commons, v.v.) không?

Nếu bạn đang sử dụng JDK 7, hãy sử dụng lớp Files.createTempDirectory mới để tạo thư mục tạm thời.

Path tempDirWithPrefix = Files.createTempDirectory(prefix);

Trước JDK 7, điều này sẽ làm điều đó:

public static File createTempDirectory()
    throws IOException
{
    final File temp;

    temp = File.createTempFile("temp", Long.toString(System.nanoTime()));

    if(!(temp.delete()))
    {
        throw new IOException("Could not delete temp file: " + temp.getAbsolutePath());
    }

    if(!(temp.mkdir()))
    {
        throw new IOException("Could not create temp directory: " + temp.getAbsolutePath());
    }

    return (temp);
}

Bạn có thể tạo ra ngoại lệ tốt hơn (phân lớp IOException) nếu bạn muốn.

Thư viện Google Guava có rất nhiều tiện ích hữu ích. Một lưu ý ở đây là lớp Files . Nó có một loạt các phương thức hữu ích bao gồm:

File myTempDir = Files.createTempDir();

Điều này thực hiện chính xác những gì bạn yêu cầu trong một dòng. Nếu bạn đọc tài liệu ở đây, bạn sẽ thấy rằng sự thích ứng được đề xuất File.createTempFile("install", "dir")thường đưa ra các lỗ hổng bảo mật.

Nếu bạn cần một thư mục tạm thời để thử nghiệm và bạn đang sử dụng jUnit, @Rulecùng với việc TemporaryFoldergiải quyết vấn đề của bạn:

@Rule
public TemporaryFolder folder = new TemporaryFolder();

Từ tài liệu :

Quy tắc tạm thời cho phép tạo các tệp và thư mục được đảm bảo sẽ bị xóa khi phương thức kiểm tra kết thúc (cho dù nó vượt qua hay thất bại)

Cập nhật:

Nếu bạn đang sử dụng JUnit Jupiter (phiên bản 5.1.1 trở lên), bạn có tùy chọn sử dụng JUnit Pioneer là Gói mở rộng JUnit 5.

Sao chép từ tài liệu dự án :

Ví dụ, bài kiểm tra sau đăng ký phần mở rộng cho một phương thức kiểm tra duy nhất, tạo và ghi một tệp vào thư mục tạm thời và kiểm tra nội dung của nó.

@Test
@ExtendWith(TempDirectory.class)
void test(@TempDir Path tempDir) {
    Path file = tempDir.resolve("test.txt");
    writeFile(file);
    assertExpectedFileContent(file);
}

Thông tin thêm trong JavaDoc và JavaDoc của TempDirectory

Học sinh lớp

dependencies {
    testImplementation 'org.junit-pioneer:junit-pioneer:0.1.2'
}

Maven:

<dependency>
   <groupId>org.junit-pioneer</groupId>
   <artifactId>junit-pioneer</artifactId>
   <version>0.1.2</version>
   <scope>test</scope>
</dependency>

Cập nhật 2:

Các @TempDir chú thích đã được thêm vào 5.4.0 phát hành JUnit Jupiter như một tính năng thử nghiệm. Ví dụ được sao chép từ Hướng dẫn sử dụng JUnit 5 :

@Test
void writeItemsToFile(@TempDir Path tempDir) throws IOException {
    Path file = tempDir.resolve("test.txt");

    new ListWriter(file).write("a", "b", "c");

    assertEquals(singletonList("a,b,c"), Files.readAllLines(file));
}

Mã được viết rõ ràng để giải quyết vấn đề này phải chịu các điều kiện chủng tộc, bao gồm một số câu trả lời ở đây. Về mặt lịch sử, bạn có thể suy nghĩ cẩn thận về các điều kiện chủng tộc và tự viết hoặc bạn có thể sử dụng thư viện của bên thứ ba như Guava của Google (như câu trả lời của Spina đã đề xuất.) Hoặc bạn có thể viết mã lỗi.

Nhưng kể từ JDK 7, có một tin tốt! Bản thân thư viện chuẩn Java hiện cung cấp một giải pháp hoạt động đúng (không phù hợp) cho vấn đề này. Bạn muốn java.nio.file.Files # createTempDirectory () . Từ tài liệu :

public static Path createTempDirectory(Path dir,
                       String prefix,
                       FileAttribute<?>... attrs)
                                throws IOException

Tạo một thư mục mới trong thư mục được chỉ định, sử dụng tiền tố đã cho để tạo tên của nó. Đường dẫn kết quả được liên kết với cùng Hệ thống tệp với thư mục đã cho.

Các chi tiết về cách tên của thư mục được xây dựng phụ thuộc vào việc triển khai và do đó không được chỉ định. Trường hợp có thể tiền tố được sử dụng để xây dựng tên ứng cử viên.

Điều này giải quyết hiệu quả báo cáo lỗi cổ xưa đáng xấu hổ trong trình theo dõi lỗi Mặt trời yêu cầu chức năng như vậy.

Đây là mã nguồn của Files.createTempDir () của thư viện Guava. Nó không phức tạp như bạn nghĩ:

public static File createTempDir() {
  File baseDir = new File(System.getProperty("java.io.tmpdir"));
  String baseName = System.currentTimeMillis() + "-";

  for (int counter = 0; counter < TEMP_DIR_ATTEMPTS; counter++) {
    File tempDir = new File(baseDir, baseName + counter);
    if (tempDir.mkdir()) {
      return tempDir;
    }
  }
  throw new IllegalStateException("Failed to create directory within "
      + TEMP_DIR_ATTEMPTS + " attempts (tried "
      + baseName + "0 to " + baseName + (TEMP_DIR_ATTEMPTS - 1) + ')');
}

Theo mặc định:

private static final int TEMP_DIR_ATTEMPTS = 10000;

Xem tại đây

Không sử dụng deleteOnExit()ngay cả khi bạn xóa nó một cách rõ ràng sau đó.

Google 'xóaonexit là xấu xa' để biết thêm thông tin, nhưng ý chính của vấn đề là:

1. deleteOnExit() chỉ xóa để tắt JVM bình thường, không bị sập hoặc làm chết quá trình JVM.

2. deleteOnExit() chỉ xóa khi tắt JVM - không tốt cho các quy trình máy chủ chạy dài vì:

3. Tội ác nhất trong tất cả - deleteOnExit()tiêu thụ bộ nhớ cho mỗi mục nhập tệp tạm thời. Nếu quy trình của bạn đang chạy trong nhiều tháng hoặc tạo ra nhiều tệp tạm thời trong một thời gian ngắn, bạn sẽ tiêu thụ bộ nhớ và không bao giờ giải phóng nó cho đến khi JVM tắt.

Kể từ Java 1.7 createTempDirectory(prefix, attrs)và createTempDirectory(dir, prefix, attrs)được bao gồm trongjava.nio.file.Files

Thí dụ: File tempDir = Files.createTempDirectory("foobar").toFile();

Đây là những gì tôi quyết định làm cho mã của riêng tôi:

/**
 * Create a new temporary directory. Use something like
 * {@link #recursiveDelete(File)} to clean this directory up since it isn't
 * deleted automatically
 * @return  the new directory
 * @throws IOException if there is an error creating the temporary directory
 */
public static File createTempDir() throws IOException
{
    final File sysTempDir = new File(System.getProperty("java.io.tmpdir"));
    File newTempDir;
    final int maxAttempts = 9;
    int attemptCount = 0;
    do
    {
        attemptCount++;
        if(attemptCount > maxAttempts)
        {
            throw new IOException(
                    "The highly improbable has occurred! Failed to " +
                    "create a unique temporary directory after " +
                    maxAttempts + " attempts.");
        }
        String dirName = UUID.randomUUID().toString();
        newTempDir = new File(sysTempDir, dirName);
    } while(newTempDir.exists());

    if(newTempDir.mkdirs())
    {
        return newTempDir;
    }
    else
    {
        throw new IOException(
                "Failed to create temp dir named " +
                newTempDir.getAbsolutePath());
    }
}

/**
 * Recursively delete file or directory
 * @param fileOrDir
 *          the file or dir to delete
 * @return
 *          true iff all files are successfully deleted
 */
public static boolean recursiveDelete(File fileOrDir)
{
    if(fileOrDir.isDirectory())
    {
        // recursively delete contents
        for(File innerFile: fileOrDir.listFiles())
        {
            if(!FileUtilities.recursiveDelete(innerFile))
            {
                return false;
            }
        }
    }

    return fileOrDir.delete();
}

Chà, "createdTempFile" thực sự tạo tập tin. Vậy tại sao không xóa nó trước, và sau đó thực hiện mkdir trên nó?

Mã này sẽ hoạt động hợp lý tốt:

public static File createTempDir() {
    final String baseTempPath = System.getProperty("java.io.tmpdir");

    Random rand = new Random();
    int randomInt = 1 + rand.nextInt();

    File tempDir = new File(baseTempPath + File.separator + "tempDir" + randomInt);
    if (tempDir.exists() == false) {
        tempDir.mkdir();
    }

    tempDir.deleteOnExit();

    return tempDir;
}

Như đã thảo luận trong RFE này và các bình luận của nó, bạn có thể gọi tempDir.delete()trước. Hoặc bạn có thể sử dụng System.getProperty("java.io.tmpdir")và tạo một thư mục ở đó. Dù bằng cách nào, bạn nên nhớ gọi tempDir.deleteOnExit(), hoặc tập tin sẽ không bị xóa sau khi bạn hoàn thành.

Chỉ cần hoàn thành, đây là mã từ thư viện ổi của google. Nó không phải là mã của tôi, nhưng tôi nghĩ nó có giá trị để hiển thị nó ở đây trong chuỗi này.

  /** Maximum loop count when creating temp directories. */
  private static final int TEMP_DIR_ATTEMPTS = 10000;

  /**
   * Atomically creates a new directory somewhere beneath the system's temporary directory (as
   * defined by the {@code java.io.tmpdir} system property), and returns its name.
   *
   * <p>Use this method instead of {@link File#createTempFile(String, String)} when you wish to
   * create a directory, not a regular file. A common pitfall is to call {@code createTempFile},
   * delete the file and create a directory in its place, but this leads a race condition which can
   * be exploited to create security vulnerabilities, especially when executable files are to be
   * written into the directory.
   *
   * <p>This method assumes that the temporary volume is writable, has free inodes and free blocks,
   * and that it will not be called thousands of times per second.
   *
   * @return the newly-created directory
   * @throws IllegalStateException if the directory could not be created
   */
  public static File createTempDir() {
    File baseDir = new File(System.getProperty("java.io.tmpdir"));
    String baseName = System.currentTimeMillis() + "-";

    for (int counter = 0; counter < TEMP_DIR_ATTEMPTS; counter++) {
      File tempDir = new File(baseDir, baseName + counter);
      if (tempDir.mkdir()) {
        return tempDir;
      }
    }
    throw new IllegalStateException(
        "Failed to create directory within "
            + TEMP_DIR_ATTEMPTS
            + " attempts (tried "
            + baseName
            + "0 to "
            + baseName
            + (TEMP_DIR_ATTEMPTS - 1)
            + ')');
  }

Tôi có cùng một vấn đề vì vậy đây chỉ là một câu trả lời khác cho những người quan tâm và nó tương tự như một trong những điều trên:

public static final String tempDir = System.getProperty("java.io.tmpdir")+"tmp"+System.nanoTime();
static {
    File f = new File(tempDir);
    if(!f.exists())
        f.mkdir();
}

Và đối với ứng dụng của mình, tôi đã quyết định rằng thêm vào một tùy chọn để xóa temp khi thoát để tôi thêm vào một móc tắt:

Runtime.getRuntime().addShutdownHook(new Thread() {
        @Override
        public void run() {
            //stackless deletion
            String root = MainWindow.tempDir;
            Stack<String> dirStack = new Stack<String>();
            dirStack.push(root);
            while(!dirStack.empty()) {
                String dir = dirStack.pop();
                File f = new File(dir);
                if(f.listFiles().length==0)
                    f.delete();
                else {
                    dirStack.push(dir);
                    for(File ff: f.listFiles()) {
                        if(ff.isFile())
                            ff.delete();
                        else if(ff.isDirectory())
                            dirStack.push(ff.getPath());
                    }
                }
            }
        }
    });

Phương thức xóa tất cả các thư mục con và tệp trước khi xóa temp , mà không sử dụng lệnh gọi (điều này là hoàn toàn tùy chọn và bạn có thể thực hiện với đệ quy tại thời điểm này), nhưng tôi muốn ở bên an toàn.

Như bạn có thể thấy trong các câu trả lời khác, không có cách tiếp cận tiêu chuẩn nào phát sinh. Do đó bạn đã đề cập đến Apache Commons, tôi đề xuất cách tiếp cận sau bằng FileUtils từ Apache Commons IO :

/**
 * Creates a temporary subdirectory in the standard temporary directory.
 * This will be automatically deleted upon exit.
 * 
 * @param prefix
 *            the prefix used to create the directory, completed by a
 *            current timestamp. Use for instance your application's name
 * @return the directory
 */
public static File createTempDirectory(String prefix) {

    final File tmp = new File(FileUtils.getTempDirectory().getAbsolutePath()
            + "/" + prefix + System.currentTimeMillis());
    tmp.mkdir();
    Runtime.getRuntime().addShutdownHook(new Thread() {

        @Override
        public void run() {

            try {
                FileUtils.deleteDirectory(tmp);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    });
    return tmp;

}

Điều này được ưa thích vì apache bắt đầu thư viện gần nhất với "tiêu chuẩn" được hỏi và hoạt động với cả JDK 7 và các phiên bản cũ hơn. Điều này cũng trả về một cá thể Tệp "cũ" (dựa trên luồng) và không phải là một cá thể Đường dẫn "mới" (dựa trên bộ đệm và sẽ là kết quả của phương thức getT tạm thời () của JDK7) -> Do đó, nó trả về những gì hầu hết mọi người cần khi họ muốn tạo một thư mục tạm thời.

Tôi thích nhiều nỗ lực tạo ra một tên duy nhất nhưng ngay cả giải pháp này cũng không loại trừ điều kiện chủng tộc. Một quy trình khác có thể trượt vào sau khi thử nghiệm exists()và if(newTempDir.mkdirs())gọi phương thức. Tôi không biết làm thế nào để hoàn toàn an toàn mà không cần dùng đến mã nguồn gốc, mà tôi cho rằng đó là những gì được chôn giấu bên trong File.createTempFile().

Trước Java 7, bạn cũng có thể:

File folder = File.createTempFile("testFileUtils", ""); // no suffix
folder.delete();
folder.mkdirs();
folder.deleteOnExit();

Hãy thử ví dụ nhỏ này:

Mã số:

try {
    Path tmpDir = Files.createTempDirectory("tmpDir");
    System.out.println(tmpDir.toString());
    Files.delete(tmpDir);
} catch (IOException e) {
    e.printStackTrace();
}

Nhập khẩu:
java.io.IOException
java.nio.file.Files
java.nio.file.Path

Đầu ra bảng điều khiển trên máy Windows:
C: \ Users \ userName \ AppData \ Local \ Temp \ tmpDir2908538301081367877

Nhận xét:
Files.createTempDirectory tạo ID duy nhất một cách tự nhiên - 2908538301081367877.

Lưu ý:
Đọc phần sau để xóa các thư mục đệ quy:
Xóa các thư mục đệ quy trong Java

Sử dụng File#createTempFilevà deleteđể tạo một tên duy nhất cho thư mục có vẻ ok. Bạn nên thêm một ShutdownHookđể xóa thư mục (đệ quy) khi tắt máy JVM.