好用的Spring Boot实现SFTP上传文件工具类

最新推荐文章于 2024-02-01 15:08:49 发布
最新推荐文章于 2024-02-01 15:08:49 发布
阅读量490 收藏 2
点赞数
分类专栏： 解决方法 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42274641/article/details/119896331
版权

1.工厂方法

package com.xx.xxx.xx.factory;

import com.jcraft.jsch.*;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.util.Properties;

/**
 * SFTP工厂类，用于获取SFTP的连接
 * @author 奇点_
 */
@Slf4j
@Component
public class SFTPConnectionFactory {
	// 远程服务器地址
	@Value("${FTP.FtpHost}")
	private String hostName;
	// 端口
	@Value("${FTP.FtpPort}")
	private int port = 22;
	// 用户名
	@Value("${FTP.UserName}")
	private String userName;
	// 密码
	@Value("${FTP.PassWord}")
	private String password;

	private static String privateKey;

	private ChannelSftp client;
	private Session session;

	public synchronized ChannelSftp makeConnection(){
		
		if(client==null||session==null||!client.isConnected()||!session.isConnected()){
			try {    
				JSch jsch = new JSch();    
				if (privateKey != null) {    
					jsch.addIdentity(privateKey);// 设置私钥    
				}    
				session = jsch.getSession(userName, hostName, port);
				if (password != null) {    
					session.setPassword(password);      
				}    
				Properties config = new Properties();    
				config.put("StrictHostKeyChecking", "no");    
				session.setConfig(config);    
				session.connect();    
				Channel channel = session.openChannel("sftp");    
				channel.connect();    
				client = (ChannelSftp) channel;    
				log.info("sftp服务器连接成功");
			} catch (JSchException e) {
				log.error("sftp登录失败，检测登录ip，端口号，用户名密码是否正确，错误信息为"+e.getMessage());
			} 
		}
		    
		     return client;
	}
	/**  
     * 关闭连接 server   
     */    
    public  void logout(){    
        if (client != null) {    
            if (client.isConnected()) {    
            	client.disconnect();    
            }    
        }    
        if (session != null) {    
            if (session.isConnected()) {    
                session.disconnect();    
            }    
        }    
    }


}

2.上传、下载、删除方法

package com.xxx.xxx.xxx.utils;

import com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.SftpException;
import com.pig4cloud.pigx.admin.factory.SFTPConnectionFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.io.*;
import java.util.concurrent.TimeUnit;

@Component
@Slf4j
public class SFTPClientUtils {
	private static int downloadSleep = 100;
	private static int downloadRetry = 10;
	private static int uploadSleep = 100;
	private static int uploadRettry = 10;

	@Autowired
	private SFTPConnectionFactory sftpConnectionFactory;


