搭建SFTP服务器实现文件上传

客官°小女子只卖身不卖艺 2022-10-09 15:18 358阅读 0赞

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70][]

### 1、前言 ###

最近一直在做数据迁移接口的开发，涉及到大文件的远程下载与上传，其实倒没有什么原理可言，无非就是两台机器互连之后，获得文件流然后进行传输，不过在这过程也遇到过一些小坑，故记录下。

### 2、搭建SFTP服务器 ###

我这里就在本地搭建一个SFTP服务器进行测试，最简单的办法就是通过软件来实现，我这里推荐FreeSSHd，可以通过我的蓝奏云网盘进行下载：

> https://wwr.lanzoui.com/igWkqqoczjg  
> 密码:aqge

首先下载安装后之后进行配置

1）点击“Users”-“Add”，新增账号，开发时需要通过账号和密码连接上SFTP服务器。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 2][]

2）点击“SSH”，修改端口号，默认是22端口，以防22被其他应用占用了，我这里改成了23端口，也可以自行修改成其他端口号，并且将下面两个选项的√去掉，不然会出现问题。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 3][]

3）点击“Telnet”，这里也需要修改端口号。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 4][]

4）点击“Authentication”，这里把权限也改一下。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 5][]

5）点击“SFTP”，这里选择的目录就是我们要上传文件的根目录。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 6][]

6）点击“Server status”-“Click here to stop it”，至此，SFTP服务器启动成功。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 7][]

### 3、开发实现 ###

开发过程中遇到的坑就是创建文件夹，如果文件夹不存在，就会报错，而且文件夹不能多级创建，比如/A/B/C这三个文件夹，不能一次性创建，必须单个单个创建，不然就会报权限不足的错误，一开始我就是被这个报错误解了，一直在权限的问题上纠结，实则不是，我这里通过切割“/”的形式将字符串分割成数组，然后再通过遍历依次创建文件夹，注意还要判断文件夹是否已经存在，不然也会报错。

