FtpClient一定要setSotimeOut、setDataTimeout

天天代码码天天

已于 2023-12-12 13:34:04 修改

阅读量7.6k

点赞数 4

分类专栏： java 文章标签：开发语言 java

于 2021-01-31 19:53:32 首次发布

本文链接：https://blog.csdn.net/lw112190/article/details/113483744

版权

java 专栏收录该内容

26 篇文章

订阅专栏

本文详细解释了`SocketOptions#SO_TIMEOUT`选项的作用，它用于设置Socket在读取数据时的超时时间，防止因网络波动导致的无限期阻塞。在FTP连接中，通常需要设置默认连接超时、数据传输超时和SO_TIMEOUT以确保程序在长时间无响应时能够正常退出。示例代码展示了如何在FTPClient中设置这些超时值，确保FTP连接的稳定性和可靠性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SotimeOut，简单说就是读取数据时阻塞链路的超时时间。

/**
* Enable/disable {@link SocketOptions#SO_TIMEOUT SO_TIMEOUT}
* with the specified timeout, in milliseconds. With this option set
* to a non-zero timeout, a read() call on the InputStream associated with
* this Socket will block for only this amount of time. If the timeout
* expires, a java.net.SocketTimeoutException is raised, though the
* Socket is still valid. The option must be enabled
* prior to entering the blocking operation to have effect. The
* timeout must be {@code > 0}.
* A timeout of zero is interpreted as an infinite timeout.
* （设置一个超时时间，用来当这个 Socket 调用了 read() 从 InputStream 输入流中
* 读取数据的过程中，如果线程进入了阻塞状态，那么这次阻塞的过程耗费的时间如果
* 超过了设置的超时时间，就会抛出一个 SocketTimeoutException 异常，但只是将
* 线程从读数据这个过程中断掉，并不影响 Socket 的后续使用。
* 如果超时时间为0，表示无限长。）
* （注意，并不是读取输入流的整个过程的超时时间，而仅仅是每一次进入阻塞等待输入流中
* 有数据可读的超时时间）
* @param timeout the specified timeout, in milliseconds.
* @exception SocketException if there is an error
* in the underlying protocol, such as a TCP error.
* @since JDK 1.1
* @see #getSoTimeout()
*/
public synchronized void setSoTimeout(int timeout) throws SocketException {
//.....
}

/**
  *  Enable/disable {@link SocketOptions#SO_TIMEOUT SO_TIMEOUT}
  *  with the specified timeout, in milliseconds. With this option set
  *  to a non-zero timeout, a read() call on the InputStream associated with
  *  this Socket will block for only this amount of time.  If the timeout
  *  expires, a <B>java.net.SocketTimeoutException</B> is raised, though the
  *  Socket is still valid. The option <B>must</B> be enabled
  *  prior to entering the blocking operation to have effect. The
  *  timeout must be {@code > 0}.
  *  A timeout of zero is interpreted as an infinite timeout.
  *  （设置一个超时时间，用来当这个 Socket 调用了 read() 从 InputStream 输入流中
  *    读取数据的过程中，如果线程进入了阻塞状态，那么这次阻塞的过程耗费的时间如果
  *    超过了设置的超时时间，就会抛出一个 SocketTimeoutException 异常，但只是将
  *    线程从读数据这个过程中断掉，并不影响 Socket 的后续使用。
  *    如果超时时间为0，表示无限长。）
  *  （注意，并不是读取输入流的整个过程的超时时间，而仅仅是每一次进入阻塞等待输入流中
  *    有数据可读的超时时间）
  * @param timeout the specified timeout, in milliseconds.
  * @exception SocketException if there is an error
  * in the underlying protocol, such as a TCP error.
  * @since   JDK 1.1
  * @see #getSoTimeout()
  */
 public synchronized void setSoTimeout(int timeout) throws SocketException {
    //.....
 }

/**
* Sets the timeout in milliseconds to use when reading from the
* data connection. This timeout will be set immediately after
* opening the data connection, provided that the value is ≥ 0.
* 
* Note: the timeout will also be applied when calling accept()
* whilst establishing an active local data connection.
* @param timeout The default timeout in milliseconds that is used when
* opening a data connection socket. The value 0 means an infinite timeout.
*/
public void setDataTimeout(int timeout)
{
__dataTimeout = timeout;
}

/**
  * Sets the timeout in milliseconds to use when reading from the
  * data connection.  This timeout will be set immediately after
  * opening the data connection, provided that the value is &ge; 0.
  * <p>
  * <b>Note:</b> the timeout will also be applied when calling accept()
  * whilst establishing an active local data connection.
  * @param  timeout The default timeout in milliseconds that is used when
  *        opening a data connection socket. The value 0 means an infinite timeout.
  */
 public void setDataTimeout(int timeout)
 {
     __dataTimeout = timeout;
 }

如果不设置，可能会在网络波动时阻塞，至此无限时阻塞在此！！！

所以使用ftp时，一般需要设置timeout来保证程序正常运行（不卡死）。

FTPClient ftpClient = null;
try {
ftpClient = new FTPClient();
ftpClient.setDefaultTimeout(10000);
ftpClient.setConnectTimeout(10000);
ftpClient.setDataTimeout(10000);

// 连接FTP服务器
ftpClient.connect(host, port);
// 登陆FTP服务器
ftpClient.login(userName, password);
// 中文支持
ftpClient.setControlEncoding("UTF-8");
// 设置文件类型为二进制（如果从FTP下载或上传的文件是压缩文件的时候，不进行该设置可能会导致获取的压缩文件解压失败）
ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE);
// 主动模式
//ftpClient.enterLocalActiveMode();
// 被动模式每次数据连接之前，ftp client告诉ftp server开通一个端口来传输数据防止假卡死
ftpClient.enterLocalPassiveMode();

if (!FTPReply.isPositiveCompletion(ftpClient.getReplyCode())) {
logger.error("连接FTP失败");
ftpClient.disconnect();
} else {
ftpClient.setSoTimeout(10000);
logger.info("FTP连接成功!");
}
} catch (Exception e) {
e.printStackTrace();
logger.error("登陆FTP失败，请检查FTP相关配置信息是否正确！", e);
}
return ftpClient;

FTPClient ftpClient = null;
try {
    ftpClient = new FTPClient();
    ftpClient.setDefaultTimeout(10000);
    ftpClient.setConnectTimeout(10000);
    ftpClient.setDataTimeout(10000);

    // 连接FTP服务器
    ftpClient.connect(host, port);
    // 登陆FTP服务器
    ftpClient.login(userName, password);
    // 中文支持
    ftpClient.setControlEncoding("UTF-8");
    // 设置文件类型为二进制（如果从FTP下载或上传的文件是压缩文件的时候，不进行该设置可能会导致获取的压缩文件解压失败）
    ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE);
    // 主动模式
    //ftpClient.enterLocalActiveMode();
    // 被动模式 每次数据连接之前，ftp client告诉ftp server开通一个端口来传输数据 防止假卡死
    ftpClient.enterLocalPassiveMode();

    if (!FTPReply.isPositiveCompletion(ftpClient.getReplyCode())) {
        logger.error("连接FTP失败");
        ftpClient.disconnect();
    } else {
        ftpClient.setSoTimeout(10000);
        logger.info("FTP连接成功!");
    }
} catch (Exception e) {
    e.printStackTrace();
    logger.error("登陆FTP失败，请检查FTP相关配置信息是否正确！", e);
}
return ftpClient;