将Flask
部署为服务需要三步:
-
Flask
结合tornado
部署项目; - 利用
win32
模块包装第一步的项目启动代码; - 在前两部的基础上配置
Nginx
转发;
Flask结合tornado部署项目
经过尝试,我发现直接使用Flask原始的app.run()
或结合了flask_script
插件后的manage.run()
都不能成功的设置为Windows
的服务,并且那两种方式也不适合作为项目的部署方式。
在Linxu
中可以使用gunicorn
或uwsgi
作为WSGI
服务器,但在Windows
中都不能用,最后发现结合tornado
充当WSGI
服务器可以完美设置为Windows
的服务。
我们用一个非常简单的Flask
工程来进行测试,Flask
工程仅仅包含2个文件:
-
app.py
:作为Flask
程序; -
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类名一致
上面模板的执行流程:
- 在类
PythonService
的__init__
函数执行完后,系统服务开始启动,Windows
系统会自动调用SvcDoRun
函数; -
SvcDoRun
这个函数的执行不可以结束,因为结束就代表服务停止。所以当我们放自己的代码在SvcDoRun
函数中执行的时候,必须确保该函数不退出,如果退出或者该函数没有正常运行就表示服务停止; - 当停止服务的时候,系统会调用
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
的话需要做两件事:
- 设置
Nginx
为开机自启 - 转发请求到9900端口
安装Nginx
并设置开机自启
具体查看“Nginx
学习笔记”中的“Windows
安装Nginx
”:https://blog.csdn.net/u013487601/article/details/115392254
配置Nginx
转发请求
当用户在浏览器中输入http://localhost
,Nginx
自动转发到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://localhost
,nginx
将请求转发到9900端口,从而关联到我们的Flask
程序。