SftpUtil.java 13.3 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
package com.idss.vulsync.utils;
import cn.hutool.core.util.ObjectUtil;
import com.jcraft.jsch.*;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.IOUtils;

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

/**
 * FTP服务器工具类:
 *      JSch类 通过 SFTP 协议上传文件到 freeSSHd 服务器
 *
 */
@Slf4j
public class SftpUtil {

    private ChannelSftp sftp;

    private Session session;

    /**
     * 用户名
     */
    private String username;

    /**
     * 密码
     */
    private String password;

    /**
     * 秘钥
     */
    private String privateKey;

    /**
     * FTP服务器Ip
     */
    private String host;

    /**
     * FTP服务器端口号
     */
    private int port;

    /**
     * 构造器:基于密码认证sftp对象
     * @param username  用户名
     * @param password  密码
     * @param host      服务器ip
     * @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 privateKey 秘钥
     * @param host       服务器ip
     * @param port       服务器端口号
     */
    public SftpUtil(String username, String privateKey, int port, String host){
        this.username = username;
        this.privateKey = privateKey;
        this.host = host;
        this.port = port;
    }

    /**
     * 连接SFTP服务器
     */
    public boolean login(){
        JSch jsch = new JSch();
        try{
            if(privateKey != null){
                //设置登陆主机的秘钥
                jsch.addIdentity(privateKey);
            }
            //采用指定的端口连接服务器
            session = jsch.getSession(username,host,port);
            if(password != null){
                //设置登陆主机的密码
                session.setPassword(password);
            }
            //优先使用 password 验证   注:session.connect()性能低,使用password验证可跳过gssapi认证,提升连接服务器速度
            session.setConfig("PreferredAuthentications","password");
            //设置第一次登陆的时候提示,可选值:(ask | yes | no)
            session.setConfig("StrictHostKeyChecking","no");
            session.connect();
            //创建sftp通信通道
            Channel channel = session.openChannel("sftp");
            channel.connect();
            sftp = (ChannelSftp) channel;
            log.info("sftp server connect success !!");
        }catch (JSchException e){
            log.error("SFTP服务器连接异常!!", e);
            return false;
        }
        return true;
    }

    /**
     * 关闭SFTP连接
     */
    public void logout(){
        if(sftp != null){
            if(sftp.isConnected()){
                sftp.disconnect();
                log.info("sftp is close already");
            }
        }
        if(session != null){
            if(session.isConnected()){
                session.disconnect();
                log.info("session is close already");
            }
        }
    }

    /**
     * 将输入流上传到SFTP服务器,作为文件
     *
     * @param directory     上传到SFTP服务器的路径
     * @param sftpFileName  上传到SFTP服务器后的文件名
     * @param input         输入流
     * @throws SftpException
     */
    public void upload(String directory, String sftpFileName, InputStream input) throws SftpException {
        long start = System.currentTimeMillis();
        try{
            //如果文件夹不存在,则创建文件夹
            if(sftp.ls(directory) == null){
                sftp.mkdir(directory);
            }
            //切换到指定文件夹
            sftp.cd(directory);
        }catch (SftpException e){
            //创建不存在的文件夹,并切换到文件夹
            sftp.mkdir(directory);
            sftp.cd(directory);
        }
        sftp.put(input, sftpFileName+".tmp");
        sftp.rename(sftpFileName+".tmp", sftpFileName);
        log.info("文件上传成功!! 耗时:{}ms",(System.currentTimeMillis() - start));
    }

    /**
     * 上传单个文件
     *
     * @param directory     上传到SFTP服务器的路径
     * @param uploadFileUrl 文件路径
     */
    public void upload(String directory, String uploadFileUrl){
        File file = new File(uploadFileUrl);
        try{
            upload(directory, file.getName(), new FileInputStream(file));
        }catch (FileNotFoundException | SftpException e){
            log.error("上传文件异常!", e);
        }
    }

    /**
     * 上传单个文件,自定义名称
     *
     * @param directory     上传到SFTP服务器的路径
     * @param uploadFileUrl 文件路径
     */
    public void upload(String directory,String fileName, String uploadFileUrl){
        File file = new File(uploadFileUrl);
        if(ObjectUtil.isEmpty(fileName)){
            fileName=file.getName();
        }
        try{
            upload(directory, fileName, new FileInputStream(file));
        }catch (FileNotFoundException | SftpException e){
            log.error("上传文件异常!", e);
        }
    }

    /**
     * 将byte[] 上传到SFTP服务器,作为文件
     *           注: 从String转换成byte[] 需要指定字符集
     *
     * @param directory     上传到SFTP服务器的路径
     * @param sftpFileName  上传SFTP服务器后的文件名
     * @param bytes         字节数组
     */
    public void upload(String directory, String sftpFileName, byte[] bytes){
        try{
            upload(directory, sftpFileName, new ByteArrayInputStream(bytes));
        }catch (SftpException e){
            log.error("上传文件异常!", e);
        }
    }

    /**
     * 将字符串按照指定编码格式上传到SFTP服务器
     *
     * @param directory       上传到SFTP服务器的路径
     * @param sftpFileName    上传SFTP服务器后的文件名
     * @param dataStr         字符串
     * @param charsetName     字符串的编码格式
     */
    public void upload(String directory, String sftpFileName, String dataStr, String charsetName){
        try{
            upload(directory, sftpFileName, new ByteArrayInputStream(dataStr.getBytes(charsetName)));
        }catch (UnsupportedEncodingException | SftpException e){
            log.error("上传文件异常!", e);
        }
    }

