Java实现验证文件名有效性的方法详解

 更新时间:2022年09月28日 08:34:16   作者:指北君  
在本文中,我们将讨论使用 Java 验证一个给定的字符串是否具有操作系统的有效文件名的不同方法,文中的示例代码讲解详细,感兴趣的可以了解一下

在本文中,我们将讨论使用 Java 验证一个给定的字符串是否具有操作系统的有效文件名的不同方法。我们可以根据限制的字符或长度限制来检查该值。

我们将只关注核心解决方案,不使用任何外部依赖。我们将使用JDK的java.io和NIO2包来实现我们验证方法。。

使用java.io.File

让我们从第一个例子开始,使用 java.io.File 类。在这个解决方案中,我们需要用一个给定的字符串创建一个File实例,然后在本地磁盘上创建一个文件。

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。让我们注意,由于里面的文件创建,这个方法需要给定的文件名字符串没有对应存在的文件。

我们知道,不同的文件系统有自己的文件名限制。通过使用 java.io.File 方法,我们不需要指定每个操作系统的规则,因为Java自动为我们解决了这个问题。

然而,我们需要创建一个假文件。当我们成功后,我们必须记得在最后删除它。此外,我们必须确保我们有适当的权限来执行这些操作。任何失败也可能导致IOException,所以也最好检查一下错误信息。

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

使用 NIO2 API

我们知道java.io包有很多缺点,因为它是在Java的第一个版本中创建的。NIO2 API是java.io包的后继者,它带来了许多改进,这也大大简化了我们之前的解决方案。

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

我们的功能现在被精简了,所以它是进行这种测试的最快方式。我们不创建任何文件,所以我们不需要有任何磁盘权限,也不需要在测试后执行清理。

无效的文件名抛出 nvalidPathException,它扩展了RuntimeException。这个的错误信息也包含了比之前更多的细节。

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

但是这个解决方案有一个严重的缺点,与文件系统的限制有关。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();

为了解决这个问题,我们应该像以前一样,创建一个文件并检查结果。

自定义的实现

最后,让我们尝试实现我们自己的自定义函数来测试文件名。我们还将尝试避免任何I/O功能,只使用核心的Java方法。

这类解决方案提供了更多的控制权,允许我们实现我们自己的规则。然而,我们必须考虑不同系统的许多额外限制。

使用String.contains

我们可以使用String.contains()方法来检查给定的String是否包含任何禁止的字符。首先,我们需要手动指定一些示例值。

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

在我们的例子中,让我们只关注这两个操作系统,Windows的文件名比UNIX的限制更多。另外,一些的空白字符可能会有问题。

在定义了受限制的字符集之后,让我们来确定当前的操作系统。

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[]{};
    }
}

而现在我们可以用它来测试给定的值。

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谓词返回真。此外,我们还实现了对null值和不正确长度的支持。

正则表达式模式匹配

我们也可以在给定的String上直接使用正则表达式。让我们来实现一个只接受字母数字和点字符的模式,其长度不超过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);
}

现在,我们可以根据先前准备的模式测试给定的值。我们还可以轻松地修改模式。在这个例子中,我们跳过了操作系统的检查功能。

总结

在这篇文章中,我们集中讨论了文件名及其限制。我们介绍了不同的算法,用Java检测无效的文件名。

我们从java.io包开始,它为我们解决了大部分的系统限制,但执行了额外的I/O动作,可能需要一些权限。然后我们检查了NIO2 API,它是最快的解决方案,但有文件名长度检查的限制。

最后,我们实现了我们自己的方法,不使用任何I/O API,但需要自定义实现文件系统规则。

到此这篇关于Java实现验证文件名有效性的方法详解的文章就介绍到这了,更多相关Java验证文件名内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 详解Java List中五种常见实现类的使用

    详解Java List中五种常见实现类的使用

    Java中提供了非常多的使用的List实现类,本文将重点介绍一下常见的五种实现类以及他们的应用场景,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-10-10
  • 如何解决Field name doesn‘t have a default value报错问题

    如何解决Field name doesn‘t have a defau

    这篇文章主要介绍了如何解决Field name doesn‘t have a default value报错问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • idea中maven使用tomcat7插件运行run报错Could not start Tomcat问题

    idea中maven使用tomcat7插件运行run报错Could not start T

    这篇文章主要介绍了idea中maven使用tomcat7插件运行run报错Could not start Tomcat问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-09-09
  • Java线程启动为什么要用start()而不是run()?

    Java线程启动为什么要用start()而不是run()?

    这篇文章主要介绍了线程启动为什么要用start()而不是run()?下面文章围绕start()与run()的相关资料展开详细内容,具有一定的参考价值,西药的小火熬版可以参考一下,希望对你有所帮助
    2021-12-12
  • java实现mongodb的数据库连接池

    java实现mongodb的数据库连接池

    这篇文章主要介绍了基于java实现mongodb的数据库连接池,Java通过使用mongo-2.7.3.jar包实现mongodb连接池,感兴趣的小伙伴们可以参考一下
    2015-12-12
  • 使用SpringBoot实现Redis多数据库缓存

    使用SpringBoot实现Redis多数据库缓存

    在我的系统中,为了优化用户行为数据的存储与访问效率,我引入了Redis缓存,并将数据分布在不同的Redis数据库中,通过这种方式,可以减少单一数据库的负载,提高系统的整体性能,所以本文给大家介绍了使用SpringBoot实现Redis多数据库缓存,需要的朋友可以参考下
    2024-06-06
  • Java 泛型考古 泛型擦除 包装类详细解析

    Java 泛型考古 泛型擦除 包装类详细解析

    泛型是在Java SE 1.5引入的的新特性,本质是参数化类型,也就是说所操作的数据类型被指定为一个参数。这种参数类型可以用在类、接口和方法的创建中,分别称为泛型类、泛型接口、泛型方法,本篇我们一起来学习泛型考古、泛型擦除、包装类
    2022-03-03
  • Java中驼峰命名与下划线命名相互转换

    Java中驼峰命名与下划线命名相互转换

    这篇文章主要介绍了Java中驼峰命名与下划线命名相互转换,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • Spring Boot如何配置yml配置文件定义集合、数组和Map

    Spring Boot如何配置yml配置文件定义集合、数组和Map

    这篇文章主要介绍了Spring Boot 优雅配置yml配置文件定义集合、数组和Map,包括Spring Boot yml配置文件定义基本数据类型和引用数据类型的方式,需要的朋友可以参考下
    2023-10-10
  • 设置JavaScript自动提示-Eclipse/MyEclipse

    设置JavaScript自动提示-Eclipse/MyEclipse

    自动提示需要2个组件,分别是:ext-4.0.2a.jsb2||spket-1.6.16.jar,需要的朋友可以参考下
    2016-05-05

最新评论