工具类 (二) 操作 sftp

依赖架包

<dependency>
	<groupId>com.jcraft</groupId>
	<artifactId>jsch</artifactId>
	<version>0.1.54</version>
</dependency>
<dependency>
	<groupId>commons-io</groupId>
	<artifactId>commons-io</artifactId>
	<version>2.4</version>
</dependency>

工具类

SFTPConnection

package com.chinamobile.util;

import com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.Session;

/**
 * Description
 *
 * @author <a href="https://qiankunpingtai.cn">qiankunpingtai</a>
 * @Date: 2019/10/22 17:47
 */
public class SFTPConnection {
    private Session session;
    private ChannelSftp channelSftp;

    public Session getSession() {
        return session;
    }

    public void setSession(Session session) {
        this.session = session;
    }

    public ChannelSftp getChannelSftp() {
        return channelSftp;
    }

    public void setChannelSftp(ChannelSftp channelSftp) {
        this.channelSftp = channelSftp;
    }
}

SFTPUtils

package com.chinamobile.util;

import com.jcraft.jsch.*;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.*;
import java.util.Properties;
import java.util.Vector;
/**
 * 类说明 sftp工具类
 */
public class SFTPUtils{
	private static Logger logger = LoggerFactory.getLogger(SFTPUtils.class);
	/**
	 * 连接sftp服务器
	 */
	public static SFTPConnection login(String host,String username,String password,int port, String privateKey) {
		logger.info("sftp连接开启...   host:"+host+",username:"+username);
		SFTPConnection conn = new SFTPConnection();
		JSch jsch = new JSch();
		try {
			if (privateKey != null) {
				jsch.addIdentity(privateKey);
			}
			Session session=jsch.getSession(username, host, port);
			if (password != null) {
				session.setPassword(password);
			}
			Properties config = new Properties();
			config.put("StrictHostKeyChecking", "no");
			session.setConfig(config);
			conn.setSession(session);
			conn.getSession().connect();
			Channel channel = conn.getSession().openChannel("sftp");
			channel.connect();
			conn.setChannelSftp((ChannelSftp) channel);
		} catch (JSchException e) {
			e.printStackTrace();
		}
		return conn;
	}
	/**
	 * 关闭连接 server
	 */
	public static void logout(SFTPConnection conn) {

		if (conn.getChannelSftp() != null) {
			if (conn.getChannelSftp().isConnected()) {
				conn.getChannelSftp().disconnect();
			}
		}
		if (conn.getSession()!= null) {
			if (conn.getSession().isConnected()) {
				conn.getSession().disconnect();
			}
		}
	}
	/**
	 * 将输入流的数据上传到sftp作为文件。文件完整路径=basePath+directory
	 * @param basePath  服务器的基础路径
	 * @param directory  上传到该目录
	 * @param sftpFileName  sftp端文件名
	 * @param input   输入流
	 */
	public static void upload(SFTPConnection conn,String basePath, String directory, String sftpFileName, InputStream input)
			throws SftpException {
		try {
			conn.getChannelSftp().cd(basePath);
			conn.getChannelSftp().cd(directory);
		} catch (SftpException e) {
			// 目录不存在,则创建文件夹
			String[] dirs = directory.split("/");
			String tempPath = basePath;
			for (String dir : dirs) {
				if (null == dir || "".equals(dir)){
					continue;
				}
				tempPath += "/" + dir;
				try {
					conn.getChannelSftp().cd(tempPath);
				} catch (SftpException ex) {
					conn.getChannelSftp().mkdir(tempPath);
					conn.getChannelSftp().cd(tempPath);
				}
			}
		}
		conn.getChannelSftp().put(input, sftpFileName); // 上传文件
	}
	/**
	 * 下载文件。
	 * @param sourcePath 下载目录
	 * @param fileName 下载的文件
	 * @param targetFile 存在本地的路径
	 */
	public static void download(SFTPConnection conn,String sourcePath, String fileName, String targetFile)
			throws SftpException, FileNotFoundException {
		if (sourcePath != null && !"".equals(sourcePath)) {
			conn.getChannelSftp().cd(sourcePath);
		}
		File file = new File(targetFile + File.separator + fileName);
		conn.getChannelSftp().get(fileName, new FileOutputStream(file));
	}
	/**
	 * 下载文件
	 * @param directory 下载目录
	 * @param downloadFile 下载的文件名
	 * @return 字节数组
	 */
	public static byte[] download(SFTPConnection conn,String directory, String downloadFile) throws SftpException, IOException {
		if (directory != null && !"".equals(directory)) {
			conn.getChannelSftp().cd(directory);
		}
		InputStream is = conn.getChannelSftp().get(downloadFile);

		byte[] fileData = IOUtils.toByteArray(is);

		return fileData;
	}
	/**
	 * 删除文件
	 * @param directory 要删除文件所在目录
	 * @param deleteFile 要删除的文件
	 */
	public static void delete(SFTPConnection conn,String directory, String deleteFile) throws SftpException {
		conn.getChannelSftp().cd(directory);
		conn.getChannelSftp().rm(deleteFile);
	}
	/**
	 * 列出目录下的文件
	 * @param directory 要列出的目录
	 */
	public static Vector<?> listFiles(SFTPConnection conn,String directory) throws SftpException {
		return conn.getChannelSftp().ls(directory);
	}
	/**
	 * 修改目录文件名称
	 * @param directory
	 * @param oldName
	 * @param newName
	 * @throws SftpException
	 * @throws IOException
	 */
	public void rename(SFTPConnection conn,String directory, String oldName, String newName)throws SftpException, IOException{
		if (directory != null && !"".equals(directory)) {
			conn.getChannelSftp().cd(directory);
			conn.getChannelSftp().rename(oldName,newName);

		}
	}
}

调用

/**
 * 登录sftp并上传文件
 * */
public void loginSftpAndUploadFile(File file,String fileName){
	SFTPConnection conn =SFTPUtils.login(host,username, password, Integer.parseInt(port),null);
	InputStream cis = null;
	try {
		cis = new FileInputStream(file);
		SFTPUtils.upload(conn,"/", path, fileName, cis);
		cis.close();
	} catch (Exception e) {
		logger.error("cmiot 上传文件异常",e);
		e.printStackTrace();
	} finally {
		SFTPUtils.logout(conn);
	}
}

上一篇 工具类 (一) 操作 ftp
下一篇 工具类(三)返回封装