java-FTP 操作工具类（FTPUtils）

已于 2024-10-01 08:30:19 修改
阅读量1.2k 收藏 8
点赞数 3
文章标签： java python 开发语言
于 2024-10-01 08:04:47 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Flying_Fish_roe/article/details/142656249
版权

FTPUtils 工具类应用场景

    场景：需要在Java程序中实现FTP文件的上传、下载、删除等操作时，可以使用FTPUtils工具类来简化操作。

作用：

  1. 实现FTP文件的上传：通过FTPUtils工具类，可以将本地文件上传到FTP服务器。
  2. 实现FTP文件的下载：通过FTPUtils工具类，可以将FTP服务器上的文件下载到本地。
  3. 实现FTP文件的删除：通过FTPUtils工具类，可以删除FTP服务器上的文件。
  4. 实现FTP文件夹的创建：通过FTPUtils工具类，可以在FTP服务器上创建文件夹。
  5. 实现FTP文件夹的删除：通过FTPUtils工具类，可以删除FTP服务器上的文件夹。
  6. 实现FTP文件夹的遍历：通过FTPUtils工具类，可以获取FTP服务器上指定目录下的所有文件和文件夹。
  7. 实现FTP文件的重命名：通过FTPUtils工具类，可以将FTP服务器上的文件重命名。

FTPUtils 工具类添加依赖

要使用该类，你需要先添加依赖库：

<!-- 添加 Apache Commons Net 依赖 -->
<dependency>
    <groupId>commons-net</groupId>
    <artifactId>commons-net</artifactId>
    <version>3.8.0</version>
</dependency>

FTPUtils 工具类

package com.example.ftp;

import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPReply;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * FTP工具类，封装了FTP文件的上传、下载、删除、列出文件等常见操作。
 */
public class FTPUtils {

    private static final Logger LOGGER = Logger.getLogger(FTPUtils.class.getName());
    private FTPClient ftpClient;
    private String server;
    private int port;
    private String user;
    private String password;

    /**
     * 构造函数，初始化FTP连接信息。
     *
     * @param server   FTP服务器地址
     * @param port     FTP端口号
     * @param user     FTP用户名
     * @param password FTP密码
     */
    public FTPUtils(String server, int port, String user, String password) {
        this.server = server;
        this.port = port;
        this.user = user;
        this.password = password;
        this.ftpClient = new FTPClient();
    }

    /**
     * 连接到FTP服务器。
     *
     * @throws IOException 如果连接失败抛出异常
     */
    public void connect() throws IOException {
        ftpClient.connect(server, port);
        int replyCode = ftpClient.getReplyCode();
        if (!FTPReply.isPositiveCompletion(replyCode)) {
            throw new IOException("无法连接到FTP服务器，回复码: " + replyCode);
        }
        boolean success = ftpClient.login(user, password);
        if (!success) {
            throw new IOException("FTP登录失败，请检查用户名和密码。");
        }
        ftpClient.enterLocalPassiveMode();  // 切换到被动模式
        LOGGER.info("成功连接到FTP服务器 " + server + "，端口: " + port);
    }

    /**
     * 断开与FTP服务器的连接。
     *
     * @throws IOException 如果断开失败抛出异常
     */
    public void disconnect() throws IOException {
        if (ftpClient.isConnected()) {
            ftpClient.logout();
            ftpClient.disconnect();
            LOGGER.info("成功断开与FTP服务器的连接。");
        }
    }

    /**
     * 上传文件到FTP服务器的指定目录。
     *
     * @param localFilePath 本地文件路径
     * @param remoteFilePath 远程文件路径
     * @return 上传是否成功
     * @throws IOException 如果上传失败抛出异常
     */
    public boolean uploadFile(String localFilePath, String remoteFilePath) throws IOException {
        try (InputStream inputStream = new FileInputStream(new File(localFilePath))) {
            ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
            boolean done = ftpClient.storeFile(remoteFilePath, inputStream);
            if (done) {
                LOGGER.info("文件上传成功: " + localFilePath + " -> " + remoteFilePath);
                return true;
            } else {
                LOGGER.warning("文件上传失败: " + localFilePath + " -> " + remoteFilePath);
                return false;
            }
        }
    }

