套别人代码做网站,优化游戏的软件,四川省造价工程信息网,开源多用户商城哪个好前言#xff1a;开发中的需求要去对方的 ftp 服务器下载文件#xff0c;这里下载文件采用 ftp 方式#xff0c;下载之后程序再去解析文件的内容#xff0c;然后再存数据库。下载过来的文件默认是 zip 格式#xff0c;需要解压 unzip 一下#xff0c;然后里面有一个 csv 文…前言开发中的需求要去对方的 ftp 服务器下载文件这里下载文件采用 ftp 方式下载之后程序再去解析文件的内容然后再存数据库。下载过来的文件默认是 zip 格式需要解压 unzip 一下然后里面有一个 csv 文件用 easyecel 读取 csv 中的数据至此需求梳理完成。这里每次取下载或者操作 ftp 的时候都要新建一个连接用完再主动关闭这里并未复用此连接相当于说每次都是新建一个连接这样不好因此对这里进行设计改造。
引入 pom 依赖 !-- SFTP --dependencygroupIdcom.jcraft/groupIdartifactIdjsch/artifactIdversion0.1.55/version/dependency!-- commons-pool2 --dependencygroupIdorg.apache.commons/groupIdartifactIdcommons-pool2/artifactIdversion2.6.1/version/dependency
定义yml文件配置信息
sftp:mft:sftp-host: 101.233.389.58sftp-port: 80219sftp-username: usersftp-password: 789678sftp-path: /file/mftsave-path: /mftpool:max-total: 10max-idle: 10min-idle: 5
定义配置属性SftpProperties 信息
读取yml中的属性信息注意ConfigurationProperties(prefix sftp.mft)注解是定义属性下面的 sftpHost属性就读取到了yml文件中配置的信息但是类中的maxTotal和yml文件中的max-total是怎么映射的呢注意看yml中有一个pool下面 类中有一个private Pool pool new Pool();把pool改个名字就从yml文件点不进来了说明是根据此来映射的
package x.x.config.sftpPool;import com.jcraft.jsch.ChannelSftp;
import lombok.Data;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.springframework.boot.context.properties.ConfigurationProperties;Data
ConfigurationProperties(prefix sftp.mft)
public class SftpProperties {private String sftpHost;private int sftpPort;private String sftpUsername;private String sftpPassword;private String sftpPath;private String savePath;private Pool pool new Pool();public static class Pool extends GenericObjectPoolConfigChannelSftp {private int maxTotal DEFAULT_MAX_TOTAL;private int maxIdle DEFAULT_MAX_IDLE;private int minIdle DEFAULT_MIN_IDLE;public Pool() {super();}Overridepublic int getMaxTotal() {return maxTotal;}Overridepublic void setMaxTotal(int maxTotal) {this.maxTotal maxTotal;}Overridepublic int getMaxIdle() {return maxIdle;}Overridepublic void setMaxIdle(int maxIdle) {this.maxIdle maxIdle;}Overridepublic int getMinIdle() {return minIdle;}Overridepublic void setMinIdle(int minIdle) {this.minIdle minIdle;}}
}定义工厂类
生产sftp连接获取上一步定义好的属性 SftpProperties 实现三个方法create方法创建连接
package x.x.config.sftpPool;import com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.Session;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.pool2.BasePooledObjectFactory;
import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.impl.DefaultPooledObject;import java.util.Properties;Data
Slf4j
public class SftpFactory extends BasePooledObjectFactoryChannelSftp {private SftpProperties properties;public SftpFactory(SftpProperties properties) {this.properties properties;}Overridepublic ChannelSftp create() {try {JSch jsch new JSch();Session sshSession jsch.getSession(properties.getSftpUsername(), properties.getSftpHost(), properties.getSftpPort());sshSession.setPassword(properties.getSftpPassword());Properties sshConfig new Properties();sshConfig.put(StrictHostKeyChecking, no);sshSession.setConfig(sshConfig);sshSession.connect();ChannelSftp channel (ChannelSftp) sshSession.openChannel(sftp);channel.connect();return channel;}catch (JSchException e){throw new RuntimeException(连接sfpt失败, e);}}Overridepublic PooledObjectChannelSftp wrap(ChannelSftp channelSftp) {return new DefaultPooledObject(channelSftp);}Overridepublic void destroyObject(PooledObjectChannelSftp p) throws Exception {ChannelSftp channelSftp p.getObject();channelSftp.disconnect();}
}
定义池子
引入工厂制造此处会根据yml文件配置的属性生成连接
package x.x.config.sftpPool;import com.jcraft.jsch.ChannelSftp;
import lombok.Data;
import org.apache.commons.pool2.impl.GenericObjectPool;Data
public class SftpPool {private GenericObjectPoolChannelSftp pool;public SftpPool(SftpFactory factory) {this.pool new GenericObjectPool(factory, factory.getProperties().getPool());}/*** 获取一个sftp连接对象* return sftp连接对象*/public ChannelSftp borrowObject() {try {return pool.borrowObject();} catch (Exception e) {throw new RuntimeException(获取ftp连接失败, e);}}/*** 归还一个sftp连接对象* param channelSftp sftp连接对象*/public void returnObject(ChannelSftp channelSftp) {if (channelSftp!null) {pool.returnObject(channelSftp);}}
}
定义help类操作
引入pool直接操作获取用完返回
package x.x.config.sftpPool;import com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.SftpATTRS;
import com.jcraft.jsch.SftpException;
import lombok.extern.slf4j.Slf4j;import java.io.*;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Vector;Slf4j
public class SftpHelper {private SftpPool pool;public SftpHelper(SftpPool pool) {this.pool pool;}public void createDir(String createPath) throws Exception {ChannelSftp channelSftp pool.borrowObject();try {channelSftp.cd(/);if (!isDirExist(createPath)) {String[] pathArry createPath.split(/);for (String path : pathArry) {if (.equals(path)) {continue;}if (isDirExist(path)) {channelSftp.cd(path);} else {// 建立目录channelSftp.mkdir(path);// 进入并设置为当前目录channelSftp.cd(path);}}} else {channelSftp.cd(createPath);}} catch (SftpException e) {log.error(e.getMessage(), e);throw new Exception(创建路径错误 createPath);}finally {pool.returnObject(channelSftp);}}public boolean isDirExist(String directory) {ChannelSftp channelSftp pool.borrowObject();boolean isDirExistFlag false;try {channelSftp.cd(/);SftpATTRS sftpATTRS channelSftp.lstat(directory);isDirExistFlag true;channelSftp.cd(directory);return sftpATTRS.isDir();} catch (Exception e) {log.error(e.getMessage(), e);if (no such file.equals(e.getMessage().toLowerCase())) {isDirExistFlag false;}}finally {pool.returnObject(channelSftp);}return isDirExistFlag;}/*** 文件上传** param directory 目录* param fileName 要上传的文件名*/public void uploadFile(ChannelSftp uploadChannelSftp, String directory, String sourceFilePath, String fileName) {ChannelSftp channelSftp pool.borrowObject();//获取输入流InputStream inputStream null;try {inputStream uploadChannelSftp.get(sourceFilePath);} catch (SftpException e) {e.printStackTrace();throw new RuntimeException(e);}finally {pool.returnObject(channelSftp);}try {channelSftp.cd(directory);//写入文件channelSftp.put(inputStream, fileName);} catch (Exception e) {e.printStackTrace();throw new RuntimeException(文件上传异常 e.getMessage());} finally {pool.returnObject(channelSftp);if (inputStream ! null) {try {inputStream.close();} catch (IOException e) {throw new RuntimeException(Close stream error. e.getMessage());}}}}/*** 列出目下下的所有文件** param sftpPath 文件路径* return 文件名* throws Exception 异常*/public ListString listFiles(String sftpPath) {ChannelSftp channelSftp pool.borrowObject();Vector fileList null;ListString fileNameList new ArrayList();try {fileList channelSftp.ls(sftpPath);} catch (SftpException e) {throw new RuntimeException(e);}Iterator it fileList.iterator();while (it.hasNext()) {String fileName ((ChannelSftp.LsEntry) it.next()).getFilename();if (..equals(fileName) || ...equals(fileName)) {continue;}fileNameList.add(fileName);}pool.returnObject(channelSftp);return fileNameList;}/*** 下载文件。** param sourceDirectory 下载目录* param downloadFile 下载的文件* param targetSaveDirectory 存在本地的路径*/public void downloadFile(String sourceDirectory, String downloadFile, String targetSaveDirectory) throws RuntimeException {ChannelSftp channelSftp pool.borrowObject();OutputStream targetFile null;try {if (sourceDirectory ! null !.equals(sourceDirectory)) {channelSftp.cd(sourceDirectory);}File folder new File(targetSaveDirectory);// 确保文件夹存在if (!folder.exists()) {if (!folder.mkdirs()) {log.error(无法创建文件夹);return;}}targetFile new FileOutputStream(new File(targetSaveDirectory, downloadFile));channelSftp.get(downloadFile, targetFile);} catch (Exception e) {throw new RuntimeException(e);} finally {pool.returnObject(channelSftp);try {targetFile.close();} catch (IOException e) {throw new RuntimeException(e);}}}/*** 删除文件** param directory 要删除文件所在目录* param deleteFile 要删除的文件*/public void deleteFile(String directory, String deleteFile) throws Exception {ChannelSftp channelSftp pool.borrowObject();try {channelSftp.cd(directory);channelSftp.rm(deleteFile);} catch (Exception e) {throw new Exception(文件删除失败 e.getMessage());}finally {pool.returnObject(channelSftp);}}/*** 检查文件路径是否存在** param path 文件路径* return true/false*/public boolean checkedFileDirectory(String path) {ChannelSftp channelSftp pool.borrowObject();File file new File(path);if (!file.exists() !file.isDirectory()) {log.info(file or dir not exist, will create it : path);file.setWritable(true, false);return file.mkdirs();}pool.returnObject(channelSftp);return true;}
}
配置bean信息
SftpFactory 工厂的建立依赖于SftpProperties 配置属性SftpProperties 是通过注解EnableConfigurationProperties引入
SftpPool 池子依赖于工厂SftpFactory 创建连接
sftpHelper 操作类依赖于 池子SftpPool中的连接操作具体的文件
package x.x.config.sftpPool;import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;Configuration
EnableConfigurationProperties(SftpProperties.class)
public class SftpConfig {// 工厂Beanpublic SftpFactory sftpFactory(SftpProperties properties) {return new SftpFactory(properties);}// 连接池Beanpublic SftpPool sftpPool(SftpFactory sftpFactory) {return new SftpPool(sftpFactory);}// 辅助类Beanpublic SftpHelper sftpHelper(SftpPool sftpPool) {return new SftpHelper(sftpPool);}
}至此一个简单的池子就完成了
