lsm/hutool
1
0
Fork 0
mirror of https://gitee.com/dromara/hutool.git synced 2026-02-09 09:16:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

修复Sftp.upload目标路径为null时空指针问题（issue#ID14WX@Gitee）

Browse Source
This commit is contained in:
Looly
2025-10-10 17:23:48 +08:00
parent 2f6662b4aa
commit c86a30e392
4 changed files with 80 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
hutool-extra/src/main/java/cn/hutool/v7/extra/ftp/CommonsFtp.java
View File

@@ -634,30 +634,30 @@ public class CommonsFtp extends AbstractFtp {
/** /**
* 下载文件 * 下载文件
* *
* @param path 文件路径，包含文件名 * @param remotePath 文件路径，包含文件名
* @param outFile 输出文件或目录，当为目录时，使用服务端的文件名 * @param outFile 输出文件或目录，当为目录时，使用服务端的文件名
*/ */
@Override @Override
public void download(final String path, final File outFile) { public void download(final String remotePath, final File outFile) {
final String fileName = FileNameUtil.getName(path); final String fileName = FileNameUtil.getName(remotePath);
final String dir = StrUtil.removeSuffix(path, fileName); final String dir = StrUtil.removeSuffix(remotePath, fileName);
download(dir, fileName, outFile); download(dir, fileName, outFile);
} }
/** /**
* 递归下载FTP服务器上文件到本地(文件目录和服务器同步) * 递归下载FTP服务器上文件到本地(文件目录和服务器同步)
* *
* @param sourcePath ftp服务器目录 * @param remotePath ftp服务器目录
* @param targetDir 本地目录 * @param targetDir 本地目录
*/ */
@Override @Override
public void recursiveDownloadFolder(final String sourcePath, final File targetDir) { public void recursiveDownloadFolder(final String remotePath, final File targetDir) {
String fileName; String fileName;
String srcFile; String srcFile;
File destFile; File destFile;
for (final FTPFile ftpFile : lsFiles(sourcePath, null)) { for (final FTPFile ftpFile : lsFiles(remotePath, null)) {
fileName = ftpFile.getName(); fileName = ftpFile.getName();
srcFile = StrUtil.format("{}/{}", sourcePath, fileName); srcFile = StrUtil.format("{}/{}", remotePath, fileName);
destFile = FileUtil.file(targetDir, fileName); destFile = FileUtil.file(targetDir, fileName);
if (!ftpFile.isDirectory()) { if (!ftpFile.isDirectory()) {

14
hutool-extra/src/main/java/cn/hutool/v7/extra/ftp/Ftp.java
View File

@@ -153,31 +153,31 @@ public interface Ftp extends Closeable {
boolean delDir(String dirPath); boolean delDir(String dirPath);
/** /**
* 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。 * 将本地文件上传到目标服务器，目标文件名为remotePath，若remotePath为目录，则目标文件名将与file文件名相同。
* 覆盖模式 * 覆盖模式
* *
* @param destPath 服务端路径，可以为{@code null} 或者相对路径或绝对路径 * @param remotePath 服务端路径，可以为{@code null} 或者相对路径或绝对路径
* @param file 需要上传的文件 * @param file 需要上传的文件
* @return 是否成功 * @return 是否成功
*/ */
boolean uploadFile(String destPath, File file); boolean uploadFile(String remotePath, File file);
/** /**
* 下载文件 * 下载文件
* *
* @param path 文件路径 * @param remotePath 文件路径
* @param outFile 输出文件或目录 * @param outFile 输出文件或目录
*/ */
void download(String path, File outFile); void download(String remotePath, File outFile);
/** /**
* 递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件 * 递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件
* *
* @param sourcePath ftp服务器目录 * @param remotePath ftp服务器目录
* @param targetDir 本地目录 * @param targetDir 本地目录
* @since 5.3.5 * @since 5.3.5
*/ */
void recursiveDownloadFolder(String sourcePath, File targetDir); void recursiveDownloadFolder(String remotePath, File targetDir);
/** /**
* 读取FTP服务器上的文件为输入流 * 读取FTP服务器上的文件为输入流

81
hutool-extra/src/main/java/cn/hutool/v7/extra/ssh/engine/jsch/JschSftp.java
View File

@@ -16,7 +16,6 @@
package cn.hutool.v7.extra.ssh.engine.jsch; package cn.hutool.v7.extra.ssh.engine.jsch;
import com.jcraft.jsch.*;
import cn.hutool.v7.core.collection.CollUtil; import cn.hutool.v7.core.collection.CollUtil;
import cn.hutool.v7.core.collection.ListUtil; import cn.hutool.v7.core.collection.ListUtil;
import cn.hutool.v7.core.io.file.FileUtil; import cn.hutool.v7.core.io.file.FileUtil;
@@ -24,10 +23,11 @@ import cn.hutool.v7.core.text.StrUtil;
import cn.hutool.v7.extra.ftp.AbstractFtp; import cn.hutool.v7.extra.ftp.AbstractFtp;
import cn.hutool.v7.extra.ftp.FtpConfig; import cn.hutool.v7.extra.ftp.FtpConfig;
import cn.hutool.v7.extra.ftp.FtpException; import cn.hutool.v7.extra.ftp.FtpException;
import com.jcraft.jsch.ChannelSftp.LsEntry;
import com.jcraft.jsch.ChannelSftp.LsEntrySelector;
import cn.hutool.v7.extra.ssh.Connector; import cn.hutool.v7.extra.ssh.Connector;
import cn.hutool.v7.extra.ssh.SshException; import cn.hutool.v7.extra.ssh.SshException;
import com.jcraft.jsch.*;
import com.jcraft.jsch.ChannelSftp.LsEntry;
import com.jcraft.jsch.ChannelSftp.LsEntrySelector;
import java.io.File; import java.io.File;
import java.io.InputStream; import java.io.InputStream;
@@ -57,6 +57,7 @@ public class JschSftp extends AbstractFtp {
private ChannelSftp channel; private ChannelSftp channel;
//region ----- of //region ----- of
/** /**
* 构造 * 构造
* *
@@ -85,6 +86,7 @@ public class JschSftp extends AbstractFtp {
} }
// endregion // endregion
// region ----- Constructor
/** /**
* 构造 * 构造
* *
@@ -136,7 +138,7 @@ public class JschSftp extends AbstractFtp {
this.channel = channel; this.channel = channel;
init(); init();
} }
// ---------------------------------------------------------------------------------------- Constructor end // endregion
/** /**
* 初始化 * 初始化
@@ -456,6 +458,7 @@ public class JschSftp extends AbstractFtp {
} }
} }
// region ----- upload
/** /**
* 将本地文件或者文件夹同步（覆盖）上传到远程路径 * 将本地文件或者文件夹同步（覆盖）上传到远程路径
* *
@@ -487,12 +490,12 @@ public class JschSftp extends AbstractFtp {
@SuppressWarnings("resource") @SuppressWarnings("resource")
@Override @Override
public boolean uploadFile(final String destPath, final File file) { public boolean uploadFile(final String remotePath, final File file) {
if (!FileUtil.isFile(file)) { if (!FileUtil.isFile(file)) {
throw new FtpException("[{}] is not a file!", file); throw new FtpException("[{}] is not a file!", file);
} }
this.mkDirs(destPath); this.mkDirs(remotePath);
put(FileUtil.getAbsolutePath(file), destPath); put(FileUtil.getAbsolutePath(file), remotePath);
return true; return true;
} }
@@ -505,52 +508,57 @@ public class JschSftp extends AbstractFtp {
* 3. path为绝对路径则上传到此路径 * 3. path为绝对路径则上传到此路径
* </pre> * </pre>
* *
* @param destPath 服务端路径，可以为{@code null} 或者相对路径或绝对路径 * @param remotePath 服务端路径，可以为{@code null} 或者相对路径或绝对路径
* @param fileName 文件名 * @param fileName 文件名
* @param fileStream 文件流 * @param fileStream 文件流
* @since 5.7.16 * @since 5.7.16
*/ */
public void uploadFile(String destPath, final String fileName, final InputStream fileStream) { public void uploadFile(String remotePath, final String fileName, final InputStream fileStream) {
destPath = StrUtil.addSuffixIfNot(destPath, StrUtil.SLASH) + StrUtil.removePrefix(fileName, StrUtil.SLASH); remotePath = StrUtil.addSuffixIfNot(remotePath, StrUtil.SLASH) + StrUtil.removePrefix(fileName, StrUtil.SLASH);
put(fileStream, destPath, null, Mode.OVERWRITE); put(fileStream, remotePath, null, Mode.OVERWRITE);
} }
// endregion
// region ----- put
/** /**
* 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。覆盖模式 * 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。覆盖模式
* *
* @param srcFilePath 本地文件路径 * @param srcFilePath 本地文件路径
* @param destPath 目标路径， * @param remotePath 目标路径，{@code null}表示当前路径
* @return this * @return this
*/ */
public JschSftp put(final String srcFilePath, final String destPath) { public JschSftp put(final String srcFilePath, final String remotePath) {
return put(srcFilePath, destPath, Mode.OVERWRITE); return put(srcFilePath, remotePath, Mode.OVERWRITE);
} }
/** /**
* 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。 * 将本地文件上传到目标服务器，目标文件名为remotePath，若remotePath为目录，则目标文件名将与srcFilePath文件名相同。
* *
* @param srcFilePath 本地文件路径 * @param srcFilePath 本地文件路径
* @param destPath 目标路径， * @param remotePath 目标路径，{@code null}表示当前路径
* @param mode {@link Mode} 模式 * @param mode {@link Mode} 模式
* @return this * @return this
*/ */
public JschSftp put(final String srcFilePath, final String destPath, final Mode mode) { public JschSftp put(final String srcFilePath, final String remotePath, final Mode mode) {
return put(srcFilePath, destPath, null, mode); return put(srcFilePath, remotePath, null, mode);
} }
/** /**
* 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。 * 将本地文件上传到目标服务器，目标文件名为remotePath，若remotePath为目录，则目标文件名将与srcFilePath文件名相同。
* *
* @param srcFilePath 本地文件路径 * @param srcFilePath 本地文件路径
* @param destPath 目标路径， * @param remotePath 目标路径，{@code null}表示当前路径
* @param monitor 上传进度监控，通过实现此接口完成进度显示 * @param monitor 上传进度监控，通过实现此接口完成进度显示
* @param mode {@link Mode} 模式 * @param mode {@link Mode} 模式
* @return this * @return this
* @since 4.6.5 * @since 4.6.5
*/ */
public JschSftp put(final String srcFilePath, final String destPath, final SftpProgressMonitor monitor, final Mode mode) { public JschSftp put(final String srcFilePath, String remotePath, final SftpProgressMonitor monitor, final Mode mode) {
if(StrUtil.isEmpty(remotePath)){
remotePath = pwd();
}
try { try {
getClient().put(srcFilePath, destPath, monitor, mode.ordinal()); getClient().put(srcFilePath, remotePath, monitor, mode.ordinal());
} catch (final SftpException e) { } catch (final SftpException e) {
throw new SshException(e); throw new SshException(e);
} }
@@ -561,24 +569,29 @@ public class JschSftp extends AbstractFtp {
* 将本地数据流上传到目标服务器，目标文件名为destPath，目标必须为文件 * 将本地数据流上传到目标服务器，目标文件名为destPath，目标必须为文件
* *
* @param srcStream 本地的数据流 * @param srcStream 本地的数据流
* @param destPath 目标路径， * @param remotePath 目标路径，{@code null}表示当前路径
* @param monitor 上传进度监控，通过实现此接口完成进度显示 * @param monitor 上传进度监控，通过实现此接口完成进度显示
* @param mode {@link Mode} 模式 * @param mode {@link Mode} 模式
* @return this * @return this
* @since 5.7.16 * @since 5.7.16
*/ */
public JschSftp put(final InputStream srcStream, final String destPath, final SftpProgressMonitor monitor, final Mode mode) { public JschSftp put(final InputStream srcStream, String remotePath, final SftpProgressMonitor monitor, final Mode mode) {
if(StrUtil.isEmpty(remotePath)){
remotePath = pwd();
}
try { try {
getClient().put(srcStream, destPath, monitor, mode.ordinal()); getClient().put(srcStream, remotePath, monitor, mode.ordinal());
} catch (final SftpException e) { } catch (final SftpException e) {
throw new SshException(e); throw new SshException(e);
} }
return this; return this;
} }
// endregion
// region ----- download
@Override @Override
public void download(final String src, final File destFile) { public void download(final String remotePath, final File destFile) {
get(src, FileUtil.getAbsolutePath(destFile)); get(remotePath, FileUtil.getAbsolutePath(destFile));
} }
/** /**
@@ -595,17 +608,17 @@ public class JschSftp extends AbstractFtp {
/** /**
* 递归下载FTP服务器上文件到本地(文件目录和服务器同步) * 递归下载FTP服务器上文件到本地(文件目录和服务器同步)
* *
* @param sourcePath ftp服务器目录，必须为目录 * @param remotePath ftp服务器目录，必须为目录
* @param targetDir 本地目录 * @param targetDir 本地目录
*/ */
@Override @Override
public void recursiveDownloadFolder(final String sourcePath, final File targetDir) throws SshException { public void recursiveDownloadFolder(final String remotePath, final File targetDir) throws SshException {
String fileName; String fileName;
String srcFile; String srcFile;
File destFile; File destFile;
for (final LsEntry item : lsEntries(sourcePath)) { for (final LsEntry item : lsEntries(remotePath)) {
fileName = item.getFilename(); fileName = item.getFilename();
srcFile = StrUtil.format("{}/{}", sourcePath, fileName); srcFile = StrUtil.format("{}/{}", remotePath, fileName);
destFile = FileUtil.file(targetDir, fileName); destFile = FileUtil.file(targetDir, fileName);
if (!item.getAttrs().isDir()) { if (!item.getAttrs().isDir()) {
@@ -620,9 +633,10 @@ public class JschSftp extends AbstractFtp {
recursiveDownloadFolder(srcFile, destFile); recursiveDownloadFolder(srcFile, destFile);
} }
} }
} }
// endregion
// region ----- get
/** /**
* 获取远程文件 * 获取远程文件
* *
@@ -664,6 +678,7 @@ public class JschSftp extends AbstractFtp {
throw new SshException(e); throw new SshException(e);
} }
} }
// endregion
@Override @Override
public void close() { public void close() {

31
hutool-extra/src/main/java/cn/hutool/v7/extra/ssh/engine/sshj/SshjSftp.java
View File

@@ -160,12 +160,12 @@ public class SshjSftp extends AbstractFtp {
// command(exec); // command(exec);
// final String pwd = pwd(); // final String pwd = pwd();
// return pwd.equals(directory); // return pwd.equals(directory);
String newPath = getPath(directory); final String newPath = getPath(directory);
try { try {
sftp.ls(newPath); sftp.ls(newPath);
this.workingDir = newPath; this.workingDir = newPath;
return true; return true;
} catch (IOException e) { } catch (final IOException e) {
throw new FtpException(e); throw new FtpException(e);
} }
} }
@@ -201,7 +201,7 @@ public class SshjSftp extends AbstractFtp {
} }
@Override @Override
public boolean rename(String oldPath, String newPath) { public boolean rename(final String oldPath, final String newPath) {
try { try {
sftp.rename(oldPath, newPath); sftp.rename(oldPath, newPath);
return containsFile(newPath); return containsFile(newPath);
@@ -231,29 +231,32 @@ public class SshjSftp extends AbstractFtp {
} }
@Override @Override
public boolean uploadFile(String destPath, final File file) { public boolean uploadFile(String remotePath, final File file) {
if(null == remotePath){
remotePath = pwd();
}
try { try {
if (StrUtil.endWith(destPath, StrUtil.SLASH)) { if (StrUtil.endWith(remotePath, StrUtil.SLASH)) {
destPath += file.getName(); remotePath += file.getName();
} }
sftp.put(new FileSystemFile(file), getPath(destPath)); sftp.put(new FileSystemFile(file), getPath(remotePath));
return containsFile(getPath(destPath)); return containsFile(getPath(remotePath));
} catch (final IOException e) { } catch (final IOException e) {
throw new FtpException(e); throw new FtpException(e);
} }
} }
@Override @Override
public void download(final String path, final File outFile) { public void download(final String remotePath, final File outFile) {
try { try {
sftp.get(getPath(path), new FileSystemFile(outFile)); sftp.get(getPath(remotePath), new FileSystemFile(outFile));
} catch (final IOException e) { } catch (final IOException e) {
throw new FtpException(e); throw new FtpException(e);
} }
} }
@Override @Override
public void recursiveDownloadFolder(final String sourcePath, final File targetDir) { public void recursiveDownloadFolder(final String remotePath, final File targetDir) {
if (!targetDir.exists()) { if (!targetDir.exists()) {
if (!targetDir.mkdirs()) { if (!targetDir.mkdirs()) {
throw new FtpException("Dir {} create failed!", targetDir.getAbsolutePath()); throw new FtpException("Dir {} create failed!", targetDir.getAbsolutePath());
@@ -262,9 +265,9 @@ public class SshjSftp extends AbstractFtp {
throw new FtpException("Target is not a directory!"); throw new FtpException("Target is not a directory!");
} }
List<String> files = ls(getPath(sourcePath)); final List<String> files = ls(getPath(remotePath));
if (CollUtil.isNotEmpty(files)) { if (CollUtil.isNotEmpty(files)) {
files.forEach(file -> download(sourcePath + StrUtil.SLASH + file, FileUtil.file(targetDir, file))); files.forEach(file -> download(remotePath + StrUtil.SLASH + file, FileUtil.file(targetDir, file)));
} }
} }
@@ -364,7 +367,7 @@ public class SshjSftp extends AbstractFtp {
if (StrUtil.isBlank(this.workingDir)) { if (StrUtil.isBlank(this.workingDir)) {
try { try {
this.workingDir = sftp.canonicalize(StrUtil.EMPTY); this.workingDir = sftp.canonicalize(StrUtil.EMPTY);
} catch (IOException e) { } catch (final IOException e) {
throw new FtpException(e); throw new FtpException(e);
} }
} }