File文件操作工具类

已于 2023-11-24 09:46:07 修改
阅读量97 收藏
点赞数
分类专栏： java 文章标签： java
于 2023-09-22 15:21:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/bankq/article/details/133172421
版权 
import lombok.extern.slf4j.Slf4j;
import org.apache.tomcat.util.http.fileupload.util.Streams;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.net.URLEncoder;
import java.util.List;

/**
 * @author bkq
 * @since 2023/03/30
 */
@Slf4j
public class FileUtil {

    // 下划线
    public static final String UNDER_LINE = "_";

    /**
     * 上传文件(返回完整的路径信息)
     *
     * @param file       文件
     * @param uploadPath 上传路径
     */
    public static ResultVo<String> uploadFile(MultipartFile file, String uploadPath) {
        // 1.获取一个新的文件名
        String newFileName = getNewFileName(file);
        if (StringUtil.isEmpty(newFileName)) {
            log.error("【上传文件】转换文件名称失败");
            return ResultVo.error("【上传文件】转换文件名称失败");
        }
        // 2.获取文件上传路径
        if (StringUtil.isEmpty(uploadPath)) {
            log.error("【上传文件】获取文件上传路径失败");
            return ResultVo.error("【上传文件】获取文件上传路径失败");
        }
        uploadPath = uploadPath + File.separator + DateUtil.getCurrentDate();
        // 3.生成上传目录
        File uploadDir = mkdirs(uploadPath);
        if (!uploadDir.exists()) {
            log.error("【上传文件】生成上传目录失败");
            return ResultVo.error("【上传文件】生成上传目录失败");
        }
        // 4.文件全路径
        String fileFullPath = uploadPath + File.separator + newFileName;
        log.info("上传的文件：" + file.getName() + "，" + file.getContentType() + "，保存的路径为：" + fileFullPath);
        try {
            // 5.上传文件
            doUploadFile(file, fileFullPath);
        } catch (IOException e) {
            log.error("【上传文件】上传文件报IO异常，异常信息为{}", e.getMessage());
            return ResultVo.error(e.getMessage());
        }
        return ResultVo.success(fileFullPath);
    }

    /**
     * 上传文件(返回文件静态资源路径，)
     *
     * @param file     文件
     * @param filePath 上传路径
     */
    public static ResultVo<String> uploadFile2(MultipartFile file, String filePath, String fileName) {
        // 1.获取一个新的文件名
        //文件上传名字重复后缀+1 获得+1后的文件名
        String newFileName = FileUtil.checkFileName(filePath, fileName);
        if (StringUtil.isEmpty(newFileName)) {
            log.error("【上传文件】转换文件名称失败");
            return ResultVo.error("【上传文件】转换文件名称失败");
        }
        // 2.获取文件上传路径
        if (StringUtil.isEmpty(filePath)) {
            log.error("【上传文件】获取文件上传路径失败");
            return ResultVo.error("【上传文件】获取文件上传路径失败");
        }
        String uploadPath = filePath;
        // 3.生成上传目录
        File uploadDir = mkdirs(uploadPath);
        if (!uploadDir.exists()) {
            log.error("【上传文件】生成上传目录失败");
            return ResultVo.error("【上传文件】生成上传目录失败");
        }
        // 4.文件相对路径
        String fileFullPath = uploadPath + File.separator + newFileName;//全路径
        log.info("上传的文件：" + file.getOriginalFilename() + "，" + file.getContentType() + "，保存的路径为：" + fileFullPath);
        try {
            // 5.上传文件
            doUploadFile(file, fileFullPath);
        } catch (IOException e) {
            log.error("【上传文件】上传文件报IO异常，异常信息为{}", e.getMessage());
            return ResultVo.error(e.getMessage());
        }
        return ResultVo.success(fileFullPath);
    }