    /**
     * 从FTP服务器下载文件。
     *
     * @param remoteFilePath 远程文件路径
     * @param localFilePath  本地保存路径
     * @return 下载是否成功
     * @throws IOException 如果下载失败抛出异常
     */
    public boolean downloadFile(String remoteFilePath, String localFilePath) throws IOException {
        try (OutputStream outputStream = new FileOutputStream(new File(localFilePath))) {
            ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
            boolean done = ftpClient.retrieveFile(remoteFilePath, outputStream);
            if (done) {
                LOGGER.info("文件下载成功: " + remoteFilePath + " -> " + localFilePath);
                return true;
            } else {
                LOGGER.warning("文件下载失败: " + remoteFilePath + " -> " + localFilePath);
                return false;
            }
        }
    }

    /**
     * 从FTP服务器删除文件。
     *
     * @param remoteFilePath 远程文件路径
     * @return 删除是否成功
     * @throws IOException 如果删除失败抛出异常
     */
    public boolean deleteFile(String remoteFilePath) throws IOException {
        boolean deleted = ftpClient.deleteFile(remoteFilePath);
        if (deleted) {
            LOGGER.info("文件删除成功: " + remoteFilePath);
            return true;
        } else {
            LOGGER.warning("文件删除失败: " + remoteFilePath);
            return false;
        }
    }

    /**
     * 列出FTP服务器指定目录下的所有文件和目录。
     *
     * @param remoteDirPath 远程目录路径
     * @return 文件列表
     * @throws IOException 如果列出文件失败抛出异常
     */
    public FTPFile[] listFiles(String remoteDirPath) throws IOException {
        FTPFile[] files = ftpClient.listFiles(remoteDirPath);
        if (files != null && files.length > 0) {
            LOGGER.info("列出目录成功: " + remoteDirPath);
        } else {
            LOGGER.warning("目录为空或列出目录失败: " + remoteDirPath);
        }
        return files;
    }

    /**
     * 切换工作目录。
     *
     * @param remoteDirPath 远程目录路径
     * @return 切换是否成功
     * @throws IOException 如果切换目录失败抛出异常
     */
    public boolean changeWorkingDirectory(String remoteDirPath) throws IOException {
        boolean success = ftpClient.changeWorkingDirectory(remoteDirPath);
        if (success) {
            LOGGER.info("成功切换到目录: " + remoteDirPath);
        } else {
            LOGGER.warning("无法切换到目录: " + remoteDirPath);
        }
        return success;
    }

    /**
     * 在FTP服务器上创建新目录。
     *
     * @param remoteDirPath 远程目录路径
     * @return 创建是否成功
     * @throws IOException 如果创建目录失败抛出异常
     */
    public boolean makeDirectory(String remoteDirPath) throws IOException {
        boolean created = ftpClient.makeDirectory(remoteDirPath);
        if (created) {
            LOGGER.info("成功创建目录: " + remoteDirPath);
        } else {
            LOGGER.warning("无法创建目录: " + remoteDirPath);
        }
        return created;
    }

    /**
     * 删除FTP服务器上的目录。
     *
     * @param remoteDirPath 远程目录路径
     * @return 删除是否成功
     * @throws IOException 如果删除目录失败抛出异常
     */
    public boolean removeDirectory(String remoteDirPath) throws IOException {
        boolean removed = ftpClient.removeDirectory(remoteDirPath);
        if (removed) {
            LOGGER.info("成功删除目录: " + remoteDirPath);
        } else {
            LOGGER.warning("无法删除目录: " + remoteDirPath);
        }
        return removed;
    }

