快捷導(dǎo)航

使用hutool進(jìn)行ftp文件下載和上傳詳細(xì)代碼示例

更新時(shí)間：2024年02月06日 08:29:25 作者：qq_41273205

在開發(fā)Java項(xiàng)目時(shí),FTP客戶端是經(jīng)常需要使用的工具,因?yàn)镕TP協(xié)議在文件傳輸方面有著廣泛的應(yīng)用,這篇文章主要給大家介紹了關(guān)于使用hutool進(jìn)行ftp文件下載和上傳的相關(guān)資料,需要的朋友可以參考下

1 引入依賴

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.15</version>
</dependency>

<dependency>
    <groupId>commons-net</groupId>
    <artifactId>commons-net</artifactId>
    <version>3.6</version>
</dependency>

2 工具類

package ftp;

import cn.hutool.core.io.FileUtil;
import cn.hutool.extra.ftp.Ftp;
import cn.hutool.extra.ftp.FtpMode;
import org.apache.commons.lang.StringUtils;

import java.io.File;
import java.io.IOException;

/**
 * @author : 
 * @description :
 * @date : 2023/3/10 14:42
 */
public class FtpUtil {
    /**
     * 下載ftp服務(wù)器上的文件到本地
     * @param remoteFile
     * @param localFile
     * @param ip
     * @param port
     * @param username
     * @param password
     * @param ftpMode
     * @return 成功則返回字符串:success
     */
    public static String download(String remoteFile, String localFile, String ip, Integer port, String username, String password, FtpMode ftpMode) {
        if(StringUtils.isBlank(localFile)) {
            return "本地保存路徑及名稱不能為空";
        }
        File lFile = FileUtil.file(localFile);
        Ftp ftp = null;
        try {
            //匿名登錄（無需帳號(hào)密碼的FTP服務(wù)器）
            ftp = new Ftp(ip,port == null ? 21 : port,username,password);
            if(ftpMode != null) {
                ftp.setMode(ftpMode);
            }
            ftp.download(remoteFile, lFile);
        } catch (Exception e) {
            return e.getMessage();
        } finally {
            //關(guān)閉連接
            try {
                if(ftp != null)  ftp.close();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
        if(lFile.exists() && lFile.length() > 0) {
            return "success";
        } else {
            lFile.delete();
            return "download failure,"+ remoteFile +" maybe not exists !!";
        }
    }

    /**
     * 此方法不指定上傳后保存的名稱， 則按本地文件的名稱保存
     * @param remoteDir
     * @param localFile
     * @param ip
     * @param port
     * @param username
     * @param password
     * @return 成功則返回字符串:success
     */
    public static String upload(String remoteDir, String localFile, String ip, Integer port, String username, String password, FtpMode ftpMode) {
        return upload(remoteDir, null, localFile, ip, port, username, password, ftpMode);
    }

    /**
     *
     * @param remoteDir 上傳的ftp目錄
     * @param remoteFileName  保存到ftp服務(wù)器上的名稱
     * @param localFile 本地文件全名稱
     * @param ip
     * @param port
     * @param username
     * @param password
     * @return 成功則返回字符串:success
     */
    public static String upload(String remoteDir, String remoteFileName, String localFile, String ip, Integer port, String username, String password, FtpMode ftpMode) {
        if(StringUtils.isBlank(localFile)) {
            return "本地文件名稱不能為空";
        }
        File lFile = FileUtil.file(localFile);
        if(!lFile.exists()) {
            return "本地文件不存在";
        }
        Ftp ftp = null;
        try {
            //匿名登錄（無需帳號(hào)密碼的FTP服務(wù)器）
            ftp = new Ftp(ip,port == null ? 21 : port,username,password);
            if(ftpMode != null) {
                ftp.setMode(ftpMode);
            }
            if(StringUtils.isBlank(remoteFileName)) {
                ftp.upload(remoteDir, lFile);
            } else {
                ftp.upload(remoteDir, remoteFileName, lFile);
            }
        } catch (Exception e) {
            return e.getMessage();
        } finally {
            //關(guān)閉連接
            try {
                if(ftp != null)  ftp.close();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
        return "success";
    }
}

3 測試

public class FtpTest {

    public static void main(String[] args) {
        //上傳文件到ftp
        String result = FtpUtil.upload("opt/upload","fff.zip", "D:/STM.zip", "192.168.68.55", 21, "ftpuser", "ftpuser!@#123", null);
        System.out.println(result);

        //下載遠(yuǎn)程文件
        String result2 = FtpUtil.download("opt/upload/fff.zip", "D:/bbb.zip", "192.168.68.55", 21, "ftpuser", "ftpuser!@#123", null);
        System.out.println(result2);

    }
}