SpringBoot 整合 sftp

一、必要的jar包

<dependency>
   <groupId>commons-fileupload</groupId>
   <artifactId>commons-fileupload</artifactId>
   <version>1.4</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.jcraft/jsch -->
<dependency>
   <groupId>com.jcraft</groupId>
   <artifactId>jsch</artifactId>
   <version>0.1.55</version>
</dependency>
<dependency>
   <groupId>commons-io</groupId>
   <artifactId>commons-io</artifactId>
   <version>2.8.0</version>
   <scope>compile</scope>
</dependency>

二、yml 的相关配置

sftp:
  host: *****
  port: ****
  username: *****
  password: ****
  uploadDirectory: /upload
  downloadDirectory: /download

三、工具类

工具类参考：https://blog.csdn.net/yhl_jxy/article/details/72633034

package com.cq.base.utils;

import com.jcraft.jsch.*;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.IOUtils;

import java.io.*;
import java.util.Properties;
import java.util.Vector;

/**
 * @Author: admin
 * @Despriction:
 * @Package: com.cq.base.utils
 * @Date:Created in 2021/2/1 15:42
 * @Modify By:
 */
@Slf4j
public class SFTPUtil {

    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 SFTPUtil(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 SFTPUtil(String username, String host, int port, String privateKey) {
        this.username = username;
        this.host = host;
        this.port = port;
        this.privateKey = privateKey;
    }

    public SFTPUtil(){}

    /**
     * 连接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 input
     *            输入流
     * @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);
            sftp.cd(directory);
        }
        sftp.put(input, sftpFileName);
        log.info("file:{} is upload successful" , sftpFileName);
    }

    /**
     * 上传单个文件
     *
     * @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 directory
     * @return
     * @throws SftpException
     */
    public Vector<?> listFiles(String directory) throws SftpException {
        return sftp.ls(directory);
    }

    public static void main(String[] args) throws SftpException, IOException {
        SFTPUtil sftp = new SFTPUtil("lanhuigu", "123456", "192.168.200.12", 22);
        sftp.login();
        //byte[] buff = sftp.download("/opt", "start.sh");
        //System.out.println(Arrays.toString(buff));
        File file = new File("D:\\upload\\index.html");
        InputStream is = new FileInputStream(file);

        sftp.upload("/data/work", "test_sftp_upload.csv", is);
        sftp.logout();
    }

}

四、接口调用

package com.cq.duty.controller.fax;

import com.cq.base.common.BaseRequest;
import com.cq.base.common.BaseResult;
import com.cq.base.utils.SFTPUtil;
import com.jcraft.jsch.SftpException;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import org.springframework.web.multipart.MultipartResolver;
import org.springframework.web.multipart.commons.CommonsMultipartResolver;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.util.*;

/**
 * @Author: admin
 * @Despriction: sftp文件操作
 * @Package: com.cq.duty.controller.fax
 * @Date:Created in 2021/2/1 17:22
 * @Modify By:
 */
@RestController
@RequestMapping("/sftp/fax")
public class SftpHandlerController {

    @Value("${sftp.host}")
    private String host;

    @Value("${sftp.port}")
    private Integer port;

    @Value("${sftp.username}")
    private String username;

    @Value("${sftp.password}")
    private String password;

    @Value("${sftp.uploadDirectory}")
    private String uploadDirectory;

    @Value("${sftp.downloadDirectory}")
    private String downloadDirectory;

    /**
     * sftp 文件上传
     * @param file
     * @param request
     * @param sessionMultipartFile
     * @return
     * @throws Exception
     */
    @PostMapping(value = "/upload")
    public BaseResult fileUpload(@RequestParam(value = "file", required = false) MultipartFile file, HttpServletRequest request, HttpSession sessionMultipartFile) throws Exception {
        MultipartResolver resolver = new CommonsMultipartResolver(request.getSession().getServletContext());
        MultipartHttpServletRequest multipartRequest = resolver.resolveMultipart(request);
        MultipartFile multipartFile = multipartRequest.getFile("file");
        if (multipartFile.isEmpty()) {
            BaseResult.Error error = new BaseResult.Error("", "上传文件失败,文件为空");
            List<BaseResult.Error> errors = new ArrayList<>();
            errors.add(error);
            return BaseResult.ERROR(errors, "101");
        }
        String fileName = multipartFile.getOriginalFilename();
        InputStream inputStream = multipartFile.getInputStream();
        sftpUpload(host,port,username,password,fileName,inputStream);
        return BaseResult.OK(null, "200", "上传附件成功");
    }

    /**
     *
     * @param host sftp ip 地址
     * @param port sftp 端口号
     * @param username sftp 用户名
     * @param password sftp 密码
     * @param sftpFileName sftp端文件名 含后缀名
     * @return
     * @throws FileNotFoundException
     * @throws SftpException
     */
    public void sftpUpload(String host,Integer port,String username
            ,String password,String sftpFileName,InputStream input) throws FileNotFoundException, SftpException {
        SFTPUtil sftpUtil = new SFTPUtil(username,password,host,port);
        sftpUtil.login();
        sftpUtil.upload(uploadDirectory,sftpFileName,input);
        sftpUtil.logout();
    }

    /**
     * sftp 文件下载
     * @param baseRequest
     * @throws FileNotFoundException
     * @throws SftpException
     * @throws UnsupportedEncodingException
     */
    @PostMapping("/download")
    public BaseResult fileDownload(@RequestBody BaseRequest baseRequest) throws FileNotFoundException, SftpException, UnsupportedEncodingException {
        Object parameter = baseRequest.getParameter();
        Object data = baseRequest.getData();
        Map<String, Object> parametermap = new HashMap<>();
        if (!Objects.isNull(parameter)) {
            parametermap = (Map)parameter;
        }
        String fileName = (String)parametermap.get("fileName");
        String filePath = (String)parametermap.get("filePath");
        if (StringUtils.isBlank(filePath)) {
            BaseResult.Error error = new BaseResult.Error("", "下载文件失败,文件路径为空");
            List<BaseResult.Error> errors = new ArrayList<>();
            errors.add(error);
            return BaseResult.ERROR(errors, "101");
        }
        SFTPUtil sftpUtil = new SFTPUtil(username,password,host,port);
        sftpUtil.login();
        sftpUtil.download(downloadDirectory,fileName,filePath);
        sftpUtil.logout();
        return BaseResult.OK(null, "200", "下载文件成功");
    }

    /**
     * 文件删除
     * @param baseRequest
     * @return
     * @throws SftpException
     */
    @PostMapping("/delete")
    public BaseResult fileDelete(@RequestBody BaseRequest baseRequest) throws SftpException {
        Object parameter = baseRequest.getParameter();
        Object data = baseRequest.getData();
        Map<String, Object> parametermap = new HashMap<>();
        if (!Objects.isNull(parameter)) {
            parametermap = (Map)parameter;
        }
        String fileName = (String)parametermap.get("fileName");
        SFTPUtil sftpUtil = new SFTPUtil(username,password,host,port);
        sftpUtil.login();
        sftpUtil.delete(uploadDirectory,fileName);
        sftpUtil.logout();
        return BaseResult.OK(null, "200", "删除文件成功");
    }

}