Java File中renameTo的介绍和使用说明

全栈程序员-站长 • 2022年2月26日下午8:00 • 未分类 • 阅读 42

大家好，又见面了，我是全栈君。

看到项目中有个地方用的File的renameTo这个方法，本以为这个方法就是用来文件重命名的，但是项目中确用它来进行文件的移动。就是使用renameTo将一个文件从一个目录移动另一个目录下！

下面就简单介绍一下renameTo，并整理一个renameTo的使用！

renameTo的介绍

官方文档说明

/**
 * 
 重新命名此抽象路径名表示的文件。
 此方法行为的许多方面都是与平台有关的：重命名操作无法将一个文件从
 一个文件系统移动到另一个文件系统，
 该操作不是不可分的，如果已经存在具有目标抽象路径名的文件，
 那么该操作可能无法获得成功。应该始终检查返回值，以确保重命名操作成功。

 参数：
 dest - 指定文件的新抽象路径名
 返回：
 当且仅当重命名成功时，返回 true；否则返回 false
 抛出：
 SecurityException - 如果存在安全管理器，且其 SecurityManager.checkWrite(java.lang.String) 方法拒绝对原路径名和新路径名进行写访问
 NullPointerException - 如果参数 dest 为 null
 */
public boolean renameTo(File dest) {
        SecurityManager security = System.getSecurityManager();
        if (security != null) {
            security.checkWrite(path);
            security.checkWrite(dest.path);
        }
        if (dest == null) {
            throw new NullPointerException();
        }
        if (this.isInvalid() || dest.isInvalid()) {
            return false;
        }
        return fs.rename(this, dest);
    }

解释一下官方文档说明

重新命名此抽象路径名表示的文件。

主要功能是重命名文件的！

此方法行为的许多方面都是与平台有关的：重命名操作无法将一个文件从一个文件系统移动到另一个文件系统，该操作不是不可分的

两点：1、文件可以进行移动；2、在同一平台操作

如果已经存在具有目标抽象路径名的文件，那么该操作可能无法获得成功。应该始终检查返回值，以确保重命名操作成功。

两点：1、如果目标路径下有相同的文件名称，则命名失败（或者移动失败）；2、实际开发中要注意返回值，为true则表示命名（移动）成功！

renamTo使用说明

第一种场景：同一路径下文件重命名【文件重命名】

说明：将E:\hello\test\1.txt下的 1.txt 重名为2.txt ！
如果test路径下1.txt 不存在，那么返回false。

		File oldName = new File("E:\\hello\\test\\1.txt");
        File newName = new File("E:\\hello\\test\\2.txt");
        System.out.println(oldName.renameTo(newName));//true

第二种场景：将文件从一个路径移动另一个路径下，并且移动的文件进行重命名【文件移动重命名】

说明：将E:\hello\test\1.txt下的 1.txt 移动到E:\hello1\test1\路径下，并重名命名为2.txt .
其中 E:\hello1\test1必须要存在，否则返回false 。

		File oldName = new File("E:\\hello\\test\\1.txt");
        File newName = new File("E:\\hello1\\test1\\2.txt");
        System.out.println(oldName.renameTo(newName));//true

第三种场景：修改文件夹的名称，文件夹里面没有文件的时候修改成功！

说明：修改文件夹名称，这个目录必须存在 E:\hello\dufy。
其中如果 E:\hello\dufy 这个目录不为空，返回false。

		File oldNamed = new File("E:\\hello\\dufy");
        File newNamed = new File("E:\\hello\\dufy_fly");
        System.out.println(oldNamed.renameTo(newNamed)); //true