import java.io.ByteArrayInputStream;  
    import java.io.File;  
    import java.io.FileInputStream;  
    import java.io.FileNotFoundException;  
    import java.io.FileOutputStream;  
    import java.io.IOException;  
    import java.io.InputStream;  
    import java.io.UnsupportedEncodingException;
    import java.net.URL;
    import java.util.Properties;  
    import java.util.Vector;  
      
    import org.apache.commons.io.IOUtils;  
    import org.slf4j.Logger;  
    import org.slf4j.LoggerFactory;  
      
    import com.jcraft.jsch.Channel;  
    import com.jcraft.jsch.ChannelSftp;  
    import com.jcraft.jsch.JSch;  
    import com.jcraft.jsch.JSchException;  
    import com.jcraft.jsch.Session;  
    import com.jcraft.jsch.SftpException;  
    
    /**
     * sftp工具类
     * @author chen
     *
     */
    public class SFTPUtils {  
    	
        private transient Logger log = LoggerFactory.getLogger(this.getClass());  
          
        private ChannelSftp sftp;  
            
        private Session session;  
        /** FTP 登录用户名*/    
        private String username;  
        /** FTP 登录密码*/    
        private String password;  
        /** 私钥 */    
        private String privateKey;  
        /** FTP 服务器地址IP地址*/    
        private String host;  
        /** FTP 端口*/  
        private int port;  
            
        
        /**  
         * 构造基于密码认证的sftp对象  
         * @param userName  
         * @param password  
         * @param host  
         * @param port  
         */    
        public SFTPUtils(String username, String password, String host, int port) {  
            this.username = username;  
            this.password = password;  
            this.host = host;  
            this.port = port;  
        }  
        
        /**  
         * 构造基于秘钥认证的sftp对象 
         * @param userName 
         * @param host 
         * @param port 
         * @param privateKey 
         */  
        public SFTPUtils(String username, String host, int port, String privateKey) {  
            this.username = username;  
            this.host = host;  
            this.port = port;  
            this.privateKey = privateKey;  
        }  
        
        public SFTPUtils(){}  
        
        /** 
         * 连接sftp服务器 
         * 
         * @throws Exception  
         */  
        public void login(){  
            try {  
                JSch jsch = new JSch();  
                if (privateKey != null) {  
                    jsch.addIdentity(privateKey);// 设置私钥  
                    log.info("sftp connect,path of private key file：{}" , privateKey);  
                }  
                log.info("sftp connect by host:{} username:{}",host,username);  
        
                session = jsch.getSession(username, host, port);  
                log.info("Session is build");  
                if (password != null) {  
                    session.setPassword(password);    
                }  
                Properties config = new Properties();  
                config.put("StrictHostKeyChecking", "no");  
                    
                session.setConfig(config);  
                session.connect();  
                log.info("Session is connected");  
                  
                Channel channel = session.openChannel("sftp");  
                channel.connect();  
                log.info("channel is connected");  
        
                sftp = (ChannelSftp) channel;  
                log.info(String.format("sftp server host:[%s] port:[%s] is connect successfull", host, port));  
            } catch (JSchException e) {  
                log.error("Cannot connect to specified sftp server : {}:{} \n Exception message is: {}", new Object[]{host, port, e.getMessage()});    
            }  
        }    
        
        /** 
         * 关闭连接 server  
         */  
        public void logout(){  
            if (sftp != null) {  
                if (sftp.isConnected()) {  
                    sftp.disconnect();  
                    log.info("sftp is closed already");  
                }  
            }  
            if (session != null) {  
                if (session.isConnected()) {  
                    session.disconnect();  
                    log.info("sshSession is closed already");  
                }  
            }  
        }  
        
        /**  
         * 将输入流的数据上传到sftp作为文件  
         *   
         * @param directory  
         *            上传到该目录  
         * @param sftpFileName  
         *            sftp端文件名  
         * @param in  
         *            输入流  
         * @throws SftpException   
         * @throws Exception  
         */    
        public void upload(String directory, String sftpFileName, InputStream input) throws SftpException{  
            try {    
                sftp.cd(directory);  
            } catch (SftpException e) {  
                log.warn("directory is not exist");  
                //sftp.mkdir(directory);
                String[] split = directory.split("/");
                String directoryStr = "";
                for(int i = 0;i<split.length;i++) {
                	directoryStr+="/"+split[i];
                	if(!isDirectory(directoryStr)) {
                		sftp.mkdir(directoryStr);
                	}
                }
                sftp.cd(directoryStr);
            }
            sftp.put(input, sftpFileName);
            log.info("file:{} is upload successful" , sftpFileName);  
        }  
        
        public boolean isDirectory(String directoryStr) throws SftpException {
        	try {
        		if(directoryStr=="") {
        			return true;
        		}
    			sftp.cd(directoryStr);
    		} catch (Exception e) {
    			// TODO: handle exception
    			return false;
    		}  
        	return true;
        }
        
        /**  
         * 上传单个文件 
         * 
         * @param directory  
         *            上传到sftp目录  
         * @param uploadFile 
         *            要上传的文件,包括路径  
         * @throws FileNotFoundException 
         * @throws SftpException 
         * @throws Exception 
         */  
        public void upload(String directory, String uploadFile) throws FileNotFoundException, SftpException{  
            File file = new File(uploadFile);  
            upload(directory, file.getName(), new FileInputStream(file));  
        }  
        
        /** 
         * 将byte[]上传到sftp，作为文件。注意:从String生成byte[]是，要指定字符集。 
         *  
         * @param directory 
         *            上传到sftp目录 
         * @param sftpFileName 
         *            文件在sftp端的命名 
         * @param byteArr 
         *            要上传的字节数组 
         * @throws SftpException 
         * @throws Exception 
         */  
        public void upload(String directory, String sftpFileName, byte[] byteArr) throws SftpException{  
            upload(directory, sftpFileName, new ByteArrayInputStream(byteArr));  
        }  
        
        /**  
         * 将字符串按照指定的字符编码上传到sftp 
         *   
         * @param directory 
         *            上传到sftp目录 
         * @param sftpFileName 
         *            文件在sftp端的命名 
         * @param dataStr 
         *            待上传的数据 
         * @param charsetName 
         *            sftp上的文件，按该字符编码保存 
         * @throws UnsupportedEncodingException 
         * @throws SftpException 
         * @throws Exception 
         */  
        public void upload(String directory, String sftpFileName, String dataStr, String charsetName) throws UnsupportedEncodingException, SftpException{    
            upload(directory, sftpFileName, new ByteArrayInputStream(dataStr.getBytes(charsetName)));    
        }  
        
        /** 
         * 下载文件  
         * 
         * @param directory 
         *            下载目录  
         * @param downloadFile 
         *            下载的文件 
         * @param saveFile 
         *            存在本地的路径 
         * @throws SftpException 
         * @throws FileNotFoundException 
         * @throws Exception 
         */    
        public void download(String directory, String downloadFile, String saveFile) throws SftpException, FileNotFoundException{  
            if (directory != null && !"".equals(directory)) {  
                sftp.cd(directory);  
            }  
            File file = new File(saveFile);  
            sftp.get(downloadFile, new FileOutputStream(file));  
            log.info("file:{} is download successful" , downloadFile);  
        }  
        /**  
         * 下载文件 
         * @param directory 下载目录 
         * @param downloadFile 下载的文件名 
         * @return 字节数组 
         * @throws SftpException 
         * @throws IOException 
         * @throws Exception 
         */  
        public byte[] download(String directory, String downloadFile) throws SftpException, IOException{  
            if (directory != null && !"".equals(directory)) {  
                sftp.cd(directory);  
            }  
            InputStream is = sftp.get(downloadFile);  
              
            byte[] fileData = IOUtils.toByteArray(is);  
              
            log.info("file:{} is download successful" , downloadFile);  
            return fileData;  
        }  
        
        /** 
         * 删除文件 
         *   
         * @param directory 
         *            要删除文件所在目录 
         * @param deleteFile 
         *            要删除的文件 
         * @throws SftpException 
         * @throws Exception 
         */  
        public void delete(String directory, String deleteFile) throws SftpException{  
            sftp.cd(directory);  
            sftp.rm(deleteFile);  
        }  
        
        /** 
         * 列出目录下的文件 
         *  
         * @param directory 
         *            要列出的目录 
         * @param sftp 
         * @return 
         * @throws SftpException 
         */  
        public Vector<?> listFiles(String directory) throws SftpException {  
            return sftp.ls(directory);  
        }  
          
        public static void main(String[] args) throws SftpException, IOException {
        	
            SFTPUtils sftp = new SFTPUtils("root", "123456", "192.168.1.XXX", 23);  
            sftp.login();  
            
            File file = new File("G:\\a.txt");  
            InputStream is = new FileInputStream(file);
            sftp.upload("/", "a.txt", is);
    	
            sftp.logout();  
        }  
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70]: /images/20221005/d13c2face4064dd6b187c8d7078f8eb8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 1]: /images/20221005/e95572a261394e01a8d55c0fbbc4b0cf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 2]: /images/20221005/106ce230e3194a8381ffdea6eb3cf14e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 3]: /images/20221005/c13093e1c45349c0bb3539b2fef4c507.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 4]: /images/20221005/541c89c45fbe4f369d0c5c27abe60e9c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 5]: /images/20221005/aaabc6f97f1040818eaf351cc2a7cc8f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 6]: /images/20221005/03e88e763ae54881a093c2da3b12b2db.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMTA5NzQ2_size_16_color_FFFFFF_t_70 7]: /images/20221005/df0797a840da475eb35b4d0899a47f3e.png