nginx模块化结构分析

最新推荐文章于 2025-06-04 11:40:13 发布

liyangcpp

最新推荐文章于 2025-06-04 11:40:13 发布

阅读量666

点赞数

CC 4.0 BY-SA版权

分类专栏： nginx源码学习文章标签： nginx

本文链接：https://blog.youkuaiyun.com/weixin_41093280/article/details/89484446

nginx源码学习专栏收录该内容

1 篇文章

订阅专栏

nginx模块化设计

模块化设计是nginx的架构基础。在nginx中，除了少量核心代码，其他一切皆为模块。
nginx定义模块的方式很简单，例如：

ngx_module_t ngx_http_test_module;

其中，ngx_module_t是nginx模块的数据结构，由于本文主要介绍nginx的模块化设计结构，所有只介绍两个成员：

typedef struct ngx_module_s ngx_module_t;
struct ngx_module_s {
    ...
    
    //nginx模块有很多种，不同模块间的功能差别很大，而ctx将会指向特定模块的公共接口。
    void                 *ctx;
    //type表示模块的类型，与ctx指针紧密相关。官方nginx中，它的取值范围是以下5种：
    //NGX_CORE_MODULE
    //NGX_CONF_MODULE
    //NGX_EVENT_MODULE
    //NGX_HTTP_MODULE
    //NGX_MAIL_MODULE
    ngx_uint_t            type;
    
    ...
};

变量type的五种取值对应官方nginx模块的五大类型：核心模块、配置模块、事件模块、http模块、mail模块。也就是说nginx通过对模块数据结构ngx_module_t中ctx和type的不同赋值，实现不同的模块类型。

五大模块

核心模块和配置模块类型是由nginx的框架代码所定义的，nginx框架会调用核心模块，而配置模块是所有模块的基础，它实现基本的配置文件解析功能。事件模块、http模块和mail模块的共性是在核心模块中各有一个模块作为自己的代言人，并在自身所有同类模块中有一个作为核心业务与管理功能的模块。
1、核心模块
核心模块把ctx实例化为ngx_core_module_t结构体，代码如下：

ypedef struct {
    ngx_str_t             name;
    void               *(*create_conf)(ngx_cycle_t *cycle);
    char               *(*init_conf)(ngx_cycle_t *cycle, void *conf);
} ngx_core_module_t;

对应type的值为NGX_CORE_MODULE。然后就可以再此基础上定义多个此类模块（ctx和type相同）。

ngx_module_t  ngx_core_module = {
    NGX_MODULE_V1,
    &ngx_core_module_ctx,       //ctx:ngx_core_module_t
    ngx_core_commands,
    NGX_CORE_MODULE,            //type
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NGX_MODULE_V1_PADDING
};

核心模块一共有6个：

ngx_module_t  ngx_core_module;   //同上
ngx_module_t  ngx_events_module; //事件模块“代言人”
ngx_module_t  ngx_http_module;   //http模块“代言人”
ngx_module_t  ngx_mail_module;   //mail模块“代言人”
ngx_module_t  ngx_openssl_module;
ngx_module_t  ngx_errlog_module;

2、配置模块
由于配置模块只有一个只拥有1个模块，所有并没有具体化实现ctx上下文成员，如下：

ngx_module_t  ngx_conf_module = {
    NGX_MODULE_V1,
    NULL,             //这个成员就是ctx，直接设置为NULL
    ngx_conf_commands,
    NGX_CONF_MODULE,  //type
    NULL,
    NULL,
    NULL, 
    NULL, 
    NULL,
    ngx_conf_flush_files,
    NULL,
    NGX_MODULE_V1_PADDING
};

3、事件模块

ngx_module_t  ngx_event_core_module = {
    NGX_MODULE_V1,
    &ngx_event_core_module_ctx,    //ctx：ngx_http_module_t
    ngx_event_core_commands,
    NGX_EVENT_MODULE,              //type
    NULL,
    ngx_event_module_init,
    ngx_event_process_init,
    NULL,
    NULL,
    NULL,
    NULL,
    NGX_MODULE_V1_PADDING
};

所有事件模块的加载操作是ngx_event_core_module负责。
4、http模块

{
    NGX_MODULE_V1,
    &ngx_http_core_module_ctx, //ctx：ngx_http_module_t
    ngx_http_core_commands,
    NGX_HTTP_MODULE,           //type
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NGX_MODULE_V1_PADDING
};