将基于Flask框架的Web应用部署到IIS上

1. 需求

原有的系统是部署在IIS上,现在需要开发一些新功能,这些新功能发现用python实现很方便,于是开始构造。和老功能之间使用http通讯自然也方便。于是就找个微小框架,选择flask作为Python的Web框架。因此,最好是能将python部署到IIS上。

2. 环境

服务程序 版本 操作系统
IIS 10.0 Windows10
IIS 8.0 Windows Server 2012
Python3 3.7.* Windows 10, Windows Server 2012
wfastcgi 3.0.0 -
Flask 1.0 -

3. 技术原理引用

根据百度来的文章,基本都不可靠。还是需要自己从技术原文研究一下。

3.1. 基本原理

通过配置桥接,将IIS的请求利用wfastcgi功能,启动flask框架开发的程序来做响应。其中,关键一点就是IIS中配置的网站需要一个fastcgi的配置,指定python.exe作为cgi程序,指定wfastcgi.py作为脚本执行。

即配置web.config完成这个桥接设定。

wfastcgi 3.0.0

原文如下:
https://pypi.org/project/wfastcgi/

部署IIS的说明

https://docs.microsoft.com/zh-cn/visualstudio/python/configure-web-apps-for-iis-windows?view=vs-2017

3.2. 重点

因为IIS是微软产品,所以必须去微软的文档中找资料。fastcgi桥接脚本,其实也是微软自己开发的。python的web如此流行,当下微软应该有对应的方法来处理。

4. 实战

4.1. 安装Python3

经过反复测试,如果windows上安全Python3,一定要安装自定义目录,且勾选all users选项。
一开始测试时候,一口气next下去,无论如何都不好用,总是报错fastcgi错误或者500,后来重新安装Python,并指定开放的目录才解决。应该是fastcgi的配置需要执行权限导致的。

下载地址:
https://www.python.org/downloads/release/python-372/
找一个可执行的文件下载。部署端的32bit或64位版本应该和你开发端一致。经过测试,发现部分package是有不兼容的情况。

我这里就安装到C:\pythons\Python37下,方便处理,也可以避免windows10的文件权限问题。默认是安装到users的appData目录的,很麻烦。

4.2. 安装组件

4.2.1. 在线服务器

开发后的版本本身可以制作setup.py,这里应该参考:https://dormousehole.readthedocs.io/en/latest/tutorial/install.html
将依赖包都放入:

install_requires=[
    'flask',
    'pandas',
],

然后形成自己的whl,复制到服务器上后,在安装自己的whl

pip install flaskr.whl

pip程序会根据requires配置再安装对应的组件。

4.2.2. 离线部署

离线很麻烦。需要将venv中的包都下载好whl,然后依次pip。其他方式都不太可靠。
当然也可以制作requirement然后一次性离线安装。但是这个需要注意每个包的次序,否则还是会安装失败。具体以后再专门记录一下。

4.3. 配置

安装部署之后,应该形成一个执行目录。这里,我用了flask的案例即一个小blog的应用flaskr。
教程原文:https://dormousehole.readthedocs.io/en/latest/tutorial/index.html

这个教程的应用是形成一个Web工厂,而不是其他百度来的文章中一个简单的helloword,这个更实际。因为这个案例中没有启动应用的app.py。

百度上也好,其他微软文档也好,都集中在web.config的内容解释上,这个其实很误导部署操作。这里还是利用可视化界面进行配置。(所以很喜欢centOS等的原因就是部署可以根据研发执行脚本,windows还是可视化操作更好)

4.3.1. 目录环境

内容 目录
python.exe C:\pythons\Python37\python.exe
wfastcgi.py C:\pythons\Python37\Lib\site-packages\wfastcgi.py
flaskr项目 C:\py\flask-tutorial

项目的内部目录结构

C:\py\flask-tutorial
├── flaskr/
│   ├── __init__.py
│   ├── db.py
│   ├── schema.sql
│   ├── auth.py
│   ├── blog.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── auth/
│   │   │   ├── login.html
│   │   │   └── register.html
│   │   └── blog/
│   │       ├── create.html
│   │       ├── index.html
│   │       └── update.html
│   └── static/
│       └── style.css

这个项目目录中没有任何py文件,项目直接为flaskr包

4.3.2. 向IIS注册wfastcgi功能

根据wfastcgi 3.0.0中的说明,需要启用功能。其实实际就是IIS中增加一个fastCgi的设置。
使用管理员权限的cmd执行:

