common ftp api

Apache Commons Net库中的FTPClient类是一个用于执行FTP协议操作的强大工具，它提供了丰富的API来简化与FTP服务器的交互，以下是对Common FTP API的详细解析：

一、连接与断开

1、connect(String host, int port, int timeout)：连接到指定的FTP服务器和端口，参数包括服务器地址（host）、端口号（port）以及超时时间（timeout）。ftp.connect("ftp.example.com", 21, 3000);将连接到ftp.example.com的21端口，并设置超时时间为3000毫秒。

2、disconnect()：关闭与FTP服务器的连接，释放资源，在完成所有FTP操作后，应调用此方法以确保资源得到正确释放。

二、登录与注销

1、login(String user, String pass)：使用用户名和密码登录到FTP服务器。ftp.login("username", "password");将使用提供的用户名和密码进行登录。

2、logout()：退出当前会话，但保持与服务器的连接，这在某些需要重新登录或更改用户身份的情况下可能很有用。

三、模式设置

1、setFileType(int fileType)：设置文件传输类型，常见的值包括FTP.BINARY_FILE_TYPE（二进制文件）和FTP.ASCII_FILE_TYPE（文本文件），二进制模式适用于所有类型的文件，而文本模式主要用于纯文本文件。

2、enterLocalPassiveMode()：进入被动模式，即服务器向客户端发送数据，这种模式通常用于解决网络防火墙或NAT设备引起的连接问题。

3、enterLocalActiveMode()：进入主动模式，即客户端向服务器发送数据，这是FTP的默认模式。

四、目录操作

1、changeWorkingDirectory(String dir)：改变当前工作目录到指定目录。ftp.changeWorkingDirectory("/remote/dir/");将工作目录切换到/remote/dir/。

2、printWorkingDirectory()：打印当前工作目录的路径，这对于调试和验证当前目录位置非常有用。

3、listNames(String dir)：返回指定目录下的文件和目录名称列表，这对于列出远程目录内容非常有用。

4、listFiles(String dir)：返回指定目录下的FTPFile对象列表，这些对象包含了关于文件和目录的详细信息。

5、makeDirectory(String dir)：在远程FTP服务器上创建新目录。ftp.makeDirectory("/remote/dir/newDir/");将在远程服务器上创建newDir目录。

6、removeDirectory(String dir)：删除远程FTP服务器上的目录及其内容，请谨慎使用此方法，因为它将永久删除目录及其所有内容。

五、文件传输

1、storeFile(String remote, InputStream local)：上传本地文件到远程FTP服务器，参数包括远程文件路径（remote）和本地文件的输入流（local），可以使用FileInputStream作为输入流来上传本地文件。

2、retrieveFile(String remote, OutputStream local)：从远程FTP服务器下载文件到本地，参数包括远程文件路径（remote）和本地文件的输出流（local），可以使用FileOutputStream作为输出流来保存下载的文件。

3、deleteFile(String fileName)：删除远程FTP服务器上的文件，请确保提供正确的文件路径，以避免误删重要文件。

六、权限与状态查询

1、isConnected()：检查是否已连接到FTP服务器，返回值为布尔类型，表示当前连接状态。

2、getStatus()：返回当前FTP会话的状态信息，如是否已登录、是否处于被动模式等。

3、getReplyCode()：获取服务器的响应代码，以了解命令执行情况，这对于调试和错误处理非常有用。

七、配置

1、setConfig(Configuration config)：由于实现了Configurable接口，FTPClient允许通过此方法配置相关参数，如超时时间、数据缓冲区大小等，以适应不同的服务器环境和需求。

八、异常处理

1、捕获异常：在执行FTP操作时，可能会遇到网络问题、权限问题等异常情况，需要捕获并处理这些异常，以确保程序的稳定性和健壮性，常见的异常类包括FTPConnectionClosedException、FTPFileAccessException等。

Common FTP API提供了一套完整且灵活的工具集，使得开发者能够轻松地与FTP服务器进行交互，实现文件的上传、下载、目录管理等功能，通过合理的异常处理和配置选项，可以进一步增强程序的健壮性和适应性。