Java實現(xiàn)驗證文件名有效性的方法詳解

更新時間：2022年09月28日 08:34:16 作者：指北君

在本文中，我們將討論使用?Java?驗證一個給定的字符串是否具有操作系統(tǒng)的有效文件名的不同方法，文中的示例代碼講解詳細，感興趣的可以了解一下

使用java.io.File

讓我們從第一個例子開始，使用 java.io.File 類。在這個解決方案中，我們需要用一個給定的字符串創(chuàng)建一個File實例，然后在本地磁盤上創(chuàng)建一個文件。

public?static?boolean?validateStringFilenameUsingIO(String?filename)?throws?IOException?{
????File?file?=?new?File(filename);
????boolean?created?=?false;
????try?{
????????created?=?file.createNewFile();
????????return?created;
????}?finally?{
????????if?(created)?{
????????????file.delete();
????????}
????}
}

當給定的文件名不正確時，它會拋出一個IOException。讓我們注意，由于里面的文件創(chuàng)建，這個方法需要給定的文件名字符串沒有對應存在的文件。

我們知道，不同的文件系統(tǒng)有自己的文件名限制。通過使用 java.io.File 方法，我們不需要指定每個操作系統(tǒng)的規(guī)則，因為Java自動為我們解決了這個問題。

然而，我們需要創(chuàng)建一個假文件。當我們成功后，我們必須記得在最后刪除它。此外，我們必須確保我們有適當?shù)臋嘞迊韴?zhí)行這些操作。任何失敗也可能導致IOException，所以也最好檢查一下錯誤信息。

assertThatThrownBy(()?->?validateStringFilenameUsingIO("javanorth?.txt"))
??.isInstanceOf(IOException.class)
??.hasMessageContaining("Invalid?file?path");

使用 NIO2 API

我們知道java.io包有很多缺點，因為它是在Java的第一個版本中創(chuàng)建的。NIO2 API是java.io包的后繼者，它帶來了許多改進，這也大大簡化了我們之前的解決方案。

public?static?boolean?validateStringFilenameUsingNIO2(String?filename)?{
????Paths.get(filename);
????return?true;
}

我們的功能現(xiàn)在被精簡了，所以它是進行這種測試的最快方式。我們不創(chuàng)建任何文件，所以我們不需要有任何磁盤權限，也不需要在測試后執(zhí)行清理。

無效的文件名拋出 nvalidPathException，它擴展了RuntimeException。這個的錯誤信息也包含了比之前更多的細節(jié)。

assertThatThrownBy(()?->?validateStringFilenameUsingNIO2(filename))
??.isInstanceOf(InvalidPathException.class)
??.hasMessageContaining("character?not?allowed");

但是這個解決方案有一個嚴重的缺點，與文件系統(tǒng)的限制有關。Path類可能表示帶有子目錄的文件路徑。與第一個例子不同，這個方法沒有檢查文件名字符的溢出限制。讓我們用Apache Commons的randomAlphabetic()方法生成的五百個字符的隨機String來檢查。

String?filename?=?RandomStringUtils.randomAlphabetic(500);
assertThatThrownBy(()?->?validateStringFilenameUsingIO(filename))
??.isInstanceOf(IOException.class)
??.hasMessageContaining("File?name?too?long");

assertThat(validateStringFilenameUsingNIO2(filename)).isTrue();

為了解決這個問題，我們應該像以前一樣，創(chuàng)建一個文件并檢查結果。

自定義的實現(xiàn)

最后，讓我們嘗試實現(xiàn)我們自己的自定義函數(shù)來測試文件名。我們還將嘗試避免任何I/O功能，只使用核心的Java方法。

這類解決方案提供了更多的控制權，允許我們實現(xiàn)我們自己的規(guī)則。然而，我們必須考慮不同系統(tǒng)的許多額外限制。

使用String.contains

我們可以使用String.contains()方法來檢查給定的String是否包含任何禁止的字符。首先，我們需要手動指定一些示例值。

public?static?final?Character[]?INVALID_WINDOWS_SPECIFIC_CHARS?=?{'"',?'`',?'<',?'>',?'?',?'|'};
public?static?final?Character[]?INVALID_UNIX_SPECIFIC_CHARS?=?{'\000'};

在我們的例子中，讓我們只關注這兩個操作系統(tǒng)，Windows的文件名比UNIX的限制更多。另外，一些的空白字符可能會有問題。

在定義了受限制的字符集之后，讓我們來確定當前的操作系統(tǒng)。

public?static?Character[]?getInvalidCharsByOS()?{
????String?os?=?System.getProperty("os.name").toLowerCase();
????if?(os.contains("win"))?{
????????return?INVALID_WINDOWS_SPECIFIC_CHARS;
????}?else?if?(os.contains("nix")?||?os.contains("nux")?||?os.contains("mac"))?{
????????return?INVALID_UNIX_SPECIFIC_CHARS;
????}?else?{
????????return?new?Character[]{};
????}
}

而現(xiàn)在我們可以用它來測試給定的值。

public?static?boolean?validateStringFilenameUsingContains(String?filename)?{
????if?(filename?==?null?||?filename.isEmpty()?||?filename.length()?>?255)?{
????????return?false;
????}
????return?Arrays.stream(getInvalidCharsByOS())
??????.noneMatch(ch?->?filename.contains(ch.toString()));
}

如果我們定義的任何字符不在給定的文件名中，這個Stream謂詞返回真。此外，我們還實現(xiàn)了對null值和不正確長度的支持。

正則表達式模式匹配

我們也可以在給定的String上直接使用正則表達式。讓我們來實現(xiàn)一個只接受字母數(shù)字和點字符的模式，其長度不超過255。

public?static?final?String?REGEX_PATTERN?=?"^[A-za-z0-9.]{1,255}$";

public?static?boolean?validateStringFilenameUsingRegex(String?filename)?{
????if?(filename?==?null)?{
????????return?false;
????}
????return?filename.matches(REGEX_PATTERN);
}

現(xiàn)在，我們可以根據(jù)先前準備的模式測試給定的值。我們還可以輕松地修改模式。在這個例子中，我們跳過了操作系統(tǒng)的檢查功能。