windows上部署flask程序

文章目录

前言
一、准备工作
二、配置 Gunicorn 或 uWSGI
- 1.安装 Waitress
- 2.修改启动文件来使用 Waitress 启动 Flask 应用
- 3.配置反向代理（可选）
- 4.启动程序访问
三.Flask 程序在 Windows 启动时自动启动
- 1.使用 nssm（Non-Sucking Service Manager）
- 2. Windows 任务计划程序（Task Scheduler）
- 3.注册表（Registry）方法
- 4.使用 Python 的 win32service 模块
注意

前言

一般来说我们的程序在服务器首选Linux系统去部署，但是难免会在一些特定情况中需要在Windows环境部署，所以下面我们就介绍一下如何在Windows上部署一个flask程序

一、准备工作

安装 Python 和 Flask
安装 Flask：打开命令行工具（CMD 或 PowerShell），然后运行以下命令安装 Flask
pip install flask
创建 Flask 应用（我本地写了一个简单的，但是文件比较多，下面就列举一个最简单的flask程序，可以参考博客）

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello():
    return "Hello, World!"

if __name__ == '__main__':
    app.run(debug=True)

二、配置 Gunicorn 或 uWSGI

常见的 WSGI 服务器：
Gunicorn：一个流行的 WSGI 服务器，适用于 UNIX 系统
uWSGI：支持多种协议的高性能 WSGI 服务器，适用于 UNIX 和 Windows 系统
Waitress：一个简单且高效的 WSGI 服务器，适用于 Windows 系统
这里我们使用Waitress来部署我们的flask程序

1.安装 Waitress

一般我们项目里面都会有一个requirements.txt的文件，我们可以把需要的依赖项都写在这个文件里面然后执行pip install -r .\requirements.txt
或者也可以直接安装pip install waitress

2.修改启动文件来使用 Waitress 启动 Flask 应用

from waitress import serve
from app import create_app
import logging

app = create_app()

if __name__ == '__main__':
    # app.run(debug=True)
    #这里加个logging方便看启动程序返回
    logging.basicConfig(level=logging.DEBUG)
    serve(app, host='0.0.0.0', port=8089)

3.配置反向代理（可选）

一般来说我们都是选择Nginx或 Apache 来配置反向代理，使 Flask 应用能够通过 HTTP(S) 服务，这里以Nginx
在 Windows 上，Nginx 的配置通常是 nginx.conf 文件中的 server 配置块，因为我们 Flask 运行在端口 8089，配置文件如下

server {
    listen 8083;#监听端口
    server_name localhost;

    location / {
        proxy_pass http://127.0.0.1:8089;#这里的8089是flask的运行端口
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

在修改 Nginx 配置后，确保重新加载 Nginx 配置，使改动生效

4.启动程序访问

因为我本地是run.py，所以在项目目录下执行命令python run.py，然后浏览器访问链接http://127.0.0.1:8083/api/complain/list?mobile=13512345678&page=1&size=5，这里是我本地的一个链接，具体需要到自己项目里面
在这里插入图片描述

三.Flask 程序在 Windows 启动时自动启动

1.使用 nssm（Non-Sucking Service Manager）

使用 nssm（Non-Sucking Service Manager）来将 Flask 应用作为服务运行，
下载地址Non-Sucking Service Manager
执行bash命令nssm install FlaskApp "python" "C:\path\to\run.py"

2. Windows 任务计划程序（Task Scheduler）

配置步骤：

打开任务计划程序：在开始菜单中搜索 “任务计划程序”，然后点击打开
创建一个新的任务：在左侧面板中选择 “任务计划程序库”，在右侧的操作面板中点击 “创建任务”。
配置任务：
常规选项卡：为任务命名（例如：FlaskApp），选择 “以最高权限运行”。
触发器选项卡：点击 “新建”，设置任务在 “计算机启动时” 或 “用户登录时” 触发。
操作选项卡：点击 “新建”，选择 “启动程序”。
程序/脚本：输入 Python 可执行文件的路径（例如：C:\Python39\python.exe）。
添加参数：输入 Flask 应用的路径和文件名，例如：C:\path\to\your\app.py。
启动位置：可以选择 Flask 应用所在的目录，或者留空。
确认配置无误后，点击 “确定” 保存任务

3.注册表（Registry）方法

按 Win + R 打开运行窗口，输入 regedit 打开注册表编辑器
导航到以下路径：HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run
在右侧窗格中右键点击并选择 “新建” > “字符串值”
将新建字符串的名称设置为 Flask 应用的名称（例如 FlaskApp）
双击该字符串并在值数据框中输入 Flask 应用启动命令，格式"C:\Python39\python.exe" "C:\path\to\your\app.py"（确保路径中的引号包围了空格）
关闭注册表编辑器，重新启动计算机，查看Flask 应用有没有随系统启动

4.使用 Python 的 win32service 模块

安装 pywin32，可以在requirements.txt里面安装，也可以通过命令pip install pywin32安装
编写一个 Python 脚本来创建服务

import os
import sys
import win32serviceutil
import win32service
import win32event
from flask import Flask
from app import create_app

app = create_app()

class FlaskService(win32serviceutil.ServiceFramework):
    _svc_name_ = "FlaskApp"
    _svc_display_name_ = "Flask Application"
    _svc_description_ = "Flask application running as a service"

    def __init__(self, args):
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)

    def SvcStop(self):
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
        win32event.SetEvent(self.hWaitStop)

    def SvcDoRun(self):
        from waitress import serve
        serve(app, host='0.0.0.0', port=8089)

if __name__ == '__main__':
    win32serviceutil.HandleCommandLine(FlaskService)