    /**
     * 下载文件
     *
     * @param directory     SFTP服务器的文件路径
     * @param downloadFile  SFTP服务器上的文件名
     * @param saveFile      保存到本地路径
     */
    public void download(String directory, String downloadFile, String saveFile){
        try{
            if(directory != null && !"".equals(directory)){
                sftp.cd(directory);
            }
            File file = new File(saveFile);
            sftp.get(downloadFile, new FileOutputStream(file));
        }catch (SftpException | FileNotFoundException e){
            log.error("文件下载异常!", e);
        }
    }

    /**
     * 下载文件
     *
     * @param directory     SFTP服务器的文件路径
     * @param downloadFile  SFTP服务器上的文件名
     * @return              字节数组
     */
    public byte[] download(String directory, String downloadFile){
        try{
            if(directory != null && !"".equals(directory)){
                sftp.cd(directory);
            }
            InputStream inputStream = sftp.get(downloadFile);
            return IOUtils.toByteArray(inputStream);
        }catch (SftpException | IOException e){
            log.error("文件下载异常!", e);
        }
        return null;
    }

    /**
     * 下载文件
     *
     * @param directory     SFTP服务器的文件路径
     * @param downloadFile  SFTP服务器上的文件名
     * @return              输入流
     */
    public InputStream downloadStream(String directory, String downloadFile){
        try{
            if(directory != null && !"".equals(directory)){
                sftp.cd(directory);
            }
            return sftp.get(downloadFile);
        }catch (SftpException e){
            log.error("文件下载异常!", e);
        }
        return null;
    }

//    /**
//     * 删除文件
//     *
//     * @param directory         SFTP服务器的文件路径
//     * @param deleteFileName    删除的文件名称
//     */
//    public void delete(String directory, String deleteFileName){
//        try{
//            sftp.cd(directory);
//            sftp.rm(deleteFileName);
//        }catch (SftpException e){
//            log.error("文件删除异常!", e);
//        }
//    }
//
//    /**
//     * 删除文件夹(有问题:remove(0)不一定删除的是上级目录和根目录)
//     *
//     * @param directory         SFTP服务器的文件路径
//     */
//    public void delete(String directory){
//        Vector vector = listFiles(directory);
//        vector.remove(0);
//        vector.remove(0);
//        for(Object v : vector){
//            ChannelSftp.LsEntry lsEntry = (ChannelSftp.LsEntry)v;
//            try{
//                sftp.cd(directory);
//                sftp.rm(lsEntry.getFilename());
//            }catch (SftpException e){
//                log.error("文件删除异常!", e);
//            }
//        }
//    }

    /**
     * 获取文件夹下的文件
     *
     * @param directory     路径
     * @return
     */
    public Vector<?> listFiles(String directory){
        try{
            if(isDirExist(directory)){
                Vector<?> vector =  sftp.ls(directory);
//                //移除上级目录和根目录:"." ".."
//                vector.remove(0); //不适用
//                vector.remove(0);

//                for (Object object : vector) {
//                    if (object instanceof ChannelSftp.LsEntry) {
//                        ChannelSftp.LsEntry lsEntry = (ChannelSftp.LsEntry) object;
//                        String fileName = lsEntry.getFilename();
//                        if (StringUtils.equals(fileName,".")||StringUtils.equals(fileName,"..")) {
//                            vector.remove(object);
//                        }
//                    }
//                }
                return vector;
            }
        }catch (SftpException e){
            log.error("获取文件夹信息异常!", e);
        }
        return null;
    }

    /**
     * 检测文件夹是否存在
     *
     * @param directory     路径
     * @return
     */
    public boolean booleanUrl(String directory){
        try{
            if(sftp.ls(directory) == null){
                return false;
            }
        }catch (Exception e){
            log.error("检测文件夹异常!", e);
        }
        return true;
    }

    /**
     * 创建一个文件目录
     *
     * @param createpath        路径
     * @return
     */
    public boolean createDir(String createpath) {
        try {
            if (isDirExist(createpath)) {
                this.sftp.cd(createpath);
                return true;
            }
            String pathArry[] = createpath.split("/");
            StringBuffer filePath = new StringBuffer("/");
            for (String path : pathArry) {
                if (path.equals("")) {
                    continue;
                }
                filePath.append(path + "/");
                if (isDirExist(filePath.toString())) {
                    sftp.cd(filePath.toString());
                } else {
                    // 建立目录
                    sftp.mkdir(filePath.toString());
                    // 进入并设置为当前目录
                    sftp.cd(filePath.toString());
                }
            }
            this.sftp.cd(createpath);
        } catch (SftpException e) {
            log.error("目录创建异常!", e);
            return false;
        }
        return true;
    }

    /**
     * 判断目录是否存在
     * @param directory     路径
     * @return
     */
    public boolean isDirExist(String directory) {
        boolean isDirExistFlag = false;
        try {
            SftpATTRS sftpATTRS = this.sftp.lstat(directory);
            isDirExistFlag = true;
            return sftpATTRS.isDir();
        } catch (Exception e) {
            if (e.getMessage().toLowerCase().equals("no such file")) {
                isDirExistFlag = false;
            }
            log.error("目录不存在:"+directory);
        }
        return isDirExistFlag;
    }

    /**
     * 方法功能说明:目录不存在时创建目录
     * @参数: @param path
     * @return void
     * @throws
     */
    public void mkdirs(String path){
        File file = new File(path);
        String fs = file.getParent();
        file = new File(fs);
        if(!file.exists()){
            file.mkdirs();
        }
    }
    /**
     * 判断文件或目录是否存在
     * @return
     */
    public boolean isExist(String path, ChannelSftp sftp){
        boolean  isExist=false;
        try {
            sftp.lstat(path);
            isExist = true;
        } catch (Exception e) {
            if (e.getMessage().toLowerCase().equals("no such file")) {
                isExist = false;
            }
        }
        return isExist;
    }
}