    /**
     * 将上传的文件转换为一个新的文件名
     *
     * @param file 文件
     */
    public static String getNewFileName(MultipartFile file) {
        // 1.获取上传的文件名称（包含后缀。如：test.jpg）
        String originalFilename = file.getOriginalFilename();
        log.info("【上传文件】上传的文件名为{}", originalFilename);
        // 2.以小数点进行分割
        String[] split = originalFilename.split("\\.");
        String newFileName = null;
        if (null == split || split.length == 0) {
            return null;
        }
        StringBuilder builder = new StringBuilder();
        if (1 == split.length) {
            // 3.此文件无后缀
            newFileName = builder.append(originalFilename).append(UNDER_LINE).append(System.nanoTime()).toString();
            return newFileName;
        }
        // 4.获取文件的后缀
        String fileSuffix = split[split.length - 1];
        for (int i = 0; i < split.length - 1; i++) {
            builder.append(split[i]);
            if (null != split[i + 1] && "" != split[i + 1]) {
                builder.append(UNDER_LINE);
            }
        }
        newFileName = builder.append(System.nanoTime()).append(".").append(fileSuffix).toString();
        return newFileName;
    }

    /**
     * 获取文件夹中相同文件名的最大数，
     * 比如 1。txt\1(1).txt\1\(2).txt\1(4).txt
     * 获取的值为 5
     * @param filePath
     * @param fileName
     * @return
     */
    public static int getFileMax(String filePath, String fileName) {
        File file = new File(filePath);
        File[] files;
        int number = 0;
        if (file.isDirectory()) {
            files = file.listFiles();
            for (int i = 0; i < files.length; i++) {
                File f = files[i];
                if (f.isFile()
                        && (f.getName().substring(0, f.getName().lastIndexOf("."))
                        .contains(fileName.substring(0, fileName.lastIndexOf(".")))
                        && f.getName().substring(f.getName().lastIndexOf("."))
                        .equals(fileName.substring(fileName.lastIndexOf("."))))) {
                    if (f.getName().lastIndexOf("(") > 0 || f.getName().lastIndexOf(")") > 0) {
                        String substring = f.getName().substring(f.getName().lastIndexOf("(") + 1, f.getName().lastIndexOf(")"));
                        if (StringUtil.isNotEmpty(substring)) {
                            if (number < Integer.parseInt(substring)) {
                                number = Integer.parseInt(substring);
                            }
                        }
                    }else {
                        number = number + 1;
                    }
                }
            }
        }
        return number;
    }

    /**
     * 校验文件名称相同，若相同后缀(+n)
     *
     * @param filePath 文件路径
     * @param fileName 文件名称
     * @return 新文件名称
     */
    public static String checkFileName(String filePath, String fileName) {
        int fileMax = getFileMax(filePath, fileName);
        //重复的文件名
        StringBuilder newFileName = new StringBuilder();
        if (fileMax > 0) {
            newFileName.append(fileName.substring(0, fileName.lastIndexOf("."))).
                    append("(" + fileMax + ")").append(fileName.substring(fileName.lastIndexOf(".")));
        } else {
            newFileName.append(fileName);
        }
        return newFileName.toString();
    }


    /**
     * 生成相应的目录
     *
     * @param path
     */
    public static File mkdirs(String path) {
        File file = new File(path);
        if (!file.exists() || !file.isDirectory()) {
            file.mkdirs();
        }
        return file;
    }


    /**
     * 上传文件
     *
     * @param file
     * @param path
     * @throws IOException
     */
    public static void doUploadFile(MultipartFile file, String path) throws IOException {
        Streams.copy(file.getInputStream(), new FileOutputStream(path), true);
    }


    /**
     * 递归删除目录下的所有文件及子目录下所有文件
     *
     * @param file
     */
    public static boolean deleteFile(File file) {
        if (!file.exists()) {
            return false;
        }
        if (file.isDirectory()) {
            String[] children = file.list();
            //递归删除目录中的子目录下
            for (int i = 0; i < children.length; i++) {
                boolean success = deleteFile(new File(file, children[i]));
                if (!success) {
                    return false;
                }
            }
        }
        // 目录此时为空，可以删除
        return file.delete();
    }


    /**
     * 根据传入的文件路径，下载文件
     *
     * @param filePath
     * @param response
     * @return
     */
    public static ResultVo<String> downloadFile(String filePath, HttpServletResponse response) {
        File file = new File(filePath);
        // 1.参数校验
        if (!file.exists()) {
            log.error("【下载文件】文件路径{}不存在", filePath);
            return ResultVo.error("文件不存在");
        }
        // 2.下载文件
        log.info("【下载文件】下载文件的路径为{}", filePath);
        return FileUtil.downloadFile(file, response);
    }

