Spring FTP上传下载工具类遇到问题小结

2023-09-19 15:45:06 67

前言

最近在项目中需要和ftp服务器进行交互，在网上找了一下关于ftp上传下载的工具类，大致有两种。

第一种是单例模式的类。

第二种是另外定义一个Service，直接通过Service来实现ftp的上传下载。

这两种感觉都有利弊。

第一种实现了代码复用，但是配置信息全需要写在类中，维护比较复杂。

第二种如果是spring框架，可以通过propertis文件，动态的注入配置信息，但是又不能代码复用。

所以我打算自己实现一个工具类，来把上面的两种优点进行整合。顺便把一些上传过程中一些常见的问题也给解决了。

因为我使用的是spring框架，如果把工具类声明为bean给spring管理，他默认就是单例的，所以不需要我再实现单例。并且因为是bean，所以我可以把properties文件的属性注入bean的属性中，实现解耦，下面是具体代码：

packagecom.cky.util;
importjava.io.File;
importjava.io.FileOutputStream;
importjava.io.IOException;
importjava.io.InputStream;
importjava.io.OutputStream;
importorg.apache.commons.net.ftp.FTP;
importorg.apache.commons.net.ftp.FTPClient;
importorg.apache.commons.net.ftp.FTPFile;
importorg.apache.commons.net.ftp.FTPReply;
importorg.springframework.beans.factory.annotation.Value;
importorg.springframework.stereotype.Component;
//使用spring自动生成单例对象，
//@Component
publicclassFtpUtil{
//通过properties文件自动注入
@Value("${ftp.host}")
privateStringhost;//ftp服务器ip
@Value("${ftp.port}")
privateintport;//ftp服务器端口
@Value("${ftp.username}")
privateStringusername;//用户名
@Value("${ftp.password}")
privateStringpassword;//密码
@Value("${ftp.basePath}")
privateStringbasePath;//存放文件的基本路径
//测试的时候把这个构造函数打开，设置你的初始值，然后在代码后面的main方法运行测试
/*publicFtpUtil(){
//System.out.println(this.toString());
host="192.168.100.77";
port=21;
username="ftpuser";
password="ftp54321";
basePath="/home/ftpuser/";
}*/
/**
*
*@parampath上传文件存放在服务器的路径
*@paramfilename上传文件名
*@paraminput输入流
*@return
*/
publicbooleanfileUpload(Stringpath,Stringfilename,InputStreaminput){
FTPClientftp=newFTPClient();
try{
ftp.connect(host,port);
ftp.login(username,password);
//设置文件编码格式
ftp.setControlEncoding("UTF-8");
//ftp通信有两种模式
//PORT(主动模式)客户端开通一个新端口(>1024)并通过这个端口发送命令或传输数据,期间服务端只使用他开通的一个端口，例如21
//PASV(被动模式)客户端向服务端发送一个PASV命令，服务端开启一个新端口(>1024),并使用这个端口与客户端的21端口传输数据
//由于客户端不可控，防火墙等原因，所以需要由服务端开启端口，需要设置被动模式
ftp.enterLocalPassiveMode();
//设置传输方式为流方式
ftp.setFileTransferMode(FTP.STREAM_TRANSFER_MODE);
//获取状态码，判断是否连接成功
if(!FTPReply.isPositiveCompletion(ftp.getReplyCode())){
thrownewRuntimeException("FTP服务器拒绝连接");
}
//转到上传文件的根目录
if(!ftp.changeWorkingDirectory(basePath)){
thrownewRuntimeException("根目录不存在，需要创建");
}
//判断是否存在目录
if(!ftp.changeWorkingDirectory(path)){
String[]dirs=path.split("/");
//创建目录
for(Stringdir:dirs){
if(null==dir||"".equals(dir))continue;
//判断是否存在目录
if(!ftp.changeWorkingDirectory(dir)){
//不存在则创建
if(!ftp.makeDirectory(dir)){
thrownewRuntimeException("子目录创建失败");
}
//进入新创建的目录
ftp.changeWorkingDirectory(dir);
}
}
//设置上传文件的类型为二进制类型
ftp.setFileType(FTP.BINARY_FILE_TYPE);
//上传文件
if(!ftp.storeFile(filename,input)){
returnfalse;
}
input.close();
ftp.logout();
returntrue;
}
}catch(Exceptione){
thrownewRuntimeException(e);
}finally{
if(ftp.isConnected()){
try{
ftp.disconnect();
}catch(IOExceptione){
thrownewRuntimeException(e);
}
}
}
returnfalse;
}
/**
*
*@paramfilename文件名，注意！此处文件名为加路径文件名，如：/2015/06/04/aa.jpg
*@paramlocalPath存放到本地第地址
*@return
*/
publicbooleandownloadFile(Stringfilename,StringlocalPath){
FTPClientftp=newFTPClient();
try{
ftp.connect(host,port);
ftp.login(username,password);
//设置文件编码格式
ftp.setControlEncoding("UTF-8");
//ftp通信有两种模式
//PORT(主动模式)客户端开通一个新端口(>1024)并通过这个端口发送命令或传输数据,期间服务端只使用他开通的一个端口，例如21
//PASV(被动模式)客户端向服务端发送一个PASV命令，服务端开启一个新端口(>1024),并使用这个端口与客户端的21端口传输数据
//由于客户端不可控，防火墙等原因，所以需要由服务端开启端口，需要设置被动模式
ftp.enterLocalPassiveMode();
//设置传输方式为流方式
ftp.setFileTransferMode(FTP.STREAM_TRANSFER_MODE);
//获取状态码，判断是否连接成功
if(!FTPReply.isPositiveCompletion(ftp.getReplyCode())){
thrownewRuntimeException("FTP服务器拒绝连接");
}
intindex=filename.lastIndexOf("/");
//获取文件的路径
Stringpath=filename.substring(0,index);
//获取文件名
Stringname=filename.substring(index+1);
//判断是否存在目录
if(!ftp.changeWorkingDirectory(basePath+path)){
thrownewRuntimeException("文件路径不存在："+basePath+path);
}
//获取该目录所有文件
FTPFile[]files=ftp.listFiles();
for(FTPFilefile:files){
//判断是否有目标文件
//System.out.println("文件名"+file.getName()+"---"+name);
if(file.getName().equals(name)){
//System.out.println("找到文件");
//如果找到，将目标文件复制到本地
FilelocalFile=newFile(localPath+"/"+file.getName());
OutputStreamout=newFileOutputStream(localFile);
ftp.retrieveFile(file.getName(),out);
out.close();
}
}
ftp.logout();
returntrue;
}catch(Exceptione){
thrownewRuntimeException(e);
}finally{
if(ftp.isConnected()){
try{
ftp.disconnect();
}catch(IOExceptione){
thrownewRuntimeException(e);
}
}
}
}
//两个功能其中一个使用的话另一个需要注释
publicstaticvoidmain(String[]args){
//上传测试-----------------------------------
/*FileInputStreamin;
try{
in=newFileInputStream(newFile("C:\\Users\\Administrator\\Desktop\\json.png"));
FtpUtilftputil=newFtpUtil();
booleanflag=ftputil.fileUpload("/2015/06/04","aa.jpg",in);
System.out.println(flag);
}catch(Exceptione){
e.printStackTrace();
}finally{
}*/
//下载测试--------------------------------------
Stringfilename="/2015/06/04/aa.jpg";
StringlocalPath="F:\\";
FtpUtilftputil=newFtpUtil();
ftputil.downloadFile(filename,localPath);
}
//getset方法自己添加
//..............
}

具体使用

第一步：配置spring加载properties文件

applicationContext.xml


ftp.properties
ftp.host=192.168.100.77
ftp.port=21
ftp.username=ftpuser
ftp.password=ftp54321
ftp.basePath=/home/ftpuser/

第二步：将工具类声明为bean

xml方式

注解方式，组件扫描

第三部：注入使用

@Autowired
privateFtpUtilftpUtil;

总结

以上所述是小编给大家介绍的SpringFTP上传下载工具类遇到问题小结，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持！

Spring FTP上传下载工具类遇到问题小结

热门推荐

随机推荐