Flask结合tornado和Nginx部署为Windows Service服务并开机自启

Flask部署为服务需要三步:

  1. Flask结合tornado部署项目;
  2. 利用win32模块包装第一步的项目启动代码;
  3. 在前两部的基础上配置Nginx转发;

Flask结合tornado部署项目

经过尝试,我发现直接使用Flask原始的app.run()或结合了flask_script插件后的manage.run()都不能成功的设置为Windows的服务,并且那两种方式也不适合作为项目的部署方式。
Linxu中可以使用gunicornuwsgi作为WSGI服务器,但在Windows中都不能用,最后发现结合tornado充当WSGI服务器可以完美设置为Windows的服务。
我们用一个非常简单的Flask工程来进行测试,Flask工程仅仅包含2个文件:

  1. app.py:作为Flask程序;
  2. server.py:结合Tornado作为WSGI服务器启动Flask项目;

app.py代码如下:

import time
from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello_world():
    return 'Hello World!'

@app.route("/sleep")  # 为了测试请求是否只是异步
def sleep():
    time.sleep(15)
    return "Sleep 15's"

service.py代码如下:

import sys
import asyncio

from tornado.ioloop import IOLoop
from tornado.wsgi import WSGIContainer
from tornado.httpserver import HTTPServer

from app import app

# Python3.8的asyncio改变了循环方式,因为这种方式在windows上不支持相应的add_reader APIs,就会抛出NotImplementedError错误。
# 因此在python3.8及更高版本需要加入下面两行代码,其他版本不需要
if sys.platform == 'win32':
    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

if __name__ == '__main__':
    http_server = HTTPServer(WSGIContainer(app))
    http_server.listen(9900)  # 监听9900端口
    IOLoop.current().start()

在当前目录下通过运行service.py文件来启动Flask程序:

python service.py

浏览器访问:127.0.0.1:9900,返回Hello World!表示Flask结合Tornado部署成功。
[图片上传失败...(image-8fe8a-1617348857245)]
如果以上成功了,就可以进行第二部啦,否则看下面的步骤也没用,因为后面都是基于这个步骤的。

利用Win32模块将Flask项目制作成Windows服务

如果想用Python开发Windows程序,并让其开机启动等,就必须写成Windows的服务程序Windows Service,用Python来做这个事情必须要借助第三方模块pywin32,下面有一个简单模板,先来将下模板各部分的作用:

import win32event
import win32service
import win32serviceutil
  
class PythonService(win32serviceutil.ServiceFramework): 
    
    _svc_name_ = "PythonService" # 服务名 
     _svc_display_name_ = "Python Service Test"  # 服务在windows系统中显示的名称 
    _svc_description_ = "This code is a Python service Test"  # 服务的描述
  
    def __init__(self, args):
        # __init__的写法基本固定,可以参考帮助文档中的任意一种
        # https://www.programcreek.com/python/example/99659/win32serviceutil.ServiceFramework
        win32serviceutil.ServiceFramework.__init__(self, args) 
        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None) 
  
    def SvcDoRun(self): 
        # 把自己的代码放到这里,就OK 
        # 等待服务被停止 
        win32event.WaitForSingleObject(self.hWaitStop, win32event.INFINITE) 
     
    def SvcStop(self): 
        # 先告诉SCM停止这个过程 
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING) 
        # 设置事件 
        win32event.SetEvent(self.hWaitStop) 
  
if __name__=='__main__': 
    win32serviceutil.HandleCommandLine(PythonService) 
    # 括号里参数可以改成其他名字,但是必须与class类名一致

上面模板的执行流程:

  1. 在类PythonService__init__函数执行完后,系统服务开始启动,Windows系统会自动调用SvcDoRun函数;
  2. SvcDoRun这个函数的执行不可以结束,因为结束就代表服务停止。所以当我们放自己的代码在SvcDoRun函数中执行的时候,必须确保该函数不退出,如果退出或者该函数没有正常运行就表示服务停止;
  3. 当停止服务的时候,系统会调用SvcStop函数,该函数通过设置标志位等方式让SvcDoRun函数退出,就是正常的停止服务。例子中是通过event事件让SvcDoRun函数停止等待,从而退出该函数,从而使服务停止。

提示:系统关机时不会调用SvcStop函数,所以服务可以设置为开机自启的。
类中的方法名、类属性名称都是固定的,不可以随意改变。其中类属性的值对应服务的展示位置如下图所示:

在这里插入图片描述

现在把第一步service.py中的代码融合到模板中(简单来将就是把原来的代码都塞到SvcDoRun方法中):

# -*- coding:utf-8 -*-
import os
import sys
import time
import socket
import asyncio
import logging
import inspect
import winerror
import win32event
import win32service
import servicemanager
import win32serviceutil

from tornado.ioloop import IOLoop
from tornado.wsgi import WSGIContainer
from tornado.httpserver import HTTPServer

from app import app


