java路径操作工具类（PathUtils）

原创 已于 2024-10-01 08:25:14 修改 · 724 阅读 · 6 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #python #windows

于 2024-10-01 08:13:01 首次发布

PathUtils 工具类作用

   PathUtils是一个Java路径操作工具类，其主要作用是提供一系列方便的方法来操作和处理文件路径。

应用场景包括：

  1. 文件路径的拼接：PathUtils可以提供方法来拼接多个文件路径，例如可以将文件名和文件夹路径拼接在一起。

  2. 文件路径的解析：PathUtils可以提供方法来解析文件路径，例如可以获取文件的名称、文件的父路径等信息。

  3. 文件路径的规范化：PathUtils可以提供方法来规范化文件路径，例如可以去除文件路径中的冗余信息、统一文件路径的格式等。

  4. 文件路径的判断：PathUtils可以提供方法来判断文件路径是否存在、是否为文件夹、是否为文件等。

  5. 文件路径的转换：PathUtils可以提供方法来转换不同操作系统下的文件路径格式，例如可以将Windows下的文件路径转换为Linux下的文件路径。

PathUtils 工具类实现

package com.example.utils;

import java.io.File;
import java.io.IOException;
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.List;

/**
 * PathUtils 工具类
 * 提供路径操作的常用方法
 */
public class PathUtils {

    /**
     * 获取当前工作目录
     *
     * @return 当前工作目录的路径
     */
    public static String getCurrentWorkingDirectory() {
        return System.getProperty("user.dir");
    }

    /**
     * 获取用户主目录
     *
     * @return 用户主目录的路径
     */
    public static String getUserHomeDirectory() {
        return System.getProperty("user.home");
    }

    /**
     * 拼接路径
     *
     * @param basePath 基础路径
     * @param paths    要拼接的路径数组
     * @return 拼接后的完整路径
     */
    public static String joinPaths(String basePath, String... paths) {
        Path path = Paths.get(basePath, paths);
        return path.toString();
    }

    /**
     * 检查路径是否存在
     *
     * @param path 要检查的路径
     * @return 如果路径存在，返回 true；否则返回 false
     */
    public static boolean exists(String path) {
        return Files.exists(Paths.get(path));
    }

    /**
     * 判断路径是否是文件
     *
     * @param path 要检查的路径
     * @return 如果是文件，返回 true；否则返回 false
     */
    public static boolean isFile(String path) {
        return Files.isRegularFile(Paths.get(path));
    }

    /**
     * 判断路径是否是目录
     *
     * @param path 要检查的路径
     * @return 如果是目录，返回 true；否则返回 false
     */
    public static boolean isDirectory(String path) {
        return Files.isDirectory(Paths.get(path));
    }

    /**
     * 创建文件
     *
     * @param path 文件路径
     * @return 如果创建成功，返回 true；否则返回 false
     * @throws IOException 文件创建失败时抛出异常
     */
    public static boolean createFile(String path) throws IOException {
        Path filePath = Paths.get(path);
        if (exists(path)) {
            return false;
        }
        Files.createFile(filePath);
        return true;
    }

    /**
     * 创建目录
     *
     * @param path 目录路径
     * @return 如果创建成功，返回 true；否则返回 false
     * @throws IOException 目录创建失败时抛出异常
     */
    public static boolean createDirectory(String path) throws IOException {
        Path dirPath = Paths.get(path);
        if (exists(path)) {
            return false;
        }
        Files.createDirectories(dirPath);
        return true;
    }

