實戰 如何用 Python 自動化監控資料夾完成服務部署

大家好，我是彭濤！

最近在部署前端專案的時候，需要先將前端專案壓縮套件透過堡壘機上傳到應用伺服器的/tmp 目錄下，然後進入應用伺服器中，使用mv 指令將壓縮檔案移至Nginx 項目設定目錄，最後使用unzip 指令解壓縮文件，以此完成專案的部署。

仔細分析，大部分操作都是重複性的動作，人工去完成這些操作會大大降低工作效率。

本篇文章將介紹如何利用 Python 監控資料夾，以此輔助完成服務的部署動作。

1. 準備

這裡要介紹一個Python 依賴函式庫「 watchdog 」

它可用來監控某個檔案目錄下的檔案變化，包含：刪除、修改、新增等操，每個操作都會回呼一個事件函數，我們可以在內部編寫自訂的邏輯，以滿足我們的需求。

# 安装依赖包
pip3 install watchdog

專案位址：

https://www.php.cn/link/690e6de4e3e2c0916b6160d9959d156b

#2. 實戰一下

首先，我們需要建立一個監聽器，用於監聽資料夾目錄

from watchdog.observers import Observer
...
# 创建一个监听器，用来监听文件夹目录
observer = Observer()
...

然後，建立2 個事件處理物件。

PS：此物件繼承於「 FileSystemEventHandler 」類別。

它們分別用於監聽「 /tmp 」目錄、「 /home/project/frontend 」目錄，假設事件物件被命名為obj1、obj2

obj1 負責監聽/tmp 目錄，重寫入「 新建或修改」事件方法，完成壓縮檔案的移動操作:

from watchdog.events import *
import ntpath
import shutil
import zipfile
def get_filename(filepath):
 """
 根据文件夹目录，获取文件名称（待后缀）
 :param filepath:
 :return:
 """
 return ntpath.basename(filepath)
class FileMoveHandler(FileSystemEventHandler):
 def __init__(self):
 FileSystemEventHandler.__init__(self)
 ...
 # 文件新建
 def on_created(self, event):
 # 新建文件夹
 if event.is_directory:
 # print("directory created:{0}".format(event.src_path))
 pass
 # 新建文件
 else:
 # print("file created:{0}".format(event.src_path))
 filename = get_filename(event.src_path)
 # 如果属于前端的4个项目压缩包，开始文件夹的操作
 if filename in watch_tags:
 self.start(filename)
...
def on_modified(self, event):
 if event.is_directory:
 # print("directory modified:{0}".format(event.src_path))
 pass
 else:
 # print("file modified:{0}".format(event.src_path))
 filename = get_filename(event.src_path)
 if filename in watch_tags:
 self.start(filename)
 ...
 def start(self, filename):
 """
 文件处理逻辑
 :param filename:
 :return:
 """
 try:
 # 文件名不带后缀
 filename_without_suffix = filename.split(".")[0]
 # 源文件路径（压缩包文件）
 source_file_path = watch_folder + filename
 # 目标文件路径（压缩包文件）
 target_file_path = target_folder + filename
 # 目标项目文件夹（目标项目）
 target_project_path = target_folder + filename_without_suffix
 # 1、复制文件到目标文件夹
 print(f"拷贝源目录{source_file_path},目标文件夹:{target_folder}")
 # 删除目标文件夹下的压缩文件
 if os.path.exists(target_file_path):
 os.remove(target_file_path)
 # 移动文件到目标文件夹中
 shutil.move(source_file_path, target_folder)
 # 2、清空目标文件夹中内的所有文件夹（如果存在）
 # 如果不存在，新建一个文件夹
 if os.path.exists(target_project_path):
 shutil.rmtree(target_project_path, ignore_errors=True)
 print(f"项目{filename_without_suffix}移动成功！")
 except Exception as e:
 print("部署失败，错误原因:", str(e.args))

obj2 負責監聽/home/project/frontend 目錄，同樣重寫「 新建或修改」事件方法，完成壓縮檔案的解壓動作：

...
 def start(self, filename):
 # 文件名不带后缀
 filename_without_suffix = filename.split(".")[0]
 # 目标文件路径（压缩包文件）
 target_file_path = target_folder + filename
 # 目标项目文件夹（目标项目）
 target_project_path = target_folder + filename_without_suffix
 r = zipfile.is_zipfile(target_file_path)
 if r:
 fz = zipfile.ZipFile(target_file_path, 'r')
 for file in fz.namelist():
 fz.extract(file, target_folder)
 else:
 print('这不是一个正常的zip压缩包！')
...

接著，透過監聽器啟動上面兩個事件的監聽任務

import time
...
if __name__ == "__main__":
 # 待监听的文件夹目录
 watch_folder = "/tmp/"
 # 项目目标文件夹目录
 target_folder = "/home/project/frontend/"
 # 监听文件夹名称，即：项目压缩包名称
 watch_tags = ['proj1.zip', 'proj2.zip', 'proj3.zip', 'proj4.zip']
 # 创建一个监听器，用来监听文件夹目录
 observer = Observer()
 # 创建两个事件处理对象
 move_handler = FileMoveHandler()
 unzip_handler = FileUnzipHandler()
 # 启动监控任务
 # 参数分别是：观察者、监听目录、是否监听子目录
 observer.schedule(move_handler, watch_folder, True)
 observer.schedule(unzip_handler, target_folder, True)
 observer.start()
 try:
 while True:
 time.sleep(1)
 except KeyboardInterrupt:
 observer.stop()
 observer.join()
...

最後，我們在伺服器上透過「 nohup 」指令，讓檔案監聽程式在背景執行即可

# 在后台运行
# 项目文件：watch_folder.py
# 日志文件：watch_folder.log
nohup python3 -u watch_folder.py > watch_folder.log 2>&1 &
# 查看日志：
cat watch_folder.log

3. 總結

透過上面的操作，每次我透過堡壘機將前端zip 壓縮專案檔案上傳到應用伺服器的/tmp 目錄下，程式會自動進行後面的操作，自動完成應用部署。

以上是實戰 如何用 Python 自動化監控資料夾完成服務部署的詳細內容。更多資訊請關注PHP中文網其他相關文章！