    /**
     * 重命名远程文件。
     *
     * @param oldRemotePath 旧的远程文件路径
     * @param newRemotePath 新的远程文件路径
     * @return 重命名是否成功
     * @throws IOException 如果重命名失败抛出异常
     */
    public boolean renameFile(String oldRemotePath, String newRemotePath) throws IOException {
        boolean renamed = ftpClient.rename(oldRemotePath, newRemotePath);
        if (renamed) {
            LOGGER.info("文件重命名成功: " + oldRemotePath + " -> " + newRemotePath);
        } else {
            LOGGER.warning("文件重命名失败: " + oldRemotePath + " -> " + newRemotePath);
        }
        return renamed;
    }

    /**
     * 检查远程文件或目录是否存在。
     *
     * @param remotePath 远程文件或目录路径
     * @return 是否存在
     * @throws IOException 如果检查失败抛出异常
     */
    public boolean exists(String remotePath) throws IOException {
        FTPFile[] files = ftpClient.listFiles(remotePath);
        return files.length > 0;
    }
}

工具类功能概述：

  1. 连接与断开：提供了 connect() 和 disconnect() 方法，用于连接和断开 FTP 服务器。工具类自动处理连接时的被动模式和登录验证。

  2. 上传文件：通过 uploadFile() 方法实现本地文件上传到远程 FTP 服务器，支持二进制文件上传。

  3. 下载文件：通过 downloadFile() 方法将远程服务器上的文件下载到本地，支持

二进制文件下载。

  1. 删除文件：提供 deleteFile() 方法，用于删除 FTP 服务器上的文件。

  2. 列出文件：通过 listFiles() 方法获取 FTP 服务器上指定目录的文件列表。

  3. 切换工作目录：可以通过 changeWorkingDirectory() 切换 FTP 服务器上的当前工作目录。

  4. 创建和删除目录：支持在 FTP 服务器上创建新目录（makeDirectory()）和删除目录（removeDirectory()）。

  5. 重命名文件：通过 renameFile() 实现文件重命名功能。

  6. 文件存在性检查：exists() 方法用于检查 FTP 服务器上的文件或目录是否存在。

使用说明：

  1. 依赖：确保项目中已经引入 Apache Commons Net 库的依赖。

  2. 实例化工具类：创建 FTPUtils 实例并连接服务器，调用相应的方法进行操作。

总结：

Java-FTP操作工具类（FTPUtils）是一个用于操作FTP服务器的工具类。它封装了一系列常用的FTP操作方法，使得在Java程序中操作FTP服务器变得简单且方便。

FTPUtils提供了以下主要功能：

  1. 连接到FTP服务器：通过调用connect方法，传入FTP服务器的IP地址、端口号、用户名和密码，即可建立与FTP服务器的连接。

  2. 上传文件到FTP服务器：通过调用uploadFile方法，传入本地文件路径和远程文件路径，即可将本地文件上传到FTP服务器。

  3. 下载文件从FTP服务器：通过调用downloadFile方法，传入远程文件路径和本地文件路径，即可将FTP服务器上的文件下载到本地。

  4. 删除FTP服务器上的文件：通过调用deleteFile方法，传入远程文件路径，即可删除FTP服务器上的文件。

  5. 创建FTP服务器上的目录：通过调用createDirectory方法，传入目录路径，即可在FTP服务器上创建对应的目录。

  6. 删除FTP服务器上的目录：通过调用deleteDirectory方法，传入目录路径，即可删除FTP服务器上的目录。

  7. 列出FTP服务器上的文件和目录：通过调用listFiles方法，传入目录路径，即可列出FTP服务器上的文件和目录。

