java sftp工具类_SFTP远程文件操作工具类

该代码实现了一个SFTPUtil工具类,用于处理SFTP协议的文件操作,包括连接、下载、上传、删除和创建目录等。通过连接池管理SFTP连接,提高了效率并减少了资源消耗。此外,类中还包括了异常处理和日志记录功能。
摘要由CSDN通过智能技术生成

package com.xxx.web.util;

import java.io.ByteArrayOutputStream;

import java.io.File;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Properties;

import java.util.Vector;

import org.apache.commons.lang.StringUtils;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

import org.springframework.web.multipart.MultipartFile;

import com.jcraft.jsch.Channel;

import com.jcraft.jsch.ChannelSftp;

import com.jcraft.jsch.ChannelSftp.LsEntry;

import com.jcraft.jsch.JSch;

import com.jcraft.jsch.JSchException;

import com.jcraft.jsch.Session;

import com.jcraft.jsch.SftpException;

public class SftpUtil {

private final static Logger logger = LogManager.getLogger(SftpUtil.class);

/**

* 文件路径前缀. /ddit-remote

*/

private static final String PRE_FIX = "/test-noryar";

/**

* sftp连接池.

*/

private static final Map SFTP_CHANNEL_POOL = new HashMap();

/**

* 获取sftp协议连接.

* @param host 主机名

* @param port 端口

* @param username 用户名

* @param password 密码

* @return 连接对象

* @throws JSchException 异常

*/

public static ChannelSftp getSftpConnect(final String host, final int port, final String username,

final String password) throws JSchException {

Session sshSession = null;

Channel channel = null;

ChannelSftp sftp = null;

String key = host + "," + port + "," + username + "," + password;

if (null == SFTP_CHANNEL_POOL.get(key)) {

JSch jsch = new JSch();

jsch.getSession(username, host, port);

sshSession = jsch.getSession(username, host, port);

sshSession.setPassword(password);

Properties sshConfig = new Properties();

sshConfig.put("StrictHostKeyChecking", "no");

sshSession.setConfig(sshConfig);

sshSession.connect();

channel = sshSession.openChannel("sftp");

channel.connect();

SFTP_CHANNEL_POOL.put(key, channel);

} else {

channel = SFTP_CHANNEL_POOL.get(key);

sshSession = channel.getSession();

if (!sshSession.isConnected())

sshSession.connect();

if (!channel.isConnected())

channel.connect();

}

sftp = (ChannelSftp) channel;

return sftp;

}

/**

* 下载文件-sftp协议.

* @param downloadFile 下载的文件

* @param saveFile 存在本地的路径

* @param sftp sftp连接

* @return 文件

* @throws Exception 异常

*/

public static File download(final String downloadFile, final String saveFile, final ChannelSftp sftp)

throws Exception {

FileOutputStream os = null;

File file = new File(saveFile);

try {

if (!file.exists()) {

File parentFile = file.getParentFile();

if (!parentFile.exists()) {

parentFile.mkdirs();

}

file.createNewFile();

}

os = new FileOutputStream(file);

List list = formatPath(downloadFile);

sftp.get(list.get(0) + list.get(1), os);

} catch (Exception e) {

throw e;

} finally {

os.close();

}

return file;

}

/**

* 下载文件-sftp协议.

* @param downloadFile 下载的文件

* @param saveFile 存在本地的路径

* @param sftp sftp连接

* @return 文件 byte[]

* @throws Exception 异常

*/

public static byte[] downloadAsByte(final String downloadFile, final ChannelSftp sftp) throws Exception {

ByteArrayOutputStream os = new ByteArrayOutputStream();

try {

List list = formatPath(downloadFile);

sftp.get(list.get(0) + list.get(1), os);

} catch (Exception e) {

throw e;

} finally {

os.close();

}

return os.toByteArray();

}

/**

* 删除文件-sftp协议.

* @param pathString 要删除的文件

* @param sftp sftp连接

* @throws SftpException 异常

*/

public static void rmFile(final String pathString, final ChannelSftp sftp) throws SftpException {

List list = formatPath(pathString);

String dir = list.get(0);

String file = list.get(1);

if (dirExist(dir + file, sftp)) {

sftp.rm(list.get(0) + list.get(1));

}

}

/**

* 删除文件夹-sftp协议.如果文件夹有内容,则会抛出异常.

* @param pathString 文件夹路径

* @param sftp sftp连接

* @param resursion 递归删除

* @throws SftpException 异常

*/

public static void rmDir(final String pathString, final ChannelSftp sftp, final boolean recursion)

throws SftpException {

String fp = formatPath(pathString).get(0);

if (dirExist(fp, sftp)) {

if (recursion)

exeRmRec(fp, sftp);

else

sftp.rmdir(fp);

}

}

/**

* 递归删除执行.

* @param pathString 文件路径

* @param sftp sftp连接

* @throws SftpException

*/

private static void exeRmRec(final String pathString, final ChannelSftp sftp) throws SftpException {

@SuppressWarnings("unchecked")

Vector vector = sftp.ls(pathString);

if (vector.size() == 1) { // 文件,直接删除

sftp.rm(pathString);

} else if (vector.size() == 2) { // 空文件夹,直接删除

sftp.rmdir(pathString);

} else {

String fileName = "";

// 删除文件夹下所有文件

for (LsEntry en : vector) {

fileName = en.getFilename();

if (".".equals(fileName) || "..".equals(fileName)) {

continue;

} else {

exeRmRec(pathString + "/" + fileName, sftp);

}

}

// 删除文件夹

sftp.rmdir(pathString);

}

}

/**

* 上传文件-sftp协议.

* @param srcFile 源文件

* @param dir 保存路径

* @param fileName 保存文件名

* @param sftp sftp连接

* @throws Exception 异常

*/

private static void uploadFile(final String srcFile, final String dir, final String fileName, final ChannelSftp sftp)

throws SftpException {

mkdir(dir, sftp);

sftp.cd(dir);

sftp.put(srcFile, fileName);

}

/**

* 上传文件-sftp协议.

* @param srcFile 源文件路径,/xxx/xx.yy 或 x:/xxx/xxx.yy

* @param sftp sftp连接

* @return 上传成功与否

* @throws SftpException 异常

*/

public static boolean uploadFile(final String srcFile, final ChannelSftp sftp) throws SftpException {

File file = new File(srcFile);

if (file.exists()) {

List list = formatPath(srcFile);

uploadFile(srcFile, list.get(0), list.get(1), sftp);

return true;

}

return false;

}

/**

* 根据路径创建文件夹.

* @param dir 路径 必须是 /xxx/xxx/ 不能就单独一个/

* @param sftp sftp连接

* @throws SftpException 异常

*/

public static boolean mkdir(final String dir, final ChannelSftp sftp) throws SftpException {

if (StringUtils.isBlank(dir))

return false;

String md = dir.replaceAll("\\\\", "/");

if (md.indexOf("/") != 0 || md.length() == 1)

return false;

return mkdirs(md, sftp);

}

/**

* 递归创建文件夹.

* @param dir 路径

* @param sftp sftp连接

* @return 是否创建成功

* @throws SftpException 异常

*/

private static boolean mkdirs(final String dir, final ChannelSftp sftp) throws SftpException {

String dirs = dir.substring(1, dir.length() - 1);

String[] dirArr = dirs.split("/");

String base = "";

for (String d : dirArr) {

base += "/" + d;

if (dirExist(base + "/", sftp)) {

continue;

} else {

sftp.mkdir(base + "/");

}

}

return true;

}

/**

* 判断文件夹是否存在.

* @param dir 文件夹路径, /xxx/xxx/

* @param sftp sftp协议

* @return 是否存在

*/

private static boolean dirExist(final String dir, final ChannelSftp sftp) {

try {

Vector> vector = sftp.ls(dir);

if (null == vector)

return false;

else

return true;

} catch (SftpException e) {

return false;

}

}

/**

* 格式化路径.

* @param srcPath 原路径. /xxx/xxx/xxx.yyy 或 X:/xxx/xxx/xxx.yy

* @return list, 第一个是路径(/xxx/xxx/),第二个是文件名(xxx.yy)

*/

public static List formatPath(final String srcPath) {

List list = new ArrayList(2);

String repSrc = srcPath.replaceAll("\\\\", "/");

int firstP = repSrc.indexOf("/");

int lastP = repSrc.lastIndexOf("/");

String fileName = lastP + 1 == repSrc.length() ? "" : repSrc.substring(lastP + 1);

String dir = firstP == -1 ? "" : repSrc.substring(firstP, lastP);

dir = PRE_FIX + (dir.length() == 1 ? dir : (dir + "/"));

list.add(dir);

list.add(fileName);

return list;

}

/**

* 关闭协议-sftp协议.(关闭会导致连接池异常,因此不建议用户自定义关闭)

* @param sftp sftp连接

*/

private static void exit(final ChannelSftp sftp) {

sftp.exit();

}

public static void uploadFile(final MultipartFile file, final String dir, final String fileName, final ChannelSftp sftp)

throws SftpException {

mkdir(dir, sftp);

sftp.cd(dir);

try {

InputStream is = file.getInputStream();

sftp.put(is, fileName);

} catch (IOException e) {

logger.error("文件上传失败!");

e.printStackTrace();

}

}

public static void main(String[] args) throws Exception {

ChannelSftp sftp = getSftpConnect("192.168.0.35", 22, "root", "root");

// String pathString = "C:\\test\\ccc\\Foxmail7.zip";

// File file = new File(pathString);

// System.out.println("上传文件开始...");

// uploadFile(pathString, sftp);

// System.out.println("上传成功,开始删除本地文件...");

// file.delete();

// System.out.println("删除完成,开始校验本地文件...");

// if (!file.exists()) {

// System.out.println("文件不存在,开始从远程服务器获取...");

// download(pathString, pathString, sftp);

// System.out.println("下载完成");

// } else {

// System.out.println("在本地找到文件");

// }

// rmDir("", sftp, true);

String path = "E:\\aaa.zip";

@SuppressWarnings("unused")

File file = SftpUtil.download(path, path, sftp);

// SftpUtil.exit(sftp);

exit(sftp);

System.exit(0);

}

}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值