关于 Apache 与 Flask 的集成经历 | 隔叶黄莺 Yanbin Blog

2020-07-16 | 阅读(1,883)

在 Flask 的官方文档 mod_wsgi(Apache), 说来倒是轻巧，实际操作起来不得不时刻要凝视眼前的无数大坑，或许 Linux, Apache 都用上比较新的版本会好一些。而我所用的环境是 AWS 上的 EC2, AMI 镜像发行版用 cat /proc/version 看到的是 Red Hat 7.2.1-2，内核为 4.14。照着 Flask 的官方文档是没做成功的，yum install mod_wsgi 只能安装到 Python2 的模块，pip install mod_wsgi 也不成功，所以只能使用 mod_wsgi 的源码来编译安装。

要能顺利编译过 mod_wsgi, 需要安装 Apache 2.2 和 Python 3.6 的 dev 版本。它的仓库里 Python3 最高版本只有 Python 3.6，要 Python 3.7, 3.8 可从源码编译安装。

$ yum install gcc
$ yum install httpd-devel
$ yum install python36-devel

Red Hat 7.2 下的 Apache 真心的难用，不叫 Apache2 也不叫 httpd2，不像 Debian 系统下的 Apache2 做了模块化，基本上 Red Hat 7.2 的 httpd 的配置全在一个文件中 /etc/httpd/conf/httpd.conf。

只安装 httpd 的话没有 configure mod_wsgi 时找不到 apxs 命令; 只安装 python36 的话 make mod_wsgi 时提示找不到 Python.h 头文件。

src/server/wsgi_python.h:24:20: fatal error: Python.h: No such file or directory
#include <Python.h>
^

再就下载，编译，安装 mod_wsgi, 从 https://github.com/GrahamDumpleton/mod_wsgi/releases 找到当前版本是 mod_wsgi 4.7.1

$ wget https://github.com/GrahamDumpleton/mod_wsgi/archive/4.7.1.tar.gz
$ tar xzvf 4.7.1.tar.gz
$ cd mod_wsgi-4.7.1
$ ./configure --with-python=/usr/bin/python3
$ make
$ make install

完后会看到生成了 /usr/lib64/httpd/modules/mod_wsgi.so 文件。

到 /etc/httpd/conf/httpd.conf 中加上一行装载 mod_wsgi 模块

LoadModule wsgi_module modules/mod_wsgi.so

现在来把 Flask 与 Apache 结合起来，假设应用目录是 /data/my-app，我们在其中创建一个 Flask 的 app.py 文件和 my-app.wsgi 文件

app.py 的内容为

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/', methods=['GET'])
def index():
    return jsonify('hello world!')

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/', methods=['GET'])

def index():

return jsonify('hello world!')

这个 app.py 用下面命令可以启动

$ export FLASK_APP=app.py
$ flask run

启动后会监听到 127.0.0.1:5000, 外部不允许访问。curl localhost 可看到 "hello world!" 输出

my-app.wsgi 的内容为

import sys
sys.path.insert(0, '/data/my-app')
from app import app as application

import sys

sys.path.insert(0, '/data/my-app')

from app import app as application

Apache 借由 wsgi 来访问 Flask 应用不再需要 app.run() 来启动 Flask 了，它们内部是通过文件 Socket 来通信的，加上

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

也没有关系，因为从 wsgi 来执行 app.py 时，__name__ 不再是 '__main__' 了。

编辑 /etc/httpd/conf/http.conf, 在后面加上虚拟机的配置

WSGISocketPrefix /var/run/wsgi
<VirtualHost *>
    ServerName yanbin.blog

    WSGIDaemonProcess my-app user=web-user group=web-user threads=5 python-home=/data/my-app/venv
    WSGIScriptAlias / /data/my-app/my-app.wsgi

    <Directory /data/my-app>
        WSGIProcessGroup my-app
        WSGIApplicationGroup %{GLOBAL}
        Order allow,deny
        Allow from all
    </Directory>
</VirtualHost>

WSGISocketPrefix /var/run/wsgi

ServerName yanbin.blog

WSGIDaemonProcess my-app user=web-user group=web-user threads=5 python-home=/data/my-app/venv

WSGIScriptAlias / /data/my-app/my-app.wsgi

WSGIProcessGroup my-app

WSGIApplicationGroup %{GLOBAL}

Order allow,deny

Allow from all

</Directory>

</VirtualHost>

WSGIScriptAlias /abc /data/my-app/my-app.wsgi 表示 http://yanbin.blog/abc 会被这个 wsgi 处理

要为 WSGIDaemonProcess 创建好用户和组，上面指定了 user=web-user group=web-user，所以我们在重启 Apache 之前需要预做