	/**
	 * 文件上传
	 * 将文件对象上传到sftp作为文件。文件完整路径=basePath+directory
	 * 目录不存在则会上传文件夹
	 * @param remotePath  服务器的基础路径
	 * @param remoteFilename  远程文件名
	 * @param localFileName  需要上传的文件路径
	 */
	public synchronized  boolean uploadFile(String remotePath, String remoteFilename, String localFileName){
		boolean result = false;
		Integer i = 0;
		while(!result){
			ChannelSftp sftp = sftpConnectionFactory.makeConnection();
			try {
				sftp.cd(remotePath);
			} catch (SftpException e) {
				log.info("sftp文件上传，目录不存在开始创建");
			}
			try {
				File file = new File(localFileName);
				sftp.put(new FileInputStream(file) ,remoteFilename);
				if(i>0){
					log.info("sftp重试文件上传成功，ftp路径:"+remotePath+",文件名称:"+remoteFilename);
				}else{
					log.info("sftp文件上传成功，ftp路径为"+remotePath+",文件名称:"+remoteFilename);
				}
				result = true;
			} catch (Exception e) {
				i++;
				log.error("sftp文件上传失败，重试中。。。第"+i+"次，错误信息"+e.getMessage());
				if(i>uploadRettry){
					log.error("sftp文件上传失败，超过重试次数结束重试，错误信息"+e.getMessage());
					return result;
				}
				try {
					TimeUnit.MILLISECONDS.sleep(uploadSleep);
				} catch (InterruptedException e1) {
					e1.printStackTrace();
				}
			}

		}

		return result;
	}
	/**
	 * 文件上传  
     * 将文件对象上传到sftp作为文件。文件完整路径=basePath+directory
     * 目录不存在则会上传文件夹 
     * @param basePath  服务器的基础路径  
     * @param directory  上传到该目录   
     * @param filePath  sftp端文件名
     */
    public synchronized  boolean upload(String basePath,String directory, String filePath){
    	boolean result = false;
    	Integer i = 0;
        while(!result){
        	ChannelSftp sftp = sftpConnectionFactory.makeConnection();
        	try {     
                sftp.cd(basePath);  
                sftp.cd(directory);    
            } catch (SftpException e) {   
            	log.info("sftp文件上传，目录不存在开始创建");
                String [] dirs=directory.split("/");  
                String tempPath=basePath;  
                for(String dir:dirs){  
                    if(null== dir || "".equals(dir)) {
						continue;
					}
                    tempPath+="/"+dir;  
                    try{   
                        sftp.cd(tempPath);  
                    }catch(SftpException ex){  
                        try {
    						sftp.mkdir(tempPath);
    						sftp.cd(tempPath);  
    					} catch (SftpException e1) {
    						log.error("sftp文件上传，目录创建失败，错误信息:"+e1.getMessage()+ex.getMessage());
    					}  
                    }  
                }  
            }    
            try {
            	File file = new File(filePath);
    			sftp.put(new FileInputStream(file) , file.getName());
    			if(i>0){
					log.info("sftp重试文件上传成功，ftp路径:"+basePath+directory+",文件名称:"+file.getName());
				}else{
					log.info("sftp文件上传成功，ftp路径为"+basePath+directory+",文件名称:"+file.getName());
				}
    			result = true;
    		} catch (Exception e) {
    			i++;
    			log.error("sftp文件上传失败，重试中。。。第"+i+"次，错误信息"+e.getMessage());
				if(i>uploadRettry){
					log.error("sftp文件上传失败，超过重试次数结束重试，错误信息"+e.getMessage());
					return result;
				}
    			try {
					TimeUnit.MILLISECONDS.sleep(uploadSleep);
				} catch (InterruptedException e1) {
					e1.printStackTrace();
				}
    		}  
            
        }
    	
        return result;
    }   
    /**  
     * 下载文件。 
     * @param directory 下载目录   
     * @param downloadFile 下载的文件  
     * @param saveFile 存在本地的路径  
     */      
    public synchronized  boolean download(String directory, String downloadFile, String saveFile){
    	boolean result = false;
    	Integer i = 0;
    	while(!result){
    		ChannelSftp sftp = sftpConnectionFactory.makeConnection();
    		if (directory != null && !"".equals(directory)) {    
    			try {
    				sftp.cd(directory);
    			} catch (SftpException e) {
    				log.error("sftp文件下载，目录不存在，错误信息"+e.getMessage());
    			}    
    		}    
    		File file = new File(saveFile+downloadFile); 
    		FileOutputStream fileOutputStream = null;
    		try {
    			fileOutputStream = new FileOutputStream(file);
    		} catch (FileNotFoundException e1) {
    			log.error("sftp文件下载失败，本地目录不存在"+e1.getMessage());
    		}
    		try {
    			sftp.get(downloadFile, fileOutputStream);
				 if(i>0){
				    	log.info("sftp文件重试下载成功,sftp地址:"+directory+",本地文件地址:"+saveFile);	
				    }else{
				    	log.info("sftp文件下载成功,sftp地址:"+directory+",本地文件地址:"+saveFile);
				    }
    			result = true;
    		} catch (SftpException e1) {
    			i++;
				log.error("sftp文件下载失败，重试中。。。第"+i+"次，错误信息"+e1.getMessage());
				if(i>downloadRetry){
					log.error("ftp文件下载失败，超过重试次数结束重试，错误信息"+e1.getMessage());
					return result;
				}
				try {
					TimeUnit.MILLISECONDS.sleep(downloadSleep);
				} catch (Exception e2) {
					e2.printStackTrace();
				}
    		}finally {
    			try {
    				fileOutputStream.close();
    			} catch (IOException e) {
    				
    				e.printStackTrace();
    			}
    		}
    	}
        return result;
    }    
    
      
      
