Python实现FTP上传文件或文件夹实例（递归）

### Python 实现 FTP 上传文件或文件夹实例（递归） #### 一、引言 在互联网技术领域中，文件传输协议（File Transfer Protocol，简称 FTP）是一种用于在网络上进行文件传输的标准服务和协议。它允许用户在一个计算机系统上将文件传输到另一个计算机系统上。在实际开发中，有时我们需要通过程序自动完成文件或者文件夹的上传工作，特别是在分布式系统或自动化部署场景中。Python 作为一种强大的编程语言，提供了丰富的库支持 FTP 操作，使得这项任务变得简单而高效。 #### 二、基础知识简介 1. **FTP 协议简介**：FTP 是一种基于客户/服务器模型的应用层协议，用于在两台计算机之间传输文件。FTP 使用两个 TCP 连接来完成文件传输：一个控制连接（端口 21）用于发送命令，一个数据连接（默认端口 20）用于实际的数据传输。 2. **Python 的 FTP 支持**：Python 内置了 `ftplib` 模块，该模块提供了与 FTP 服务器交互的功能，包括登录、下载、上传等操作。使用 `ftplib` 可以轻松地实现 FTP 的基本功能。 3. **递归上传文件夹**：递归是指函数调用自身的过程，在处理文件夹上传时尤其有用。递归上传文件夹意味着不仅要上传文件夹中的文件，还要上传子文件夹及其包含的所有内容。 #### 三、代码详解 ##### 3.1 模块导入 ```python import sys import os import json from ftplib import FTP ``` - `sys` 模块提供访问和使用解释器环境的变量和功能； - `os` 模块提供了一种使用操作系统依赖功能的方式，如创建目录、更改工作目录等； - `json` 模块用于处理 JSON 数据，尽管在这个例子中没有被使用； - `ftplib` 模块用于实现 FTP 功能。 ##### 3.2 类定义 ```python class Xfer(object): def __init__(self): self.ftp = None ``` 定义了一个名为 `Xfer` 的类，用于封装 FTP 相关的操作。 ##### 3.3 设置 FTP 参数 ```python def setFtpParams(self, ip, uname, pwd, port=21, timeout=60): self.ip = ip self.uname = uname self.pwd = pwd self.port = port self.timeout = timeout ``` 此方法用于设置 FTP 服务器的基本参数，如 IP 地址、用户名、密码等。 ##### 3.4 初始化和清理环境 ```python def initEnv(self): if self.ftp is None: self.ftp = FTP() print('### connect ftp server:', self.ip) self.ftp.connect(self.ip, self.port, self.timeout) self.ftp.login(self.uname, self.pwd) print(self.ftp.getwelcome()) def clearEnv(self): if self.ftp: self.ftp.close() print('### disconnect ftp server:', self.ip) self.ftp = None ``` 这两个方法分别用于初始化 FTP 连接和断开连接，确保资源得到释放。 ##### 3.5 上传文件和文件夹 ```python def uploadDir(self, localdir='./', remotedir='./'): if not os.path.isdir(localdir): return self.ftp.cwd(remotedir) for file in os.listdir(localdir): src = os.path.join(localdir, file) if os.path.isfile(src): self.uploadFile(src, file) elif os.path.isdir(src): try: self.ftp.mkd(file) except: sys.stderr.write('the dir is exists %s' % file) self.uploadDir(src, file) self.ftp.cwd('..') def uploadFile(self, localpath, remotepath='./'): if not os.path.isfile(localpath): return print('+++ upload %s to %s: %s' % (localpath, self.ip, remotepath)) self.ftp.storbinary('STOR ' + remotepath, open(localpath, 'rb')) ``` 这两个方法实现了递归上传文件夹和单独上传文件的功能。`uploadDir` 方法首先判断是否为文件夹，然后遍历文件夹中的所有文件和子文件夹，并分别进行处理；`uploadFile` 方法用于上传单个文件。 ##### 3.6 文件类型判断 ```python def __filetype(self, src): if os.path.isfile(src): index = src.rfind('\\') if index == -1: index = src.rfind('/') return _XFER_FILE, src[index+1:] elif os.path.isdir(src): return _XFER_DIR, '' ``` 此方法用于判断给定路径是文件还是文件夹，并返回相应的类型。 ##### 3.7 主方法 ```python def upload(self, src): filetype, filename = self.__filetype(src) self.initEnv() if filetype == _XFER_DIR: self.srcDir = src self.uploadDir(self.srcDir) elif filetype == _XFER_FILE: self.uploadFile(src, filename) self.clearEnv() if __name__ == '__main__': srcDir = r"C:\sytst" srcFile = r'C:\sytst\sar.c' xfer = Xfer() xfer.setFtpParams('192.x.x.x', 'jenkins', 'pass') xfer.upload(srcDir) xfer.upload(srcFile) ``` 主方法 `upload` 调用了之前定义的方法来实现上传功能，最后通过示例演示了如何使用该类上传文件和文件夹。 #### 四、总结 本文介绍了一个 Python 实现 FTP 上传文件或文件夹的实例，通过定义类和方法的方式，实现了 FTP 服务器的连接、文件上传以及文件夹的递归上传等功能。这对于需要自动化上传文件或文件夹的场景非常有用。此外，还介绍了 FTP 协议的基础知识和 Python 中 `ftplib` 模块的使用方法，帮助读者更好地理解和掌握这一技能。