FTP服务器操作工具类FTPUtils
weixin_43910581的博客
04-01 957
FTP
Java 操作ftp 的工具类 ，亲测有效
一天不写代码难受的博客
03-31 1374
Java 操作ftp 的工具类。
FTP文件传输工具
syt_Jimmy的博客
11-20 490
import java.io.ByteArrayInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.net.SocketException; import java.text.SimpleDateFormat; import java.util.Date; impor
ftp文件上传下载
huangjl2000w的专栏
03-31 509
一、ftp工具类： package aa.bb; import java.io.BufferedInputStream; import java.io.BufferedOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException;
java实现FTP文件下载（附带源码）
最新发布
欢迎来到我的博客！这里是一个专注于计算机技术的分享平台，涵盖编程开发、算法研究、系统架构、软件工程等多个领域。无论你是初学者还是资深开发者，都能在这里找到有价值的内容。
03-11 897
java实现FTP文件下载（附带源码）
java操作FTP工具类
05-10
java操作FTP工具类:实现基本断点上传下载、实现上传下载进度汇报、实现中文目录创建及中文文件创建，添加对于中文的支持
JAVA的FTP工具类
tom_or_jerry的专栏
07-22 8741
原文地址:http://blog.csdn.net/kardelpeng/article/details/6588284 很好的文章,转载mark 1.首先先导入相关jar包 2.创建一个连接FTP的工具类FTPUtil.java [java] view plaincopy package com.metar
Java FTP工具类
hnxydq的专栏
03-30 8976
因工作需要，需要在后台处理一些小文件，比如网页资源到服务器上保存，本来计划使用DFS来进行压缩存储，考虑到需要再次解压生成访问连接，暂时先直接通过FTP直接保存在服务器上。就看了下Java下的ftp上传的实现方法，参照了网上的代码。 这里给出我封装的一个工具类，可以直接使用，应该需要再优化。 使用了Apache的commons-net-1.4.1.jar开源组件。 对应的API地址如下： h
java中上传文件到ftp
记录一些工作日常和学习
08-19 2136
java中使用ftp工具类
FTP JAVA工具类（连接FTP，上传文件到FTP，删除FTP文件，下载FTP文件，检索FTP文件）
12-01
本篇文章将详细讲解如何使用Java编写一个FTP工具类，实现连接FTP服务器、上传文件、删除文件、下载文件以及检索文件的功能。 首先，我们需要引入Apache Commons Net库，该库提供了丰富的FTP客户端API。在`pom.xml`...
FtpUtil.java（ftp工具类）
08-13
ftp工具类，构造方法初始化类，连接ftp，列出所有文件内容，下载文件
FTP和SFTP工具类(java)
12-13
FTP和SFTP工具类，基于java语言 其中FTP修改默认模式为被动模式 文档还包括了需要引用的maven依赖内容
java实现ftp和sftp的工具类
01-29
ftp支持主动和被动模式上传下载，sftp支持上传功能
JAVA 操作FTP的工具类，上传，下载，删除功能都有了。
09-17
本类提供了java对ftp的各种操作的！经过精心的整理！相信对初学者有很大的帮助！
FtpUtils.java
04-03
ftp服务上传下载工具类，FTP（File Transfer Protocol，文件传输协议） 是 TCP/IP 协议组中的协议之一。FTP协议包括两个组成部分，其一为FTP服务器，其二为FTP客户端。其中FTP服务器用来存储文件，用户可以使用FTP...
JAVA FTP工具类实现文件的全面管理
下面将详细介绍FTP工具类中包含的关键知识点，并结合具体的FTPUtils.java工具类的文件名称来阐释其功能实现。 ### FTP 连接 建立FTP连接是进行其他文件操作的前提。FTP连接通常需要指定FTP服务器的地址、端口、...
java ftp 工具类
殷长庆的博客
09-22 1159
java ftp工具类，参考不知道哪位大神写得工具类（现在找不到链接了），后来自己修改了部分代码，单例模式，封装了查询文件夹是否存在、创建文件夹、上传文件、下载文件、删除文件等方法，经试验可用。 需要自己创建一个config的property文件。里面需要有文档中写出的几个属性。
java ftp工具类
peipeihequnqun的博客
01-28 269
[code="java"] package com.common.util; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

Flying_Fish_Xuan

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

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

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

打赏作者

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

抵扣说明：

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

余额充值