wfastcgi-enable

执行结果截图

可以看到执行之后,已经提示了IIS的配置结果。并且给出了配置参数:
C:\pythons\Python37\python.exe|C:\pythons\Python37\Lib\site-packages\wfastcgi.py
说明:
can now be used as a FastCGI script processor这个是重点理解的地方。
也就是说,可以添加一个新网站,这个网站如果要使用wfastcgi连接flask应用,可以利用上述参数进行配置且使用IIS中fastCGI已经配置好的脚本解释器。
在IIS管理器中查看结果:
查看IIS配置结果

应该添加好fastCGI程序,如果没有则后续无法执行:
fastCGI配置

这里不再需要配置什么所谓的参数,环境等等。因为是全局的,后续应该在网站中配置。

4.3.3. 添加网站

IIS管理器上添加一个新网站(如果是默认站点,那么可以跳过)。
我添加了一个flaskr的网站,虚拟目录指向C:\py\flask-tutorial,端口号指定为:8001

大部分百度出来的文章,这里就开始讲怎么新建一个web.config,最好使用IIS管理器帮我们新建一个,自己不需要动手。免得出错。

处理映射程序

添加一个映射程序模块:
网站→处理程序映射→添加模块映射

配置模块:
添加模块映射

可执行文件配置中的内容,就是4.3.2中的提示的参数内容:C:\pythons\Python37\python.exe|C:\pythons\Python37\Lib\site-packages\wfastcgi.py
配置请求限制为 *
配置请求限制

确定后,系统会配置一个web.config放入项目目录下。

4.3.4. 配置项目

即对web.config做详细处理。这里可以手工,也可以在IIS管理器中配置。
这里还是直接编辑文件来的方便,且不容易出错。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
       <!-- handlers在4.3.2步骤中配置好,IIS管理器生成,不要手工修改 -->
        <handlers>
            <add name="flaskr" path="*" verb="*" modules="FastCgiModule" scriptProcessor="C:\pythons\Python37\python.exe|C:\pythons\Python37\Lib\site-packages\wfastcgi.py" resourceType="Unspecified" />
        </handlers>
    </system.webServer>
    <!-- appSettings节点需要手工添加 -->
    <appSettings>
        <!-- 2个必须要有的参数: 
        @WSGI_HANDLER:fastCGI获得请求后调用的flask应用入口。
        @PYTHONPATH: 执行整个应用的项目目录
        -->
        <add key="WSGI_HANDLER" value="flaskr.create_app()" />
        <add key="PYTHONPATH" value="C:\py\flask-tutorial" />
        <!-- 可选参数, 我这里就配置一个日志文件,其他应该参考 https://pypi.org/project/wfastcgi/ -->
        <add key="WSGI_LOG" value="C:\xlog\flaskr_web.log" />
    </appSettings>
</configuration>

WSGI_HANDLER参数说明

这里是严重被误导的地方。浪费我太多时间。
很多文档或百度出来的示例,都是***.app。其实是错误的。最后,根据wfastcgi 3.0.0中的说明,才明白这个参数的概念:执行程序的入口。
由于大部分flask的示例都是单文件,且简单如下:

app = Flask(__name__)

因此,这里只要配置__name__.app即可,其实就是执行某个py文件中的app变量,而这个app变量为Flask()函数的返回值而已。

我这里使用了模块的方式,在__init__.py中有一个函数来创建app。因此配置的值就是:flaskr.create_app(),不需要任何的管理或启动py文件,即可使用。用模块方式,其实更方便。

5. 总结

百度出来的各种文章,很失败,很误导,很浪费时间
也没有一些人说的windows+IIS部署flask有多麻烦。关键是大家都没有搞清楚wfastcgi 3.0.0中的说明。阅读原文并理解概念很重要。英文不好,也可以参考Visual Studio的帮助文档

被误导的几个方面:

  • webinstall工具 -- 离线部署不可能用
  • cgi安装,这个其实正常IIS配置都需要的
  • url重定向,这个根本不需要。2个微软文档都没有提到,我也没有配置,即部署成功
  • web.config,只要wfastcgi-enable之后即可配置,任何乱配,乱设定环境参数都是无用功。网站的web.config只需要配置参数,根据说明书走即可。
  • 静态文件:经过测试,似乎没有必要专门配置的。

将项目开发中的venv内容部署后,wfastcgi直接配置为venv,似乎不起作用。一直没有成功。还是老老实实配置生产环境为全局环境吧。

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

推荐阅读更多精彩内容