SpringBoot集成ftp

1、添加maven依赖

        <dependency>
            <groupId>org.springframework.integration</groupId>
            <artifactId>spring-integration-ftp</artifactId>
            <version>${spring-integration.version}</version>
        </dependency>

2、ftp配置

ftp:
  host: 
  port: 
  username:
  password: 
package com.xzp.config;

import cn.hutool.core.util.ObjectUtil;
import lombok.Data;
import org.apache.commons.lang3.StringUtils;
import org.springframework.boot.context.properties.ConfigurationProperties;

import java.util.Map;
import java.util.Optional;

@Data
@ConfigurationProperties(prefix = "ftp")
public class FtpProperties {
    private String host;
    private Integer port;
    private String username;
    private String password;
    private String remoteDirectory = "";
    private String temporaryFileSuffix = ".tmp";
    private Boolean useTemporaryFileName = true;
    private Boolean autoCreateDirectory = true;
    private Integer clientMode = 0;
    private String controlEncoding = "UTF-8";

    public Integer getClientMode() {
        return Optional.ofNullable(clientMode).orElse(0);
    }

}
package com.xzp.config;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.net.ftp.FTPFile;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.expression.common.LiteralExpression;
import org.springframework.integration.file.remote.RemoteFileTemplate;
import org.springframework.integration.file.remote.session.CachingSessionFactory;
import org.springframework.integration.file.remote.session.SessionFactory;
import org.springframework.integration.ftp.session.DefaultFtpSessionFactory;
import org.springframework.integration.ftp.session.FtpRemoteFileTemplate;

import javax.annotation.Resource;

@ConditionalOnProperty(
        prefix = "ftp",
        value = {"host","port","username","password"}
)
@EnableConfigurationProperties(FtpProperties.class)
@Configuration
public class FtpConfiguration {

    public static final String REMOTE_FILE_TEMPLATE_BEAN_NAME = "remoteFileTemplate";

    @Resource
    private FtpProperties ftpProperties;

    @Bean
    public SessionFactory<FTPFile> ftpSessionFactory() {
        DefaultFtpSessionFactory factory = new DefaultFtpSessionFactory();
        factory.setHost(ftpProperties.getHost());
        factory.setPort(ftpProperties.getPort());
        factory.setUsername(ftpProperties.getUsername());
        factory.setPassword(ftpProperties.getPassword());
        factory.setClientMode(ftpProperties.getClientMode());
        if(StringUtils.isNotBlank(ftpProperties.getControlEncoding())){
            factory.setControlEncoding(ftpProperties.getControlEncoding());
        }
        return new CachingSessionFactory<>(factory);
    }

    @Bean(REMOTE_FILE_TEMPLATE_BEAN_NAME)
    public RemoteFileTemplate<FTPFile> remoteFileTemplate(){
        RemoteFileTemplate<FTPFile> template = new FtpRemoteFileTemplate(ftpSessionFactory());
        template.setRemoteDirectoryExpression(new LiteralExpression(ftpProperties.getRemoteDirectory()));
        template.setTemporaryFileSuffix(ftpProperties.getTemporaryFileSuffix());
        template.setUseTemporaryFileName(ftpProperties.getUseTemporaryFileName());
        template.setAutoCreateDirectory(ftpProperties.getAutoCreateDirectory());
        return template;
    }

}

3、封装方法

package com.xzp.service;

import cn.hutool.core.lang.Assert;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.net.ftp.FTPFile;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.integration.file.remote.RemoteFileTemplate;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.messaging.Message;
import org.springframework.stereotype.Component;

import java.io.File;
import java.util.Objects;

@SuppressWarnings("all")
@Slf4j
@Component
public class FtpService {

    @Autowired(required = false)
    private RemoteFileTemplate<FTPFile> remoteFileTemplate;

    /**
     /**
     * 上传文件
     *
     * @param localFilePath 本地文件路径
     * @param remoteFileDir 远程文件目录
     * @return true-成功,false-失败,null-没有开启ftp
     */
    public Boolean upload(String localFilePath, String remoteFileDir) {
        if(Objects.isNull(remoteFileTemplate)){
            return null;
        }
        Assert.notBlank(localFilePath, "本地文件路径不能为空");
        Assert.notBlank(remoteFileDir, "远程文件目录不能为空");
        log.info("上传文件到ftp, localFilePath:[{}], remoteFileDir:[{}]", localFilePath, remoteFileDir);
        remoteFileDir = remoteFileDir.endsWith(File.separator) ? remoteFileDir : remoteFileDir + File.separator;
        try {
            Message<File> message = MessageBuilder.withPayload(new File(localFilePath)).build();
            String result = remoteFileTemplate.send(message, remoteFileDir);
            log.info("上传文件到ftp, 响应结果:[{}]", result);
            return true;
        } catch (Exception e) {
            log.error("上传文件到ftp异常, localFilePath:[{}], remoteFileDir:[{}], 异常信息:[{}]", localFilePath, remoteFileDir, e.getMessage(), e);
            return false;
        }
    }

    public Boolean removeDir(String remoteFileDir){
        try {
            if(Objects.isNull(remoteFileTemplate)){
                return null;
            }
            FTPFile[] list = remoteFileTemplate.list(remoteFileDir);
            if(ArrayUtils.isNotEmpty(list)){
                for (FTPFile ftpFile : list) {
                    if(ftpFile.isDirectory()){
                        removeDir(remoteFileDir + File.separator + ftpFile.getName());
                    }else{
                        remoteFileTemplate.remove(remoteFileDir + File.separator + ftpFile.getName());
                    }
                }
            }
            remoteFileTemplate.getSession().rmdir(remoteFileDir);
            return true;
        } catch (Exception e){
            log.error("删除ftp文件夹异常,异常信息:[{}]",e.getMessage(),e);
            return false;
        }
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容