Files
AutoDeployYun/README.md
2026-10-30 11:07:49 +08:00

6.2 KiB
Raw Blame History

AutoDeploy 自动部署工作台

Windows 桌面工具,通过 SSH/SFTP 将 Java 前后端分离项目的 ROOT.war 和 dist 发布到 Linux 服务器,并可安全更新 HTTPS 证书或单独重启 Nginx。深色界面,支持多套服务器与项目配置、实时日志、历史记录及回滚。

直接使用

打开 dist/AutoDeploy/AutoDeploy.exe。分发时复制整个 AutoDeploy 文件夹,不能只复制 EXE。也可解压交付的 ZIP 后运行。目标电脑无需安装 Python。

  1. 点击「添加服务器」,填写服务器地址、SSH 端口、账号和密码。
  2. 在「部署路径」中确认前端目录、WAR 文件、Tomcat 实例、停启脚本、临时目录及备份目录。
  3. 点击「测试连接」。测试验证 SSH 认证和远端 Python;部署时另行检查路径、权限及磁盘空间。
  4. 选择本地 WAR、dist 文件夹或 ZIP,选择前端、后端或一起发布。
  5. 点击「开始部署」,查看进度与实时日志。
  6. 在「历史与回滚」中选择记录,点击「恢复此备份」恢复到这次操作之前的文件。已被清理的备份会在执行前报告不存在。

在“编辑配置 → Nginx 设置”中填写服务器证书和私钥文件名。证书目录默认 /home/ssl,文件名必须与现有 Nginx 配置一致。随后进入独立的“Nginx 管理”标签页,选择本地证书及私钥后可执行“上传证书并重启”,也可以不选择文件直接执行“仅重启 Nginx”。

默认目标:前端 /home/dist,后端 /usr/local/tomcat/webapps/ROOT.war。前端目标目录直接包含 index.html;ZIP 可包含顶层 dist 文件夹。应用发布不会修改 Nginx;证书操作仅替换指定的证书和私钥,不修改 Nginx 配置文件。

服务器运行条件

  • Linux、SSH/SFTP、Python 3.6+;工具不在服务器上安装常驻服务。
  • 登录账号需要能够写入目标、临时、备份目录及 Tomcat 实例的锁文件,并有权停止/启动目标进程。不自动调用 sudo。
  • Nginx 功能要求服务器安装 openssl、systemctl,登录账号能够写入 /home/ssl、执行 nginx -t 和重启配置的 Nginx 服务;同样不自动调用 sudo。
  • Tomcat 使用标准 Bootstrap 进程和 -Dcatalina.base=配置路径,默认调用 shutdown.sh / startup.sh。先正常停止,超时后仅对核对过的目标 PID 发送 TERM / KILL。
  • 如果由 systemd 托管,请填写实际服务名,例如 tomcat.service。此时通过 systemctl 停启,停止失败就中止操作。
  • SSH 的非交互环境可能不包含 Java 环境变量,可在「运行设置」填写 JAVA_HOME。
  • 部署目标及其父目录使用真实目录,不接受软链接。若使用 Tomcat 软链接,请填写真实路径,并与进程的 catalina.base 完全对应。
  • 可选填写文件属主(例如 tomcat:tomcat),该选项需要 root;不填写则保留复制文件的属主,新上传文件使用 SSH 账号的属主。
  • HTTP 健康检查在服务器上发起,配置后要求响应为 2xx。留空时仅确认目标 Tomcat 进程连续运行 5 秒,不代表业务接口一定正常。

发布与恢复

先检查并上传、校验 SHA-256,之后停止 Tomcat、备份当前文件、移除旧 ROOT 解压目录并替换 WAR、替换 dist、启动并验证。仅发布前端时不停止 Tomcat。前端文件以整目录替换,不保留旧构建文件。

每次备份有独立清单,包含本次发布范围内的旧文件和“原文件不存在”的状态。按前端及 WAR 目标组合分组;每次成功后保留最近 2 次完整备份。失败时不清理备份,所以连续失败可能临时超过 2 次。手动回滚也会先备份当前版本,成功后同样保留 2 次。

自动恢复默认开启:替换或启动验证失败时恢复部署前文件,原本运行的 Tomcat 会尝试重新启动。若恢复也失败,会在日志中明确报告并留下备份路径。对于连接中断,远端结果可能未知,请重新连接检查服务和备份,勿仅根据本地报错判断服务器版本。

更新证书时先使用 OpenSSL 检查证书、有效期及公私钥匹配,再备份旧证书并原子替换。nginx -t 或重启失败时自动恢复旧证书;单独重启 Nginx 时也会先检查配置。证书和私钥目标不接受软链接,私钥权限设置为 0600,证书权限设置为 0644。

停止成功之后才做备份,保证旧应用目录的一致性,因此停机时间包含备份时间。路径锁防止同一目标或 Tomcat 实例被多个发布任务同时修改。

回滚仅覆盖部署文件,不回滚数据库。dist 与 webapps/ROOT 都按应用构建目录整体替换;上传文件、业务数据或独立配置应存放在这些目录之外。

本地数据

数据存放在 %LOCALAPPDATA%\AutoDeploy:

  • config.db:多套服务器配置、直接保存的账号密码、发布历史;不使用 Windows 凭据管理器。
  • known_hosts:首次连接记住 SSH 主机公钥,再次连接时校验;公钥变化将拒绝连接。
  • logs/:运行日志,密码会被隐藏,历史配置不重复保存密码。

同一服务器的不同项目可以分别新增配置。启动时不填充演示服务器,也不会自动连接或发布。可以通过 AUTODEPLOY_DATA 环境变量指定独立的数据目录。

源码运行与构建

python -m pip install -r requirements.txt
python main.py
python -m pip install pyinstaller==6.13.0
python tools/make_icon.py
powershell -ExecutionPolicy Bypass -File build.ps1

源码分工:ui.py 界面、store.py 配置与历史、engine.py SSH/上传工作线程、remote.py Linux 部署执行器。远端执行器作为源文件随 EXE 一起打包,无需在服务器安装 Paramiko 或 PySide6。

验证

python -m unittest discover -s tests -v
python main.py --screenshot

测试覆盖路径校验、压缩包校验、目录替换、备份与恢复、失败恢复、锁冲突、备份保留数量、SQLite 多配置,以及本机真实 SSH 密码认证。文件事务测试使用临时目录,Tomcat 停启及 Linux flock 由测试替身模拟;不等于已经在阿里云和真实 Tomcat 上验收。