    /**
     * 删除文件或目录
     *
     * @param path 文件或目录的路径
     * @return 如果删除成功，返回 true；否则返回 false
     * @throws IOException 删除失败时抛出异常
     */
    public static boolean delete(String path) throws IOException {
        Path targetPath = Paths.get(path);
        if (!exists(path)) {
            return false;
        }
        if (isDirectory(path)) {
            Files.walkFileTree(targetPath, new SimpleFileVisitor<Path>() {
                @Override
                public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
                    Files.delete(file);
                    return FileVisitResult.CONTINUE;
                }

                @Override
                public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
                    Files.delete(dir);
                    return FileVisitResult.CONTINUE;
                }
            });
        } else {
            Files.delete(targetPath);
        }
        return true;
    }

    /**
     * 列出目录中的所有文件和子目录
     *
     * @param path 目录路径
     * @return 包含所有文件和子目录路径的列表
     * @throws IOException 读取目录失败时抛出异常
     */
    public static List<String> listDirectory(String path) throws IOException {
        List<String> fileList = new ArrayList<>();
        try (DirectoryStream<Path> stream = Files.newDirectoryStream(Paths.get(path))) {
            for (Path entry : stream) {
                fileList.add(entry.toString());
            }
        }
        return fileList;
    }

    /**
     * 读取文件内容
     *
     * @param path 文件路径
     * @return 文件内容的字符串
     * @throws IOException 读取文件失败时抛出异常
     */
    public static String readFile(String path) throws IOException {
        return new String(Files.readAllBytes(Paths.get(path)));
    }

    /**
     * 写入内容到文件
     *
     * @param path    文件路径
     * @param content 要写入的内容
     * @param append  是否追加内容
     * @throws IOException 写入文件失败时抛出异常
     */
    public static void writeFile(String path, String content, boolean append) throws IOException {
        Path filePath = Paths.get(path);
        if (append) {
            Files.write(filePath, content.getBytes(), StandardOpenOption.CREATE, StandardOpenOption.APPEND);
        } else {
            Files.write(filePath, content.getBytes(), StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
        }
    }

    /**
     * 复制文件或目录
     *
     * @param sourcePath 源路径
     * @param targetPath 目标路径
     * @throws IOException 复制失败时抛出异常
     */
    public static void copy(String sourcePath, String targetPath) throws IOException {
        Path source = Paths.get(sourcePath);
        Path target = Paths.get(targetPath);
        if (isDirectory(sourcePath)) {
            Files.walkFileTree(source, new SimpleFileVisitor<Path>() {
                @Override
                public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
                    Files.createDirectories(target.resolve(source.relativize(dir)));
                    return FileVisitResult.CONTINUE;
                }

                @Override
                public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
                    Files.copy(file, target.resolve(source.relativize(file)), StandardCopyOption.REPLACE_EXISTING);
                    return FileVisitResult.CONTINUE;
                }
            });
        } else {
            Files.copy(source, target, StandardCopyOption.REPLACE_EXISTING);
        }
    }

    /**
     * 移动文件或目录
     *
     * @param sourcePath 源路径
     * @param targetPath 目标路径
     * @throws IOException 移动失败时抛出异常
     */
    public static void move(String sourcePath, String targetPath) throws IOException {
        Files.move(Paths.get(sourcePath), Paths.get(targetPath), StandardCopyOption.REPLACE_EXISTING);
    }

    /**
     * 获取文件的扩展名
     *
     * @param path 文件路径
     * @return 文件扩展名
     */
    public static String getFileExtension(String path) {
        String fileName = Paths.get(path).getFileName().toString();
        int lastDotIndex = fileName.lastIndexOf('.');
        return (lastDotIndex == -1) ? "" : fileName.substring(lastDotIndex + 1);
    }

    /**
     * 获取文件的名称（不含扩展名）
     *
     * @param path 文件路径
     * @return 文件名称
     */
    public static String getFileNameWithoutExtension(String path) {
        String fileName = Paths.get(path).getFileName().toString();
        int lastDotIndex = fileName.lastIndexOf('.');
        return (lastDotIndex == -1) ? fileName : fileName.substring(0, lastDotIndex);
    }
}

主要功能简介

  1. 路径获取：

    • getCurrentWorkingDirectory：获取当前工作目录的路径。
    • getUserHomeDirectory：获取用户主目录的路径。

  2. 路径拼接：

    • joinPaths：将多个路径拼接成一个完整路径。

  3. 路径检查：

    • exists：检查路径是否存在。
    • isFile：判断路径是否是文件。
    • isDirectory：判断路径是否是目录。

  4. 文件和目录操作：

    • createFile：创建文件。
    • createDirectory：创建目录。
    • delete：删除文件或目录，支持递归删除目录及其内容。
    • listDirectory：列出目录中的所有文件和子目录。

  5. 文件读写：

    • readFile：读取文件内容为字符串。
    • writeFile：将内容写入文件，支持追加模式和覆盖模式。

  6. 文件和目录复制移动：

    • copy：复制文件或目录，支持递归复制目录及其内容。
    • move：移动文件或目录到新位置。

  7. 文件名和扩展名操作：

    • getFileExtension：获取文件的扩展名。

