Gunicorn系列之利用Gunicorn启动项目

Gunicorn是一个基于Python实现的动态Web服务器/Web容器，实现了WSGI协议，可以与Django、Flask等Web框架集成。

1. WSGI协议简单介绍

WSGI全称是 Web Server Gateway Interface。具体来说，WSGI 是一个规范，定义了Python写的动态Web服务器和Application应用程序如何交互。WSGI 最早是在PEP-333中定义的，现在已经移到PEP-3333中。

支持WSGI的Web服务器有Python下的Gunicorn，C下的uWSGI，Aapache下的mod_wsgi。而支持WSGI的Web框架（Web Application）有Django2.X、Flask等。

2. WSGI与ASGI的区别与联系

WSGI只支持同步方式，它的超集ASGI是支持异步的。我们知道从客户端到动态Web服务器走的是HTTP协议，而动态Web服务器到Application应用程序是WSGI/ASGI规范。

而HTTP1.X是请求/响应方式的同步协议，不支持异步，所以它一般与WSGI一起配合使用。而Websocket/HTTP2/HTTP3是支持异步的，所以它一般与ASGI一起配合使用。

支持ASGI规范的Web服务器有Uvicorn，Web框架（Web Application）的有FastAPI，Django3.X。

3. Gunicorn与WSGI

WSGI要求Web服务器实现HTTP和WSGI之间的转换，同时Web框架完成业务逻辑，所以WSGI实现了底层Web服务器与上层业务逻辑的解耦。

因此，不难理解Guncorn的主要功能是：

接收客户端HTTP请求，解析请求，封装成WSGI格式的【environ】的环境变量，传递给Web框架
最后接收Web框架处理结果：WSGI格式的响应，转换成HTTP格式返回给客户端。

4. 通过【python main.py】的方式

该方式，主要用于在开发Gunicorn时，测试其否能正常工作

main.py【如下例子，该文件是我们自己手动实现的py文件】

# main.pyimport multiprocessing
import gunicorn.app.basedef app_handler(environ, start_response):status = '200 OK'response_headers = [('Content-Type', 'text/plain'),]start_response(status, response_headers)# response_body = ['Works fine\n']response_body = []for key, value in environ.items():response_body.append(f'{key}: {value}')response_body.append('\nWorks fine\n')return response_body.encode('utf-8')class APPHandler(object):def __init__(self, environ, start_response):self.environ = environself.start_response = start_responsedef __call__(self, environ, start_response):self.environ = environself.start_response = start_responsedef __iter__(self):data = 'Hello, World!\n'status = '200 OK'response_headers = [('Content-type', 'text/plain'),('Content-Length', str(len(data))),('Foo', 'B\u00e5r'),  # Foo: Bår]self.start_response(status, response_headers)yield data.encode("utf-8")class APPServer(gunicorn.app.base.BaseApplication):def __init__(self, app, options=None):self.options = options or {}self.application = appsuper().__init__()def load_config(self):config = {key: value for key, value in self.options.items()if key in self.cfg.settings and value is not None}for key, value in config.items():self.cfg.set(key.lower(), value)def load(self):return self.applicationif __name__ == '__main__':options = {'bind': ['0.0.0.0:6000', '[::]:6000'],'workers': multiprocessing.cpu_count(),}APPServer(app_handler, options).run()# APPServer(APPHandler, options).run()

app handler函数/类：

用于读取客户端请求数据，解析处理后，产生响应；
app handler函数需要的参数：一个为字典变量【environ】，表示环境变量。另一个为函数指针，不是函数调用，该函数【start_response()】用来产生响应体的状态和头部。
同理app handler类的_ call__ 方法也是接收环境变量和函数指针两个参数，与上面相同。另外，该类需要实现_ iter__ 方法，该方法是个生成器，产生HTTP响应。
生产环境中，一般是Web框架的接口文件，不需要我们手动实现。

app server类：

需要继承【gunicorn.app.base.BaseApplication】类；
app server类的参数：一个是app handler函数或者类，另一是server配置参数字典；
app server类实现两了个方法：【load()】和【load_config()】（用于加载配置到server）。
生产环境中，一般是调用【gunicorn.app.wsgiapp】模块完成的。

5. 通过【gunicorn project.wsgi --chdir /path/to/project-root -c /path/to/project-cfg.py】

(1) 该方式就是生产环境中使用Gunicorn来启动项目的正确姿势，与以下命令一致。

python -m  gunicorn.app.wsgiapp project.wsgi --chdir /path/to/project-root -c /path/to/project-cfg.py

python -m gunicorn.app.wsgiapp

该命令会让python解释器去【sys.path】所列举的目录中，去查找模块【gunicorn.app.wsgiapp】，所以直接运行【gunicorn】和运行【python -m gunicorn.app.wsgiapp】效果一样。
说白了【gunicorn】作为可执行脚本运行时，其实就是调用【python】去执行源码文件【gunicorn/app/wsgiapp.py】，至于如何实现该功能，以后补上。

project.wsgi

一般是特定web框架，提供给Gunicorn的接口文件，比如Django中的 SomeProject.wsgi模块

project-root

为具体的Web项目根路径。

project-cfg.py

为项目的外部配置文件，必须是.py格式，用于对Gunicorn进行个性化配置，当然也可以通过命令行参数的方式加以配置。

(2) 例如Django项目中的wsgi接口文件如下

# wsgi.py"""
WSGI config for django_demo project.It exposes the WSGI callable as a module-level variable named ``application``.For more information on this file, see
https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/
"""import osfrom django.core.wsgi import get_wsgi_applicationos.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_demo.settings')application = get_wsgi_application()

假设该django项目位于【/tmp/myporject/】，内容如下

myapp1 myapp2 myproject  manage.py

那么我们可以通过以下命令启动此Django项目

gunicorn --chdir /tmp/myproject/ myproject.wsgi