• PySimpleGUI小试牛刀之Tomcat项目部署工具

    之前写过一篇 python 自动化部署项目，实现了Tomcat项目的初级自动化部署功能，但是它有一个不足，只支持单个项目部署，也就是说，项目被高度定制化了，所有的配置信息都被固化在了程序里，无法扩展。所以今天，我们给它来个小小的升级，让这个工具以界面图形化的方式运行，在这个界面上，支持对要部署的Tomcat项目进行管理。该工具主要解决以下问题（痛点）：

    系统作了负载均衡处理，项目被分开存放在了多个不同的机器上，同时每个机器上也有多个项目，每次部署的时候，都需要工程师们手动在不同的目录之间来回切换，手动复制、粘贴、备份系统，手动删除缓存文件，手动启停web服务，步骤繁琐且容易出错。此时，如果能有一款工具，能够帮助我们自动化完成这些操作，解放工程师们的双手，应该算是大功一件了！

    so，先来张效果图，让我们直观感受下。

     下面正式开始！

    1. 安装pysimplegui

    pip install pysimplegui

     2. 编写核心代码

    1. import os
    2. import json
    3. import time
    4. import shutil
    5. import threading
    6. import webbrowser
    7. from gui_helper import GuiHelper
    8. from auto_release import AutoRelease
    9. from PIL import Image as pil_image
    10. import PySimpleGUI as sg
    11.  
    12. class ProjectDeploy():
    13.  
    14.     # 配置文件
    15.     project_file = 'project.json'
    16.     
    17.     left_layout_key = 'left_layout'
    18.     
    19.     right_layout_key = 'right_layout'
    20.     
    21.     default_right_layout_key = 'default_right_layout'
    22.     
    23.     background_image = 'background_image.png'
    24.  
    25.     # 窗口元素的背景色
    26.     element_background_color = '#FCFCFC'
    27.     
    28.     def run(self):
    29.         self.load_win()
    30.     
    31.     '''
    32.     加载窗口
    33.     '''
    34.     def load_win(self, old_window=None):
    35.         # 获取屏幕宽高
    36.         (width, height) = GuiHelper.get_window_size()
    37.         win_height = int(height)
    38.         left_win_width = 150
    39.         right_win_width = width - left_win_width
    40.         
    41.         default_right_column_layout = [
    42.             GuiHelper.text_input('点击左侧按钮，新建一个项目'),
    43.         ]
    44.         image = pil_image.open(self.background_image)
    45.         src_image_size = image.size
    46.         background_image_size = (min(src_image_size[0], int(right_win_width*0.7)), min(src_image_size[1], int(win_height*0.7)))
    47.         default_right_column_layout.append([sg.Image(filename=self.background_image, size=background_image_size)])
    48.         
    49.         left_columns = [
    50.             sg.Column(self.load_left(), key=self.left_layout_key, size=(left_win_width, win_height), background_color=self.element_background_color)
    51.         ]
    52.         right_columns = [
    53.             sg.Column(default_right_column_layout, key=self.default_right_layout_key, size=(right_win_width, win_height), background_color=self.element_background_color),
    54.             sg.Column(self.load_right(), key=self.right_layout_key, visible=False, size=(right_win_width, win_height), background_color=self.element_background_color, scrollable=True, vertical_scroll_only=True)
    55.         ]
    56.         left_frame = sg.Frame('', [left_columns], background_color=self.element_background_color, border_width=1)
    57.         right_frame = sg.Frame('', [right_columns], background_color=self.element_background_color, border_width=0)
    58.         
    59.         layout = [[
    60.             sg.Column([[left_frame]], pad=(0,0), background_color=self.element_background_color),
    61.             sg.Column([[right_frame]], pad=(30,0), background_color=self.element_background_color)
    62.         ]]
    63.         if old_window is not None:
    64.             old_window.close()
    65.         window = GuiHelper.create_window('Tomcat项目部署工具', layout = layout)
    66.         event_list = self.load_events()
    67.         if event_list is not None:
    68.             for event_item in event_list:
    69.                 window[event_item[0]].set_cursor(cursor='hand2')
    70.         GuiHelper.listen_window(window, event_list)
    71.         GuiHelper.close_window(window)
    72.       
    73.     '''
    74.     加载左侧布局
    75.     '''
    76.     def load_left(self):
    77.         left_column_layout = [
    78.             [GuiHelper.button('主页', None, True, 10)],
    79.             [GuiHelper.button('新增项目', '#337AB7', True, 10)],
    80.         ]
    81.         project_list = self.get_project_list()
    82.         project_names = list(project_list.keys())
    83.         for index, name in enumerate(project_names):
    84.             left_column_layout.append(GuiHelper.text_input('{}. {}'.format(index+1, name)))
    85.         return left_column_layout
    86.     
    87.     '''
    88.     加载右侧布局
    89.     '''
    90.     def load_right(self):
    91.         button_layout = [
    92.             sg.Column([[]], size=(150, 30), background_color=self.element_background_color),
    93.             sg.Column([[
    94.                 GuiHelper.button('保存'),
    95.                 GuiHelper.button('删除', '#FF5722', False),
    96.                 GuiHelper.button('开始部署', '#337AB7', False, 10),
    97.             ]], key='btn_group', justification='left', pad=(0, 30), background_color=self.element_background_color)
    98.         ]
    99.         right_column_layout = [
    100.             GuiHelper.text_input('请输入基本信息'),
    101.             GuiHelper.text_input('项目标记', 'project_name'),
    102.             GuiHelper.text_input('Tomcat服务名称', 'service_name'),
    103.             GuiHelper.text_input('Tomcat服务端口', 'service_port'),
    104.             GuiHelper.text_input('Tomcat工作目录', 'work_dir', None, None, 'folder'),
    105.             GuiHelper.text_input('Tomcat缓存目录', 'cache_dir', None, None, 'folder'),
    106.             GuiHelper.text_input('war包文件', 'war_file_name', None, None, 'files'),
    107.             GuiHelper.text_input('备份目录', 'backup_dir', None, None, 'folder'),
    108.             GuiHelper.text_input('应用访问URL', 'url'),
    109.             button_layout,
    110.             GuiHelper.text_output('process_info', 5, 60, False),
    111.         ]
    112.         return right_column_layout
    113.     
    114.     '''
    115.     切换右侧布局
    116.     @show_right_layout True 显示主布局，False 显示默认布局
    117.     '''
    118.     def swap_right_layout(self, window, show_right_layout=True):
    119.         show_default_right_layout_key = False
    120.         if not show_right_layout:
    121.             show_default_right_layout_key = True
    122.         window[self.default_right_layout_key].update(visible=show_default_right_layout_key)
    123.         window[self.right_layout_key].update(visible=show_right_layout)
    124.     
    125.     '''
    126.     事件列表
    127.     '''
    128.     def load_events(self):
    129.         event_list = [
    130.             ('主页', self.home),
    131.             ('新增项目', self.add),
    132.             ('删除', self.delete),
    133.             ('保存', self.save),
    134.             ('开始部署', self.deploy)
    135.         ]
    136.         project_list = self.get_project_list()
    137.         project_names = list(project_list.keys())
    138.         for index, name in enumerate(project_names):
    139.             event_list.append(('{}. {}'.format(index+1, name), self.show_detail))
    140.         return event_list
    141.     
    142.     '''
    143.     获取项目名称列表
    144.     '''
    145.     def get_project_list(self):
    146.         result = self.read_txt(self.project_file)
    147.         if result is None:
    148.             result = "{}"
    149.         project_list = json.loads(result)
    150.         return project_list
    151.     
    152.     '''
    153.     返回主页
    154.     '''
    155.     def home(self, values, window, event):
    156.         self.swap_right_layout(window, False)
    157.     
    158.     '''
    159.     新增项目
    160.     '''
    161.     def add(self, values, window, event):
    162.         self.swap_right_layout(window)
    163.         for key in values.keys():
    164.             # 以_c结尾表示该控件为文件选择按钮
    165.             if key.endswith('_c'):
    166.                 window[key].update("选择...")
    167.             else:
    168.                 window[key].update("")
    169.         window['保存'].update(visible=True)
    170.         window['删除'].update(visible=False)
    171.         window['开始部署'].update(visible=False)
    172.         window['btn_group'].update(visible=True)
    173.         window['process_info_col'].hide_row()
    174.  
    175.     '''
    176.     查看项目信息
    177.     '''
    178.     def show_detail(self, values, window, event):
    179.         project_list = self.get_project_list()
    180.         project_names = list(project_list.keys())
    181.         for index, name in enumerate(project_names):
    182.             if event == '{}. {}'.format(index+1, name):
    183.                 self.update_right_text(project_list[name], window)
    184.         window['保存'].update(visible=False)
    185.         window['process_info_col'].hide_row()
    186.         window['删除'].update(visible=True)
    187.         window['开始部署'].update(visible=True)
    188.         window['btn_group'].update(visible=True)
    189.  
    190.     '''
    191.     更新元素内容
    192.     '''           
    193.     def update_right_text(self, values, window):
    194.         self.swap_right_layout(window)
    195.         keys = list(values.keys())
    196.         for key in keys:
    197.             # 以_c结尾表示该控件为文件选择按钮
    198.             if key.endswith('_c'):
    199.                 window[key].update("选择...")
    200.             else:
    201.                 window[key].update(values[key])
    202.     
    203.     '''
    204.     保存项目信息
    205.     '''
    206.     def save(self, values, window, event):
    207.         if not self.verify(values):
    208.             return False
    209.         if(not GuiHelper.confirm('确定保存吗')):
    210.             return False
    211.         result = self.read_txt(self.project_file)
    212.         if result is None:
    213.             result = "{}"
    214.         result = json.loads(result)
    215.         if values['project_name'] in result:
    216.             GuiHelper.alert('该项目标记已存在')
    217.             return False
    218.         result[values['project_name']] = values
    219.         project.write_txt('project.json', json.dumps(result, ensure_ascii=False))
    220.         GuiHelper.alert('保存成功')
    221.         self.load_win(window)
    222.         return True
    223.     
    224.     '''
    225.     删除项目
    226.     '''
    227.     def delete(self, values, window, event):
    228.         if(not GuiHelper.confirm('确定删除吗')):
    229.             return False
    230.         result = self.read_txt(self.project_file)
    231.         if result is None:
    232.             result = "{}"
    233.         result = json.loads(result)
    234.         if values['project_name'] in result:
    235.             del result[values['project_name']]
    236.         project.write_txt('project.json', json.dumps(result, ensure_ascii=False))
    237.         GuiHelper.alert('删除成功')
    238.         self.load_win(window)
    239.         return True
    240.  
    241.     '''
    242.     开始部署
    243.     '''
    244.     def deploy(self, values, window, event):
    245.         if not self.verify(values):
    246.             return False
    247.         if(not GuiHelper.confirm('确定开始部署吗')):
    248.             return False
    249.         window['删除'].update(visible=False)
    250.         window['开始部署'].update(visible=False)
    251.         window['btn_group'].update(visible=False)
    252.         window['process_info'].update(visible=True)
    253.         window['process_info_col'].update(visible=True)
    254.         window['process_info_col'].unhide_row()
    255.         threading.Thread(target=self._deploy, args=(values, window,), daemon=True).start()
    256.  
    257.  
    258.     def _deploy(self, values, window):
    259.         # 应用端口号
    260.         port = values['service_port']
    261.         # 服务名称
    262.         service_name = values['service_name']
    263.         # war包文件列表，多个文件用英文封号隔开
    264.         war_file_names = values['war_file_name']
    265.         # 项目所在目录
    266.         work_dir = values['work_dir']
    267.         # 备份根目录
    268.         backup_dir = values['backup_dir']
    269.         # 缓存目录
    270.         cache_dir = values['cache_dir']
    271.         # 检测url
    272.         url = values['url']
    273.         
    274.         try:
    275.             start_time = int(time.time())
    276.             war_file_list = war_file_names.split(';');
    277.  
    278.             # 停止服务
    279.             hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    280.             GuiHelper.print_info(window, "{}【1/5】正在停止服务 {}，请稍候...".format(hour_time, service_name))
    281.             AutoRelease.stop_service(service_name)
    282.             during_time_stop = 0;
    283.             while True:
    284.                 pid = AutoRelease.get_pid(port)
    285.                 if pid == "" or pid == "0":
    286.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    287.                     GuiHelper.print_info(window, "{}【1/5】服务 {} 已停止".format(hour_time, service_name))
    288.                     break
    289.                 time.sleep(1)
    290.                 during_time_stop += 1
    291.                 if during_time_stop == 60:
    292.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    293.                     GuiHelper.print_info(window, "{}【1/5】服务 {} 停止超时，请手动停止".format(hour_time, service_name))
    294.                     window.refresh()
    295.                     break
    296.  
    297.             # 备份原文件
    298.             for index, war_file in enumerate(war_file_list):
    299.                 if not os.path.isfile(war_file):
    300.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    301.                     GuiHelper.print_info(window, "{}【2/5】当前目录未找到文件 {}".format(hour_time, war_file))
    302.                     continue
    303.                 # 分离路径和文件名
    304.                 (src_file_path, src_file_name) = os.path.split(war_file)
    305.                 # 分离文件名和后缀
    306.                 (base_file_name, file_suffix) = os.path.splitext(src_file_name)
    307.                 hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    308.                 GuiHelper.print_info(window, "{}【2/5】正在备份原文件 {}，请稍候...".format(hour_time, base_file_name))
    309.                 zip_file_name = base_file_name+'.zip'
    310.  
    311.                 date_str = time.strftime('%Y%m%d', time.localtime(time.time()))
    312.                 project_dir = work_dir+"/"+base_file_name
    313.                 out_zip_dir = "{}/{}".format(backup_dir, date_str)
    314.                 if not os.path.exists(out_zip_dir):
    315.                     os.makedirs(out_zip_dir)
    316.  
    317.                 if AutoRelease.archive_file(out_zip_dir+"/"+zip_file_name, project_dir) :
    318.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    319.                     GuiHelper.print_info(window, "{}【2/5】文件 {} 备份完成，路径：{}".format(hour_time, base_file_name, out_zip_dir+"/"+zip_file_name))
    320.  
    321.             # 部署新文件
    322.             for index, war_file in enumerate(war_file_list):
    323.                 if not os.path.isfile(war_file):
    324.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    325.                     GuiHelper.print_info(window, "{}【3/5】当前目录未找到文件 {}".format(hour_time, war_file))
    326.                     continue
    327.                 # 分离路径和文件名
    328.                 (src_file_path, src_file_name) = os.path.split(war_file)
    329.                 # 分离文件名和后缀
    330.                 (base_file_name, file_suffix) = os.path.splitext(src_file_name)
    331.                 hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    332.                 GuiHelper.print_info(window, "{}【3/5】部署新文件 {}，请稍候...".format(hour_time, src_file_name))
    333.  
    334.                 date_str = time.strftime('%Y%m%d', time.localtime(time.time()))
    335.                 project_dir = work_dir+"/"+base_file_name
    336.                 out_zip_dir = "{}/{}".format(backup_dir, date_str)
    337.                 AutoRelease.copy_file(war_file, out_zip_dir)
    338.                 if os.path.isfile(work_dir+"/"+src_file_name):
    339.                     os.remove(work_dir+"/"+src_file_name)
    340.                 if os.path.exists(project_dir):
    341.                     shutil.rmtree(project_dir, True)
    342.                 if os.path.exists(cache_dir):
    343.                     shutil.rmtree(cache_dir, True)
    344.                 AutoRelease.copy_file(war_file, work_dir)
    345.                 hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    346.                 GuiHelper.print_info(window, "{}【3/5】新文件 {} 部署完成".format(hour_time, src_file_name))
    347.  
    348.             # 启动服务
    349.             hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    350.             GuiHelper.print_info(window, "{}【4/5】正在启动服务 {}，请稍候...".format(hour_time, service_name))
    351.             AutoRelease.start_service(service_name)
    352.             during_time_start = 0
    353.             while True:
    354.                 if AutoRelease.get_pid(port) != "":
    355.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    356.                     GuiHelper.print_info(window, "{}【4/5】服务 {} 已启动".format(hour_time, service_name))
    357.                     break
    358.                 time.sleep(1)
    359.                 during_time_start += 1
    360.                 if during_time_start == 60:
    361.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    362.                     GuiHelper.print_info(window, "{}【4/5】服务 {} 启动超时，请手动启动".format(hour_time, service_name))
    363.                     break
    364.  
    365.             # 检查应用
    366.             hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    367.             GuiHelper.print_info(window, "{}【5/5】正在检测应用是否可以正常访问，请稍候...".format(hour_time))
    368.             during_time_access = 0
    369.             while True:
    370.                 if AutoRelease.get_http_status(url):
    371.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    372.                     GuiHelper.print_info(window, "{}【5/5】应用已可以正常访问".format(hour_time))
    373.                     break
    374.                 time.sleep(5)
    375.                 during_time_access += 5
    376.                 if during_time_access == 60:
    377.                     hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    378.                     GuiHelper.print_info(window, "{}【5/5】应用访问超时".format(hour_time))
    379.                     break
    380.         except Exception as e:
    381.             hour_time = time.strftime('%H:%M:%S', time.localtime(time.time()))
    382.             GuiHelper.print_info(window, "{}部署异常：{}".format(hour_time, str(e)))
    383.         else:
    384.             GuiHelper.print_info(window, "{0}，用时 {1} 秒".format("部署完毕", int(time.time()) - start_time))
    385.             webbrowser.open(url)
    386.             window['删除'].update(visible=True)
    387.             window['开始部署'].update(visible=True)
    388.             window['btn_group'].update(visible=True)
    389.         
    390.     def verify(self, values):
    391.         keys = {
    392.             'project_name': '项目标记名称不能为空',
    393.             'service_name': '服务名称不能为空',
    394.             'service_port': '端口号不能为空',
    395.             'work_dir': '请选择工作目录',
    396.             'cache_dir': '请选择缓存目录',
    397.             'war_file_name': '请选择war包文件',
    398.             'backup_dir': '请选择项目备份目录',
    399.             'url': '访问URL不能为空',
    400.         }
    401.         for key, text in keys.items():
    402.             if GuiHelper.is_empty(values, key):
    403.                 GuiHelper.alert(text)
    404.                 return False
    405.         return True
    406.     
    407.     def read_txt(self, file, encoding="utf-8"):
    408.         if not os.path.isfile(file):
    409.             return None
    410.         with open(file, "r", encoding=encoding) as f:
    411.             result = f.read()
    412.         return result.rstrip()
    413.     
    414.     def write_txt(self, file, content, overwrite=True, encoding="utf-8"):
    415.         model = "w+" if overwrite else "a+"
    416.         with open(file, model, encoding=encoding) as f:
    417.             f.write(content)
    418.         
    419.     
    420. if __name__ == "__main__":
    421.     project = ProjectDeploy()
    422.     project.run()

    3. 打包运行

     工具虽然以界面方式运行，但是部分操作需要与命令行窗口进行交互，所以打包的时候请不要添加 -w 参数，否则会报 “句柄无效” 错误，直接用如下命令打包即可。

    pyinstaller -F project_deploy.py

    最终的成品如下：

     

  • 相关阅读:
    nginx（2）
    【毕业设计】基于javaEE+SSH+MySql+MVC的动漫论坛设计与实现（毕业论文+程序源码）——动漫论坛
    Spring Boot文档阅读笔记-3 Ways to Add Custom Header in Spring SOAP Request
    Java并发(二十一)----wait notify介绍
    leetcode top100(10) 和为 K 的子数组
    ActiveMQ window安装、修改密码、启动一闪而过、设置8161端口仅本地访问
    进程通信(2) ----- 信号
    可选的优化器：Adam、SGD、Adagrad、RMSprop、Sparse Adam
    宝塔面板快速搭建贪吃蛇小游戏web网站 - 无需云服务器，网站发布上线
    电脑重装系统后鼠标动不了该怎么解决
  • 原文地址：https://blog.csdn.net/tdcqfyl/article/details/126099477