class PythonService(win32serviceutil.ServiceFramework):
    _svc_name_ = 'Flask_Web'  # 属性中的服务名
    _svc_display_name_ = 'FLASK_WEB'  # 服务在windows系统中显示的名称
    _svc_description_ = 'Python的Flask程序,用于验证设置Windows服务,且开机自启'  # 服务的描述

    def __init__(self, args):
        """
        init的内容可以参考以下网址:
            https://www.programcreek.com/python/example/99659/win32serviceutil.ServiceFramework

        :param args:
        """
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.stop_event = win32event.CreateEvent(None, 0, 0, None)
        socket.setdefaulttimeout(60)  # 套接字设置默认超时时间
        self.logger = self._getLogger()  # 获取日志对象
        self.isAlive = True

    def _getLogger(self):
        # 设置日志功能
        logger = logging.getLogger('[PythonService]')

        this_file = inspect.getfile(inspect.currentframe())
        dirpath = os.path.abspath(os.path.dirname(this_file))
        handler = logging.FileHandler(os.path.join(dirpath, "service.log"))

        formatter = logging.Formatter('%(asctime)s %(name)-12s %(levelname)-8s %(message)s')
        handler.setFormatter(formatter)

        logger.addHandler(handler)
        logger.setLevel(logging.INFO)

        return logger

    def SvcDoRun(self):
        """
        实例化win32serviceutil.ServiceFramework的时候,windows系统会自动调用SvcDoRun方法,
        这个函数的执行不可以结束,因为结束就代表服务停止。所以当我们放自己的代码在SvcDoRun函数中执行的时候,必须确保该函数不退出,就需要用死循环

        :return: None
        """
        self.logger.info("服务即将启动...")
        while self.isAlive:
            self.logger.info("服务正在运行...")
            sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
            result = sock.connect_ex(('127.0.0.1', 9900))  # 嗅探网址是否可以访问,成功返回0,出错返回错误码
            if result != 0:
                # Python3.8的asyncio改变了循环方式,因为这种方式在windows上不支持相应的add_reader APIs,就会抛出NotImplementedError错误。
                # 因此加入下面两行代码
                if sys.platform == 'win32':
                    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
                s = HTTPServer(WSGIContainer(app))
                s.listen(9900)
                IOLoop.current().start()
                time.sleep(8)
            sock.close()
            time.sleep(20)

    def SvcStop(self):
        """
        当停止服务的时候,系统会调用SvcStop函数,该函数通过设置标志位等方式让SvcDoRun函数退出,就是正常的停止服务。
        win32event.SetEvent(self.hWaitStop) 通过事件退出

        :return: None
        """
        self.logger.info("服务即将关闭...")
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)  # 先告诉SCM停止这个过程
        win32event.SetEvent(self.stop_event)  # 设置事件
        self.ReportServiceStatus(win32service.SERVICE_STOPPED)  # 确保停止,也可不加
        self.isAlive = False


if __name__ == '__main__':
    print("接收到的参数为", sys.argv)
    if len(sys.argv) == 1:
        print("输入参数不正确!")
        try:
            evtsrc_dll = os.path.abspath(servicemanager.__file__)
            servicemanager.PrepareToHostSingle(PythonService)
            servicemanager.Initialize('PythonService', evtsrc_dll)
            servicemanager.StartServiceCtrlDispatcher()
        except Exception as details:
            print("发生异常,信息如下:", details)
            # 如果错误的状态码为1063,则输出使用信息
            if details[0] == winerror.ERROR_FAILED_SERVICE_CONTROLLER_CONNECT:
                win32serviceutil.usage()
    else:
        win32serviceutil.HandleCommandLine(PythonService)  # 括号里必须与class类名一致

提示:监听端口尽量不要设置为5000,因为Flask默认端口是5000,此项目设置为Windows服务后,我们可能会忘记自己在后台一直占用着5000端口,在编写其他Flask项目时启动不起来,把自己绕进去。
问题:在if __name__ == '__main__'代码快中,except部分的代码是有问题的,但是我也不知道是什么意思,而且一般也走不到这个代码块中。其实if __name__ == '__main__'中只写win32serviceutil.HandleCommandLine(PythonService)也是完全没有问题的。

服务操作命令

常用操作命令如下:

# 1.安装服务
python PythonService.py install
# 2.以开机自启的方式安装服务
python PythonService.py --startup auto install
# 3.启动服务
python PythonService.py start
# 4.重启服务
python PythonService.py restart
# 5.停止服务
python PythonService.py stop
# 6.删除/卸载服务
python PythonService.py remove

先执行安装服务命令,再执行启动服务命令(刚开始还以为install好它自己就启来呢,这一顿找Bug,最后发现是没启动服务,坑死),如下图所示:
[图片上传失败...(image-f21f55-1617348857245)]
浏览器输入127.0.0.1:9900,能正常访问说明服务制作成功。
[图片上传失败...(image-1696e7-1617348857245)]

将服务设置成开机自启

其实开机自启,只需要更改安装命令即可。

# 1.先把刚才的服务停止
python PythonService.py stop
# 2.删除刚才的服务
python PythonService.py remove

# 3.以开机自启的方式安装服务
python PythonService.py --startup auto install
# 4.手动启动服务
python PythonService.py start

重启电脑后后直接访问127.0.0.1:9900,此时应该可以照常访问,成功。

结合Nginx实现请求转发

结合Nginx完全按实际需求,如果用不到可以不用。
结合Nginx的话需要做两件事:

  1. 设置Nginx为开机自启
  2. 转发请求到9900端口
安装Nginx并设置开机自启

具体查看“Nginx学习笔记”中的“Windows安装Nginx”:https://blog.csdn.net/u013487601/article/details/115392254

配置Nginx转发请求

当用户在浏览器中输入http://localhostNginx自动转发到9900端口,这样就可以关联到Tornado充当的WSGI服务器。

Nginx的配置文件nginx.conf在安装目录下conf子文件加下,打开该文件,进行如下配置:

http {   
    server {
        listen       80;
        server_name  localhost;
        server_name  127.0.0.1;     
        charset     utf-8;           

        location / {
            root   html;
            index  index.html index.htm;
            proxy_pass  http://localhost:9900;  # 加上这句
        }
        # other configurations
  }

配置完成后,重新启动nginx,当用户在浏览器中输入http://localhostnginx将请求转发到9900端口,从而关联到我们的Flask程序。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容