0

0

如何在 Jenkins 中安全启动多线程 Flask 应用避免端口占用错误

花韻仙語

花韻仙語

发布时间:2026-01-24 15:47:11

|

964人浏览过

|

来源于php中文网

原创

如何在 Jenkins 中安全启动多线程 Flask 应用避免端口占用错误

本文详解在 jenkins ci 环境中通过多线程启动 flask 测试服务时,因端口未及时释放导致 `oserror: [errno 98] address already in use` 的根本原因与可靠解决方案,涵盖端口复用预防、优雅关闭机制及线程同步实践。

在 Jenkins 流水线中以线程方式启动 Flask 应用进行集成测试(如触发 pytest 继续执行)是一种常见模式,但本地运行正常、Jenkins 报错 Address already in use 的问题极为典型。其本质并非并发冲突,而是Flask 进程未被正确终止,导致端口(如 5055 或 5005)持续处于 LISTEN 状态——Jenkins 节点通常复用工作空间和系统环境,上一次测试残留的 Python 进程可能仍未退出,netstat -tulpn | grep :5005 显示的 python3.8 进程正是罪魁祸首。

✅ 正确做法:主动关闭 + 同步等待 + 避免调试模式

原方案存在三处关键风险:

  • 使用 run_simple(..., use_debugger=True) 启用了 Werkzeug 调试器,在非交互式 CI 环境中易引发不可控行为;
  • flask_thread.daemon = True 使线程为守护线程,主线程退出时其被强制终止,stop_flask_app() 永远不会执行,端口无法释放;
  • wait_for_trigger() 仅依赖 Event.wait(),未对 Flask 服务生命周期做显式管理。

以下是经过 Jenkins 实践验证的健壮实现:

蕉点AI
蕉点AI

AI电商商品图生成平台 | 智能商品素材制作工具

下载

1. Flask 服务模块(test_server.py)

from flask import Flask, request, jsonify
import logging

app = Flask(__name__)
logging.basicConfig(
    filename='flask_thread.log',
    level=logging.INFO,
    format='%(asctime)s - %(levelname)s - %(message)s'
)

@app.route('/trigger', methods=['GET'])
def trigger_test_continue():
    logging.info("Trigger received. Signalling pytest to continue.")
    # 关键:收到触发后立即关闭服务器
    shutdown_func = request.environ.get('werkzeug.server.shutdown')
    if shutdown_func is None:
        raise RuntimeError('Not running with the Werkzeug Server')
    shutdown_func()
    logging.info("Flask server shut down gracefully.")
    return jsonify({'status': 'success', 'message': 'Continuing test execution'}), 200

def run_flask_app():
    logging.info("Starting Flask test server on 0.0.0.0:5005")
    # 禁用 reloader & debugger;使用 app.run() 更稳定
    app.run(host='0.0.0.0', port=5005, debug=False, use_reloader=False)

2. Pytest 钩子(conftest.py 或插件模块)

import threading
import time
from test_server import run_flask_app

def pytest_collection_finish(session):
    # 启动 Flask 服务线程(非守护线程,确保可被 join)
    flask_thread = threading.Thread(target=run_flask_app, name="FlaskTestServer")
    flask_thread.start()

    # 等待服务真正就绪(简单轮询,生产环境建议用 requests.head 健康检查)
    time.sleep(1.5)

    # 发起触发请求(示例:使用 requests,需安装 pip install requests)
    try:
        import requests
        response = requests.get('http://localhost:5005/trigger', timeout=5)
        if response.status_code == 200:
            logging.info("Trigger sent successfully.")
    except Exception as e:
        logging.error(f"Failed to send trigger: {e}")

    # 关键:join 确保 Flask 线程自然结束(即收到 /trigger 后 shutdown 完成)
    flask_thread.join(timeout=10)  # 最大等待 10 秒
    if flask_thread.is_alive():
        logging.warning("Flask thread did not terminate cleanly.")

⚠️ 注意事项与最佳实践

  • 禁止使用 daemon=True:守护线程无法保证资源清理,必须通过 join() 等待其自然退出。
  • 端口选择策略:Jenkins 多任务并行时建议使用动态端口(如 port=0 让系统分配),或通过环境变量注入唯一端口(PORT=${BUILD_NUMBER}5005)。
  • 超时防护:app.run() 是阻塞调用,/trigger 必须能到达;若网络隔离,改用 curl -s http://localhost:5005/trigger 在 shell 步骤中触发更可靠。
  • 日志与可观测性:启用 logging 并持久化到文件,便于排查 Jenkins 中的静默失败。
  • 替代方案考虑:对复杂场景,推荐使用轻量级异步服务器(如 hypercorn + asyncio)或专用测试工具(pytest-httpserver),避免手动管理 HTTP 生命周期。

通过以上改造,Flask 服务在 Jenkins 中将严格遵循「启动 → 等待触发 → 主动关闭 → 线程退出」流程,彻底规避端口复用错误,保障 CI 稳定性。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

773

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

684

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

765

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

699

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1405

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

570

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

751

2023.08.11

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 17.2万人学习

Django 教程
Django 教程

共28课时 | 3.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号