    /**
     * 下载文件
     *
     * @param file
     * @param response
     * @return
     */
    public static ResultVo<String> downloadFile(File file, HttpServletResponse response) {
        try {
            // 1.设置响应头
            setResponse(file, response);
        } catch (UnsupportedEncodingException e) {
            log.error("文件名{}不支持转换为字符集{}", file.getName(), "UTF-8");
            return ResultVo.error(e.getMessage());
        }
        // 2.下载文件
        return doDownLoadFile(file, response);
    }

    /**
     * 设置响应头
     *
     * @param file
     * @param response
     * @throws UnsupportedEncodingException
     */
    public static void setResponse(File file, HttpServletResponse response) throws UnsupportedEncodingException {
        // 清空response
        response.reset();
        //表示所有的域都可以接受
        response.setHeader("Access-Control-Allow-Origin", "*");
        //允许所有的方法
        response.setHeader("Access-Control-Allow-Methods", "POST,GET,DELETE,PUT,OPTIONS");
        //请求得到结果的有效期
        response.setHeader("Access-Control-Max-Age", "3600");
        response.setHeader("Access-Control-Allow-Headers", "x-requested-with,Content-Type,access-control-allow-origin,version-info");
        //该值是一个boolean值,表示允许发送cookie，默认情况下cookie不包含在cores中，设置为true
        response.setHeader("Access-Control-Allow-Credentials", "true");

        response.setCharacterEncoding("UTF-8");
        // 返回给客户端类型，任意类型
        response.setContentType("application/octet-stream");
        // Content-Disposition的作用：告知浏览器以何种方式显示响应返回的文件，用浏览器打开还是以附件的形式下载到本地保存
        // attachment表示以附件方式下载 inline表示在线打开 "Content-Disposition: inline; filename=文件名.mp3"
        response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(file.getName(), "UTF-8"));
        // 告知浏览器文件的大小
        response.addHeader("Content-Length", String.valueOf(file.length()));
    }

    /**
     * 通过流的形式下载文件
     *
     * @param file
     * @param response
     * @return
     */
    public static ResultVo<String> doDownLoadFile(File file, HttpServletResponse response) {

        // 将输入流中的数据循环写入到响应输出流中，而不是一次性读取到内存，通过响应输出流输出到前端
        try (InputStream in = new FileInputStream(file);
             OutputStream out = response.getOutputStream()) {
            byte[] buffer = new byte[1024];
            int len = 0;
            while ((len = in.read(buffer)) != -1) {
                out.write(buffer, 0, len);
            }
            log.info("【文件下载】文件下载成功");
            return null;
        } catch (FileNotFoundException e) {
            log.error("【文件下载】下载文件时，没有找到相应的文件，文件路径为{}", file.getAbsolutePath());
            return ResultVo.error(e.getMessage());
        } catch (IOException e) {
            log.error("【文件下载】下载文件时，出现文件IO异常");
            return ResultVo.error(e.getMessage());
        }
    }

    /**
     * 校验文件为TXT
     *
     * @param file
     * @return
     */
    public static boolean checkTxtExtension(MultipartFile file) {
        String filename = file.getOriginalFilename();
        if (StringUtil.isEmpty(filename)) {
            log.info("【校验TXT文件后缀】TXT文件名为空");
            return false;
        }
        int index = filename.lastIndexOf(".");
        if (index == -1) {
            log.info("【校验TXT文件后缀】TXT文件名中没有点号");
            return false;
        }
        String extension = filename.substring(index + 1);
        return "txt".equals(extension);
    }


    /**
     * 写入文件
     *
     * @param filePath 文件路径
     * @param textList 文件行内容
     * @throws IOException 异常信息
     */
    public static void writeTxtFile(String filePath, List<String> textList) {
        FileWriter fileWriter = null;
        BufferedWriter bufferedWriter = null;
        try {
            File file = new File(filePath);
            file.createNewFile();
            fileWriter = new FileWriter(file);
            bufferedWriter = new BufferedWriter(fileWriter);
            for (String text : textList) {
                bufferedWriter.write(text);
                bufferedWriter.newLine();
            }
            bufferedWriter.flush();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                fileWriter.close();
                bufferedWriter.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

}

统一返回类

import com.byd.common.constant.ResultCodeEnum;
import lombok.Data;

/**
 * @author s.bankaiqi
 * @since 2023/03/30
 */
@Data
public class ResultVo<T> {

    // 错误码
    private Integer code;

    // 提示信息
    private String msg;

    // 返回的数据
    private T data;

    // 判断是否成功
    public boolean checkSuccess() {
        return ResultCodeEnum.SUCCESS.getCode().equals(this.code);
    }

    public static ResultVo success() {
        return success(null);
    }

    public static ResultVo success(String msg, Object object) {
        ResultVo result = new ResultVo();
        result.setCode(ResultCodeEnum.SUCCESS.getCode());
        result.setMsg(msg);
        result.setData(object);
        return result;
    }

    public static ResultVo success(Object object) {
        ResultVo result = new ResultVo();
        result.setCode(ResultCodeEnum.SUCCESS.getCode());
        result.setMsg("成功");
        result.setData(object);
        return result;
    }

    public static ResultVo success(Integer code, Object object) {
        return success(code, null, object);
    }

    public static ResultVo success(Integer code, String msg, Object object) {
        ResultVo result = new ResultVo();

        result.setCode(code);
        result.setMsg(msg);
        result.setData(object);
        return result;
    }

    public static ResultVo error(String msg) {
        ResultVo result = new ResultVo();
        result.setCode(ResultCodeEnum.ERROR.getCode());
        result.setMsg(msg);
        return result;
    }

    public static ResultVo error(Integer code, String msg) {
        ResultVo result = new ResultVo();
        result.setCode(code);
        result.setMsg(msg);
        return result;
    }

    public static ResultVo error(String msg,Object object) {
        ResultVo result = new ResultVo();
        result.setCode(ResultCodeEnum.ERROR.getCode());
        result.setMsg(msg);
        result.setData(object);
        return result;
    }

    public static ResultVo error(Integer code, String msg, Object object) {
        ResultVo result = new ResultVo();
        result.setCode(code);
        result.setMsg(msg);
        result.setData(object);
        return result;
    }
}

返回枚举类

import lombok.Getter;

/**
 * @author s.bankaiqi
 * @since 2023/03/30
 */
@Getter
public enum ResultCodeEnum {

    SUCCESS(200, "成功"),
    CHECK_SUCCESS(203, "导入校验成功"),
    CONFIRM(302, "覆盖确认"),
    CONFIRM_UPDATE(303, "更新确认"),
    PARAM_ERROR(400, "参数错误"),
    ERROR(500, "错误"),
    FILE_NOT_EXIST(501, "文件不存在"),
    CLOSE_FAILD(504, "关闭流失败");

    private Integer code;
    private String message;

    ResultCodeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

}

bankq
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
file文件操作工具类
03-25
通过输入文件地址和目标地址，对文件的复制操作，通过输入File对象和目标File对象，对文件的辅助操作
java文件操作工具类分享(file文件工具类)
09-04
java文件操作工具类(文件工具类)
Java文件操作常用工具类
程序员小屋
06-24 1764
工具类的名称：FileUtil工具类的功能：提供文件相关的操作方法，包括文件读取、写入、复制、删除等。
mid、mif文件操作工具类
热门推荐
二十同学
08-17 6万+
读写mid、mif文件操作工具类 装载mid文件,将mid文件里的数据变为 List<List<String>> 形式的 public List<List<String>> loadMidFile(File file) { List<List<String>> midRows= new...
文件上传工具类FileUploadUtils
输入技术、输出想法
08-06 3844
文件上传工具类FileUploadUtilsStringUtilMimeTypeUtilsFileUploadUtils异常类FileNameLengthLimitExceededExceptionFileSizeLimitExceededExceptionInvalidExtensionExceptionController层 StringUtil /** * 字符串工具类，抽取一些常用操作 */ public class StringUtil { /** * 判断val是否不为空
Java文件操作工具类FileUtils
学习达人的日记本
01-26 1万+
package com.suobei.xinzhiying.base.utils.file; import com.suobei.xinzhiying.base.result.ResponseMap; import com.suobei.xinzhiying.base.utils.aliyun.AliOssUtils; import com.suobei.xinzhiying.base.util
Java中File文件类操作使用方法大全
qq_43751200的博客
04-30 3944
Java中File文件类操作使用方法大全File类概述File类的常用API判断文件类型、获取文件信息创建文件、删除文件功能遍历文件夹File类相关的API的练习题 File类概述 File类在包java.io.File下、代表操作系统的文件对象（文件、文件夹）。 File类提供了诸如：定位文件，获取文件本身的信息、删除文件、创建文件（文件夹）等功能。 File类创建对象 方法名称 说明 public File (String pathname) 根据文件路径创建文件对象 public
FileUtils（文件读写操作工具类）
qq_43418738的博客
07-29 4092
File Write and Read import java.io.*; import java.nio.channels.FileChannel; /** * @author 董云川 * @version 1.0 * @date 2021/7/28 16:59 * 文件操作工具类 * 对文件的相关操作 * 文件读取等操作 */ public class FileUtils { private static String TAG = "FileUtils"; /*判断文件
文件操作工具类FileUtils
wenzhi的博客
12-03 2655
使用这个文件工具类可以方便的对图片资源的存储读取,还可以很方便的对文件进行遍历，选择你需要的文件。
Android文件操作工具类
anonymousCoder的博客
04-01 3119
贴上我写的一个文件操作工具类，基本上覆盖了各种文件操作： 1、文件的新建、删除； 2、文件的复制； 3、获取文件扩展名； 4、文件的重命名； 5、获取某个文件的详细信息； 6、计算某个文件的大小； 7、文件大小的格式化； 8、获取某个路径下的文件列表； 9、获取某个目录下的文件列表； 10、目录的新建、删除; 11、目录的复制； 12、计算某个目录包含的文件数量； 1
21.1 使用PEfile分析PE文件
CSDN
08-10 1万+
PeFile模块是`Python`中一个强大的便携式第三方`PE`格式分析工具，用于解析和处理`Windows`可执行文件。该模块提供了一系列的API接口，使得用户可以通过`Python`脚本来读取和分析PE文件的结构，包括文件头、节表、导入表、导出表、资源表、重定位表等等。此外，PEfile模块还可以帮助用户进行一些恶意代码分析，比如提取样本中的字符串、获取函数列表、重构导入表、反混淆等等。PEfile模块是Python中处理PE文件的重要工具之一，广泛应用于二进制分析、安全研究和软件逆向工程等领域。
超全的文件工具类 FileUtil
安东尼的博客
03-04 1万+
结合以前的项目开发中遇到的不同的文件操作，在这里基本上提取出了所遇到过的文件操作的工具类。1 我项目中用到的文件工具类1 读取raw文件、file文件，drawable文件，asset文件，比如本地的json数据，本地文本等； 如：String result =FileUtil.getString(context,”raw://first.json”) 2 读取本地的property文件，并
java文件操作工具类
11-11
java文件操作工具类是java中针对文件操作的一个工具类，可以方便的读取，下载，上传文件等操作，希望可以帮到大家。
工具类：操作文件
08-01
操作文件的工具类分享给大家操作文件的工具类分享给大家
简单的项目部署脚本（转载）
u010230019的博客
06-09 640
有些项目团队喜欢使用docker启动java服务,那么我们同样可以将上述脚本稍做改造,来实现基于shell+docker的简单项目部署能力。可以将核心节点的错误或者失败内容通过webhook发送到对应的告警平台,比如钉钉、飞书机器人等。把~/.ssh/id_rsa.pub内容添加到远程仓库的ssh秘钥中。执行start.sh脚本打包部署。start.sh脚本内容。
Java——简单图书管理系统
m0_74100417的博客
06-09 1388
数据类型变量iffor数组方法类和对象封装继承多态抽象类和接口今天就是把上述知识点全部都用起来 图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理
修改菜品——后端Java
weixin_53717695的博客
06-09 451
修改菜品——后端Java
（Javascript）AI数字人mp4转canvas播放并去除背景绿幕
最新发布
lx_nhs的博客
06-12 443
去除前：去除后： 3、可能会出现的报错 （1）视频路径跨域问题：解决：vue开启代理
【Java02】Java中数组的定义与初始化
饮冰室
06-10 540
推荐第一种方式。这种方式容易让人理解，数据类型是type[]，对象名称是arrayName。第二种方式有些老旧了。由于数组是一种引用变量（也就是一个指针），所以定义的时候还没有指向任何有效的内存空间，因此在定义数组的时候不能指定数组的长度，也不能直接使用。必须进行初始化。可以使用var让系统自动推断变量类型，既可以用于静态初始化，也可以用于动态初始化。
apache 文件工具类
10-24
Apache文件工具类是Apache Commons Lang3工具包中的一个类，提供了一系列用于文件操作的方法，例如读取文件、写入文件、复制文件、删除文件等。这些方法可以大大简化Java程序中的文件操作，提高开发效率。其中，常用...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值