    /**  
     * 删除文件  
     * @param directory 要删除文件所在目录  
     * @param deleteFile 要删除的文件  
     */    
    public synchronized  boolean delete(String directory, String deleteFile){
    	boolean result = false;
    	ChannelSftp sftp = sftpConnectionFactory.makeConnection();
    	try {
			sftp.cd(directory);
			sftp.rm(deleteFile);
		} catch (SftpException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}    
        result = true;
        return result;
    }
	public static int getDownloadSleep() {
		return downloadSleep;
	}
	public static void setDownloadSleep(int downloadSleep) {
		SFTPClientUtils.downloadSleep = downloadSleep;
	}
	public static int getDownloadRetry() {
		return downloadRetry;
	}
	public static void setDownloadRetry(int downloadRetry) {
		SFTPClientUtils.downloadRetry = downloadRetry;
	}
	public static int getUploadSleep() {
		return uploadSleep;
	}
	public static void setUploadSleep(int uploadSleep) {
		SFTPClientUtils.uploadSleep = uploadSleep;
	}
	public static int getUploadRettry() {
		return uploadRettry;
	}
	public static void setUploadRettry(int uploadRettry) {
		SFTPClientUtils.uploadRettry = uploadRettry;
	}    
      
      
   
        
   
}

调用方式。Spring 注入调用

@Autowired
private SFTPClientUtils sftpClientUtils;

记录SFTP上传文件日常
注意事项：
1.两个服务操作同一个文件夹，不要用同一个账号

