实战 | 如何用 Python 自动化监控文件夹完成服务部署！

大家好，我是安果！

最近在部署前端项目的时候，需要先将前端项目压缩包通过堡垒机上传到应用服务器的 /tmp 目录下，然后进入应用服务器中，使用 mv 命令将压缩文件移动到 Nginx 项目设定目录，最后使用 unzip 命令解压文件，以此完成项目的部署

仔细分析，大部分操作都是重复性的动作，人工去完成这些操作会大大降低工作效率

本篇文章将介绍如何利用 Python 监控文件夹，以此辅助完成服务的部署动作

1. 准备

这里要介绍一个 Python 依赖库「 watchdog 」

它可用于监控某个文件目录下的文件变化，包含：删除、修改、新增等操，每一个操作都会回调一个事件函数，我们可以在内部编写自定义的逻辑，以此满足我们的需求

  1. # 安装依赖包
  2. pip3 install watchdog

项目地址：

https://pypi.org/project/watchdog/

2. 实战一下

首先，我们需要创建一个监听器，用于监听文件夹目录

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

然后，创建 2 个事件处理对象

PS：该对象继承于「 FileSystemEventHandler 」类

它们分别用于监听「 /tmp 」目录、「 /home/project/frontend 」目录，假设事件对象被命名为 obj1、obj2

obj1 负责监听 /tmp 目录，重写「 新建或修改 」事件方法，完成压缩文件的移动操作

  1. from watchdog.events import *
  2. import ntpath
  3. import shutil
  4. import zipfile
  5.  
  6. def get_filename(filepath):
  7.     """
  8.     根据文件夹目录，获取文件名称（待后缀）
  9.     :param filepath:
  10.     :return:
  11.     """
  12.     return ntpath.basename(filepath)
  13.  
  14. class FileMoveHandler(FileSystemEventHandler):
  15.     def __init__(self):
  16.         FileSystemEventHandler.__init__(self)
  17.  
  18.     ...
  19.  
  20.     # 文件新建
  21.     def on_created(self, event):
  22.         # 新建文件夹
  23.         if event.is_directory:
  24.             # print("directory created:{0}".format(event.src_path))
  25.             pass
  26.         # 新建文件
  27.         else:
  28.             # print("file created:{0}".format(event.src_path))
  29.             filename = get_filename(event.src_path)
  30.  
  31.             # 如果属于前端的4个项目压缩包，开始文件夹的操作
  32.             if filename in watch_tags:
  33.                 self.start(filename)
  34.    ...
  35.    def on_modified(self, event):
  36.         if event.is_directory:
  37.             # print("directory modified:{0}".format(event.src_path))
  38.             pass
  39.         else:
  40.             # print("file modified:{0}".format(event.src_path))
  41.             filename = get_filename(event.src_path)
  42.             if filename in watch_tags:
  43.                 self.start(filename)
  44.     ...
  45.         def start(self, filename):
  46.         """
  47.         文件处理逻辑
  48.         :param filename:
  49.         :return:
  50.         """
  51.         try:
  52.             # 文件名不带后缀
  53.             filename_without_suffix = filename.split(".")[0]
  54.  
  55.             # 源文件路径（压缩包文件）
  56.             source_file_path = watch_folder + filename
  57.  
  58.             # 目标文件路径（压缩包文件）
  59.             target_file_path = target_folder + filename
  60.  
  61.             # 目标项目文件夹（目标项目）
  62.             target_project_path = target_folder + filename_without_suffix
  63.  
  64.             # 1、复制文件到目标文件夹
  65.             print(f"拷贝源目录{source_file_path},目标文件夹:{target_folder}")
  66.             # 删除目标文件夹下的压缩文件
  67.             if os.path.exists(target_file_path):
  68.                 os.remove(target_file_path)
  69.             # 移动文件到目标文件夹中
  70.             shutil.move(source_file_path, target_folder)
  71.  
  72.             # 2、清空目标文件夹中内的所有文件夹（如果存在）
  73.             # 如果不存在，新建一个文件夹
  74.             if os.path.exists(target_project_path):
  75.                 shutil.rmtree(target_project_path, ignore_errors=True)
  76.  
  77.             print(f"项目{filename_without_suffix}移动成功！")
  78.         except Exception as e:
  79.             print("部署失败，错误原因:", str(e.args))





obj2 负责监听 /home/project/frontend 目录，同样重写「 新建或修改 」事件方法，完成压缩文件的解压动作

  1. ...
  2.     def start(self, filename):
  3.         # 文件名不带后缀
  4.         filename_without_suffix = filename.split(".")[0]
  5.         # 目标文件路径（压缩包文件）
  6.         target_file_path = target_folder + filename
  7.  
  8.         # 目标项目文件夹（目标项目）
  9.         target_project_path = target_folder + filename_without_suffix
  10.         r = zipfile.is_zipfile(target_file_path)
  11.         if r:
  12.             fz = zipfile.ZipFile(target_file_path, 'r')
  13.             for file in fz.namelist():
  14.                 fz.extract(file, target_folder)
  15.         else:
  16.             print('这不是一个正常的zip压缩包！')
  17. ...

接着，通过监听器启动上面两个事件的监听任务

  1. import time
  2. ...
  3. if __name__ == "__main__":
  4.     # 待监听的文件夹目录
  5.     watch_folder = "/tmp/"
  6.  
  7.     # 项目目标文件夹目录
  8.     target_folder = "/home/project/frontend/"
  9.  
  10.     # 监听文件夹名称，即：项目压缩包名称
  11.     watch_tags = ['proj1.zip', 'proj2.zip', 'proj3.zip', 'proj4.zip']
  12.  
  13.     # 创建一个监听器，用来监听文件夹目录
  14.     observer = Observer()
  15.  
  16.     # 创建两个事件处理对象
  17.     move_handler = FileMoveHandler()
  18.     unzip_handler = FileUnzipHandler()
  19.  
  20.     # 启动监控任务
  21.     # 参数分别是：观察者、监听目录、是否监听子目录
  22.     observer.schedule(move_handler, watch_folder, True)
  23.     observer.schedule(unzip_handler, target_folder, True)
  24.     observer.start()
  25.     try:
  26.         while True:
  27.             time.sleep(1)
  28.     except KeyboardInterrupt:
  29.         observer.stop()
  30.     observer.join()
  31. ...

最后，我们在服务器上通过「 nohup 」命令，让文件监听程序在后台运行即可

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

3. 总结

通过上面的操作，每次我通过堡垒机将前端 zip 压缩项目文件上传到应用服务器的 /tmp 目录下，程序会自动进行后面的操作，自动完成应用部署


作者：星安果


欢迎关注微信公众号 ：AirPython