Gunicorn运行指南：从基础命令到框架集成

Gunicorn运行指南：从基础命令到框架集成

gunicorn gunicorn 'Green Unicorn' is a WSGI HTTP Server for UNIX, fast clients and sleepy applications. 项目地址: https://gitcode.com/gh_mirrors/gu/gunicorn

什么是Gunicorn

Gunicorn（Green Unicorn）是一个Python WSGI HTTP服务器，用于运行Python Web应用程序。它简单易用但功能强大，支持多种工作模式，能够处理大量并发请求，是部署Python Web应用的标准选择之一。

基本运行方式

安装Gunicorn后，可以通过命令行直接运行WSGI应用：

gunicorn [选项] [WSGI应用]

其中WSGI应用的格式为模块名:变量名，模块名可以是完整的点分路径，变量名指向模块中的WSGI可调用对象。

简单示例

假设我们有一个最简单的WSGI应用：

def app(environ, start_response):
    """最简单的应用对象"""
    data = b'Hello, World!\n'
    status = '200 OK'
    response_headers = [
        ('Content-type', 'text/plain'),
        ('Content-Length', str(len(data)))
    ]
    start_response(status, response_headers)
    return iter([data])

可以使用以下命令运行：

gunicorn --workers=2 test:app

应用工厂模式

Gunicorn也支持应用工厂模式，即通过函数调用来获取应用对象：

def create_app():
    app = FrameworkApp()
    # 其他初始化代码
    return app

运行命令：

gunicorn --workers=2 'test:create_app()'

常用命令行参数

Gunicorn提供了丰富的配置选项，以下是最常用的几个：

1. 配置文件：-c CONFIG或--config=CONFIG

   • 指定配置文件路径，格式可以是$(PATH)、file:$(PATH)或python:$(MODULE_NAME)

2. 绑定地址：-b BIND或--bind=BIND

   • 指定服务器绑定的socket，可以是$(HOST)、$(HOST):$(PORT)、fd://$(FD)或unix:$(PATH)

3. 工作进程数：-w WORKERS或--workers=WORKERS

   • 设置工作进程数量，通常建议设置为服务器核心数的2-4倍

4. 工作进程类型：-k WORKERCLASS或--worker-class=WORKERCLASS

   • 指定工作进程类型，可选值包括：
     • sync：同步工作进程（默认）
     • eventlet：基于eventlet的异步工作进程
     • gevent：基于gevent的异步工作进程
     • tornado：基于Tornado的异步工作进程
     • gthread：使用线程的工作进程

5. 应用名称：-n APP_NAME或--name=APP_NAME

   • 设置Gunicorn进程在系统进程表中的名称（需要安装setproctitle）

与Django集成

Gunicorn与Django框架集成非常简单。如果未指定WSGI可调用对象，Gunicorn会默认查找名为application的对象。

对于典型的Django项目，运行命令如下：

gunicorn myproject.wsgi

注意：需要确保项目在Python路径中，最简单的方法是在包含manage.py的目录中运行此命令。

如果需要设置Django配置模块：

gunicorn --env DJANGO_SETTINGS_MODULE=myproject.settings myproject.wsgi

与Paste Deployment集成

对于使用Paste Deployment配置文件的框架（如Pyramid和TurboGears），Gunicorn提供了两种集成方式：

1. 作为服务器运行器

在配置文件中指定Gunicorn作为服务器：

[server:main]
use = egg:gunicorn#main
host = 127.0.0.1
port = 8080
workers = 3

这种方式简单快捷，但有一些限制，如无法使用Gunicorn的重载功能。

2. 使用paste选项

要充分利用Gunicorn的功能（如热重载和代码热升级），可以使用--paste选项：

gunicorn --paste development.ini -b :8080 --chdir /path/to/project

或指定特定应用：

gunicorn --paste development.ini#admin -b :8080 --chdir /path/to/project

这种方式下，Gunicorn会使用PasteDeploy配置文件中定义的应用程序，但不会使用其中定义的服务器配置。

生产环境建议

1. 工作进程数：根据服务器CPU核心数合理设置，通常为2-4倍核心数
2. 工作进程类型：对于I/O密集型应用，推荐使用gevent或eventlet
3. 绑定地址：生产环境建议使用Unix socket而非TCP端口
4. 日志配置：确保正确配置日志记录，便于问题排查
5. 进程管理：考虑使用系统服务或进程管理器（如systemd或进程管理工具）来管理Gunicorn进程

通过合理配置，Gunicorn可以成为Python Web应用稳定、高效的运行平台。

gunicorn gunicorn 'Green Unicorn' is a WSGI HTTP Server for UNIX, fast clients and sleepy applications. 项目地址: https://gitcode.com/gh_mirrors/gu/gunicorn