Frank—追求
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Ftp和Sftp上传下载工具类
08-02
该工具支持ftp和sftp的上传和下载 1
手把手教你SpringBoot集成SFTP客户端实现文件上传下载
m0_73311735的博客
08-20 2725
在项目开发中，一般文件存储很少再使用SFTP服务，但是也不排除合作伙伴使用SFTP来存储项目中的文件或者通过SFTP来实现文件数据的交互。我遇到的项目中，就有银行和保险公司等合作伙伴通过SFTP服务来实现与我们项目的文件数据的交互。其次我们引入了链接池工具，为了避免每次执行SFTP命令都要重新创建链接，我们使用池化的方式优化了比较消耗资源的创建操作。为了能够顺利地完成与友商的SFTP服务的连通，我们需要在自己的项目中实现一套SFTP客户端工具。对象池，这个才是真正的池子，它负责创建和存储所有的对象。
Springboot项目FTP工具类实现
guaotianxia的博客
10-19 589
在项目中涉及ftp文件操作一般有两种方式，一种是ftp操作，使用21号端口，一种是sftp操作，使用22号端口。sftp因为文件传输进行加密，会比ftp安全，但是导致了传输速度低不少，在项目中可以根据对安全性和性能要求，选择哪种ftp操作方式。本文将介绍两种方式的工具类实现。
SpringBoot实战（二十六）集成SFTP
最新发布
ACGkaka的博客
02-01 1369
SpringBoot实战（二十六）集成SFTP
springBoot 使用 SFTP
Angus
10-14 2035
这篇文章转发别人的，挺不错的，过段时间把自己的分享出来。 Spring Boot实现SFTP文件上传下载 1.实现背景及现实意义 近期由于系统迁移到docker容器，采用Spring Boot 框架实现微服务治理，在此基础上晚间批量文件服务器也由ftp改成sftp，由于之前ftp的实现是采用公具类的形式，在此基础之上，未屏蔽开发细节和依赖Spring Boot自动装配的特性，进行组件的自动装...
springBoot整合sftp
winsanity的博客
10-09 3989
springBoot整合sftp 1.引入依赖，pom文件添加依赖。 <dependency> <groupId>com.jcraft</groupId> <artifactId>jsch</artifactId> <version>0.1.55</version> </dependency> 2.在application.yml文件添加sftp配置。 sftp: protocol:
Java GenericObjectPool 对象池化技术--SpringBoot sftp 连接池工具类
20年码农
04-07 2169
通常一个对象创建、销毁非常耗时的时候，我们不会频繁的创建和销毁它，而是考虑复用。复用对象的一种做法就是对象池，将创建好的对象放入池中维护起来，下次再用的时候直接拿池中已经创建好的对象继续用，这就是池化的思想。Apache Commons Pool是一个对象池的框架，他提供了一整套用于实现对象池化的API。
linux脚本sftp上传文件
09-22
linux脚本sftp上传文件
java实现sftp客户端上传文件以及文件夹的功能代码
08-31
本篇文章主要介绍了java实现sftp客户端上传文件以及文件夹的功能代码，具有一定的参考价值，有兴趣的可以了解一下。
SFTP.java工具类
04-16
sftp java工具类
JAVA SFTP文件上传、下载及批量下载实例
08-31
本篇文章主要介绍了JAVA SFTP文件上传、下载及批量下载实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
spring boot 实现文件上传
06-19
1、该demo是基于之前的spring boot集成mybatis的基础上实现了文件上传功能。 2、工具为eclipse，启动类为Application（main方法）。 3、启动后浏览器输入：http://localhost:8080/main/gouploadimg
java实现sftp操作工具类
03-12
1分让你得到sftp常用操作工具，工具实现如下操作: 1)得到当前工作目录地址 2)改变目录为配置的远程目录 3)取文件目录列表 4)取文件列表 5)下载文件 6)复制文件 7)删除文件 8)目录是否存在,文件是否存在 9)移动文件 10)可以基于chnSftp对象进行开发 依赖类包在我的sftp包下载下提供 版权声明：本工具类为个人兴趣基于chnSftp编写的应用，个人版权在先，后因各个办公环境无相关软件也有相关的个人使用，和办公环境内的推广使用，也欢迎互联网使用，如涉及相关环境认为本应用有不妥之处，请删除本人的工具软件。欢迎互联网使用和反馈。
SFTP工具类
11-04
SFTP的工具类，整理的很全，主要这次修改的都涉及到了，研究了蛮就的上传，下载很简单，往上很多列子。主要是列出文件夹所有文件名，文件的创建修改时间，找了很多资料。 SFTP,上传,下载,查看文件夹下文件名,查看文件创建修改时间 使用的jar包也放里面了
springboot集成ftp连接池工具
04-18
springboot集成ftp连接池工具，很好的解决了并发大用户上传附件慢的问题
java实现ftp和sftp的工具类
01-29
ftp支持主动和被动模式上传下载，sftp支持上传功能
Springboot通过SFTP上传文件到服务器
Bin Deng得博客
04-29 2467
流程是这样的: 前端选择文件上传-------->调用后台接口,后台连接服务器(Linux)--------->上传成功 前端无论是通过ajax，还是form表单直接提交都可以，这里暂时以form方式提交 这里需要依靠一个Sftps的工具类 先导入依赖 <dependency> <groupId>com.jcraft</groupId&...
springboot 集成 sftp 文件上传
ray的博客
06-19 4425
最近在工作功能使用了sftp做文件上传下载的功能，在这里简单的记录一下， pom文件中引入相关的jar包 <!-- https://mvnrepository.com/artifact/com.jcraft/jsch --> <dependency> <groupId>com.jcraft</g...
Spring Boot(六十三)：使用sfpt实现简单的文件下载及上传
u013938578的博客
03-16 1386
而SFTP协议是在FTP的基础上对数据进行加密，使得传输的数据相对来说更安全。但是这种安全是以牺牲效率为代价的，也就是说SFTP的传输效率比FTP要低(不过现实使用当中，没有发现多大差别)。之前项目遇到从文件服务器上传、下载、删除文件，一开始打算使用一些高级的文件系统，比如：FastDFS，GlusterFS，CephFS，这些高级厉害的文件存储系统，但是由于环境限制无法搭建，最终使用常用的FFTP或者SFTP实现文件上传和下载。2.SFTP更安全，但更安全带来副作用就是的效率比FTP要低些。
c语言实现sftp上传文件
11-10
下面是C语言实现SFTP上传文件的步骤： 1. 引入必要的头文件和库文件，包括libssh2库和WinSock2.h头文件。 2. 初始化socket库，使用initSocket()函数。 3. 建立SFTP连接，使用libssh2_session_init()函数初始化...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值