getFileNameWithoutExtension：获取文件名，不含扩展名。

使用示例

import com.example.utils.PathUtils;

import java.io.IOException;
import java.util.List;

public class PathUtilsTest {
    public static void main(String[] args) {
        String testDir = PathUtils.joinPaths(PathUtils.getCurrentWorkingDirectory(), "testDir");
        String testFile = PathUtils.joinPaths(testDir, "testFile.txt");

        try {
            // 创建目录
            if (PathUtils.createDirectory(testDir)) {
                System.out.println("Directory created: " + testDir);
            } else {
                System.out.println("Directory already exists: " + testDir);
            }

            // 创建文件
            if (PathUtils.createFile(testFile)) {
                System.out.println("File created: " + testFile);
            } else {
                System.out.println("File already exists: " + testFile);
            }

            // 写入文件
            PathUtils.writeFile(testFile, "Hello, World!", false);
            System.out.println("Content written to file.");

            // 读取文件
            String content = PathUtils.readFile(testFile);
            System.out.println("Read content from file: " + content);

            // 列出目录内容
            List<String> fileList = PathUtils.listDirectory(testDir);
            System.out.println("Files in directory: " + fileList);

            // 获取文件扩展名和名称
            System.out.println("File extension: " + PathUtils.getFileExtension(testFile));
            System.out.println("File name without extension: " + PathUtils.getFileNameWithoutExtension(testFile));

            // 删除文件
            if (PathUtils.delete(testFile)) {
                System.out.println("File deleted: " + testFile);
            }

            // 删除目录
            if (PathUtils.delete(testDir)) {
                System.out.println("Directory deleted: " + testDir);
            }

        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

结论

PathUtils 工具类通过封装 Java NIO 提供的路径和文件操作功能，简化了路径的获取、拼接、检查以及文件和目录的创建、删除、读写等操作。该工具类提高了代码的可读性和开发效率，特别适合用于处理文件系统路径的各种场景。无论是路径的拼接、文件的读写、目录的管理还是路径的各种检查和操作，PathUtils 都提供了简单易用的接口，使得路径操作变得更加便捷。

总结

 PathUtils是一个Java路径操作工具类，用于处理文件路径的常见操作。它提供了一些静态方法，帮助开发人员简化路径操作的复杂度。

该工具类的主要功能包括：

  1. 获取路径的扩展名：提供了一个静态方法getExtension，用于从路径中获取文件的扩展名。例如，如果给定路径为“/path/to/file.txt”，则该方法将返回“txt”。

  2. 拼接路径：提供了一个静态方法concat，用于拼接多个路径片段。它会自动处理路径分隔符，确保生成的路径是正确的。例如，如果给定的路径片段为“/path/to”和“file.txt”，则该方法将返回“/path/to/file.txt”。

  3. 规范化路径：提供了一个静态方法normalize，用于规范化路径。它会移除路径中多余的分隔符，并处理“.”和“…”等特殊符号。例如，如果给定的路径为“/path/./to/…/file.txt”，则该方法将返回“/path/file.txt”。

  4. 获取文件名：提供了一个静态方法getFileName，用于从路径中提取文件名（包括扩展名）。例如，如果给定的路径为“/path/to/file.txt”，则该方法将返回“file.txt”。

  5. 获取文件所在目录：提供了一个静态方法getParentDirectory，用于从路径中获取文件所在的目录。例如，如果给定的路径为“/path/to/file.txt”，则该方法将返回“/path/to”。

java中的Path路径类以及File工具类[66]
FlymaAqi，芜湖，飞马阿起，passion！passion！
10-27 1514
java中的Path路径类以及File工具类[66]
PathUtils 路径拼接工具类
08-30
获取资源在不同系统下路径，拼接资源在不同系统下的路径。
java File文件处理工具类
12-01
从输入流中读取string，新建一个文件并写入内容，复制一个目录及其子目录、文件到另外一个目录 ，递归删除目录下的所有文件及子目录下所有文件，读取文本文件内容，以行的形式读取....
java 获取路径工具类
yehunn的专栏
03-18 938
这个问题就得看你的配置文件放在哪里啦,如果放在了项目的Classes目录(或子目录)下,你可以用**.Class.getResource('相对路径')来获取配置文件路径.如果是其他目录,那你只能在项目启动时通过ServletContext获取项目根目录+配置文件的目录来确定路径.并把路径放到类文件可以引用的地方啦. 以下是我在做项目时写的一个用于获取路径的类,写的可能不太好.但还是希望能对你有
java文件路径工具类_Java文件工具类
weixin_29377233的博客
02-19 510
Java文件工具类JavaUtils可以直接copy使用import java.io.File;import java.io.FileInputStream;import java.io.FileOutputStream;import java.io.FilenameFilter;import java.util.ArrayList;/** 文件工具类*/public class FileUti...
PathUtil
阿里旺仔。
09-29 1310
#ifndef PathUtil_h__ #define PathUtil_h__ #include class xPath { std::string path; int slashIndex; int extIndex; public: xPath(const char * fullpath) { path = fullpath; slashIndex = p
28个java常用的工具类
10-27
19. **文件路径处理工具类**：如`PathUtils`，处理文件路径，如`normalize()`规范化路径，`resolveSibling()`获取路径的兄弟路径。 20. **异常处理工具类**：如`ExceptionUtils`，提供异常的捕获、包装和处理，`...
全面整合Java工具类源码集锦：一步到位使用JavaUtils
13. **PathUtils.java**: 该工具类提供了文件路径操作的相关方法，如路径的拼接、标准化、路径查询等。 14. **PropertyBeanUtils.java**: 此工具类可能用于将属性文件（.properties）中的内容映射到Java对象（Bean...
Java集成工具类源代码集合，提高开发效率
具体包括Base64编码解码工具类、配置文件读取工具类、日期时间操作工具类、DES加密...路径操作工具类、属性映射工具类、Redis操作工具类、正则表达式工具类、定时任务工具类、服务定位工具类以及Shiro安全框架工具类等...
Java工具类源码解压使用指南
"Java工具类源码包解压缩后的文件列表包含了多个Java工具类的源代码文件，这些文件都是常用的Java开发辅助工具，涵盖了数据处理、文件操作、网络通信、加密解密、时间日期处理、HTTP请求、图片处理、正则表达式、...
java 路径 工具类,java 绝对路径工具类
weixin_28918553的博客
03-21 279
在程中我们常取一些资源的绝对径，下面给出一个简单方便的工具类来帮助我们轻松的找到我想的资源。(适用于CS/BS应用)import java.io.File;import java.io.IOException;import java.net.URI;import java.net.URISyntaxException;/** *//*** @author Maryang* @version $Re...
PathUtil java中获取路径的工具类，如WebClassesPath、WebInfPath、WebRoot
司刚军的个人专栏
08-12 4334
二话不说，直接上代码 package cn.sigangjun.util; /** * Title: Get Path Util * Description: this class can getWebClassesPath,getWebInfPath and getWebRoot * @since 2013-8-12 下午4:09:00 * @version 1.0
java 绝对路径工具类
lmlover的专栏
12-19 510
在程中我们常取一些资源的绝对径，下面给出一个简单方便的工具类来帮助我们轻松的找到我想的资源。（适用于CS/BS应用）import java.io.File;import java.io.IOException;import java.net.URI;import java.net.URISyntaxException; /** *//*** @author Maryan
java path util_Java操作文件Util
weixin_42494890的博客
02-16 330
1 packageio.guangsoft.utils;23 importjava.io.File;4 importjava.io.FileInputStream;5 importjava.io.FileOutputStream;6 importjava.io.IOException;7 importjava.nio.channels.FileChannel;8 importjava.util.A...
java 路径 工具类_java获取项目路径工具类
weixin_42514202的博客
02-12 348
public class UtilPath {/*** 获取到classes目录* @return path*/public static String getClassPath(){String systemName = System.getProperty("os.name");//windows 10//判断当前环境，如果是Windows 要截取路径的第一个 '/'//indexOf 方法返...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Flying_Fish_Xuan

你的鼓励将是我创作最大的动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值