$ groupadd web-user
$ useradd -r web-user -g web-user
$ sudo chown -R web-user:web-user /data/my-app

在 Apache 的虚拟机中配置了用 Python 虚拟环境，所以还必须先做好

$ cd /data/my-app
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install flask

注意本文用的 Linux 为 RedHat 7.2, Apache 2.3, 以及 Python 3.6, 现在重新启动 Apache

$ service httpd restart

如果一切正常的话，此时访问 http://localhost 或远程用 http://<IP 地址> 可以看到网页中显示

"hello world!"

这只是一切正常的情况下，其实当我们参考 Flask 官方文档开始尝试把 Apache 和 Flask 撮合到一起的时候，各种大大小小的坑就纷至沓来。

首先目录的权限，/data/my-app 的每一级目录对 web-user:web-user 是可执行的(可打开目录)，文件最至能读，所以最好把 owner 给 web-user:web-user 用户，否则就是各种的 Internal Server Error 问题，或权限问题。比如可用 chmod 把目录改为 744，文件 644。

my-app.wsgi 文件并不要求可执行的权限，因为 wsgi 只是把它当做 Python 源代码文件来执行的，其实它就是一个 python 文件。

记住无论发生的什么问题，都应该打开 Apache 的错误日志文件 /var/log/httpd/error_log 中去找线索，并通过 Google 发现答案。下面列出一些我碰到的几个问题：

一：access denied because search permissions are missing

典型的文件权限问题，注意某个文件是否能被 wsgi 进程用户 web-user 可访问，目录 755，文件 644.

二：from flask import Flask, jsonify, ImportError: cannot import name 'Flask'

明明不用 Python 虚拟环境时，已安装了 Flask, 且能直接用 export FLASK_APP=app.py; flask run 启动 Flask 应用，也就是在系统的 Python3 相应目录中已安装了 Flask，却仍然提示找不到 Flask。也能在 /var/log/httpd/error_log 中看到 Apache 与 Python/3.6 绑定在了一起

Apache/2.2.34 (Unix) DAV/2 mod_wsgi/4.7.1 Python/3.6 configured

解决办法，还是用 Python 虚拟环境吧，记得在 Apache 的虚拟机配置中的 WSGIDaemonProcess 行加上参数

python-home=/data/my-app/venv

python-path=/data/my-app/venv/lib/python3.6/site-packages 非必要，假如 Python 虚拟环境创建在 /data/my-app。

三：from app import app as application, ModuleNotFoundError: No module named 'app'

原因是在 my-app.wsgi 文件中没有把当前目录加到 sys.path 中来，从而造成找不到当前目录中的模块 app

import sys
sys.path.insert(0, '/data/my-app')

四：Permission denied: mod_wsgi (pid=27094): Unable to connect to WSGI daemon process 'my-app' on '/etc/httpd/logs/wsgi.27089.0.1.sock' as user with uid=48

这时候页面呈现的是 Service Temporarily Unavailable。出现这种情况是因为在 Apache 的虚拟机配置的外头没有加上下面这行

WSGISocketPrefix /var/run/wsg

注意是在 <VirtualHost *> 标签之外，不是在里面

五：Apache: AuthType not set! 500 Error

这就涉及到 Apache 的虚拟机中关 <Directory /data/my-app> 中的访问权限设置问题了，不同 Apache 版本略有不同

Apache < 2.4 及以前

Order allow,deny
Allow from all

Apache >= 2.4 及后用

Require all granted

另有因为 SELINUX 问题造成访问任何文件无权限的问题，我是还没碰到过，执行命令 setenforce 0 关闭 SELINUX，或改 /etc/selinux/config 配置来禁掉 SELINUX，备注一下。

更多更详细的信息应该阅读 mod_wsgi 官方文档

链接：

本文链接 https://yanbin.blog/about-apache-flask-integration/, 来自隔叶黄莺 Yanbin Blog

seetimee on 体验 Python FastAPI 的并发能力及线, 进程模型感谢
Yanbin on Mockito 3.4.0 开始可 Mock 静态方法有一个补救，新写了一篇 https://yanbin.blog/mockito-mock-static-method-in-multiple...
Yanbin on 升级到 Spring Boot 3 后 javax.inject.Named 不可用怎么，被抄袭了！算是被机器翻译引用的？
oleksi on 升级到 Spring Boot 3 后 javax.inject.Named 不可用https://www.springcloud.io/post/2023-02/springboot-3-javax-inject-name...
Zhe on 体验 Python FastAPI 的并发能力及线, 进程模型你在trio下得用 trio.sleep()，调用asyncio.sleep() 就会报错。

M	T	W	T	F	S	S
				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30