Ubuntu 下 nginx-1.24.0 源码分析 - ngx_core_module_t

ngx_core_module_t


定义 在 src/core/ngx_module.h

c 复制代码
typedef 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;

ngx_core_module_t 是 Nginx 核心模块的关键结构体,用于定义核心模块的配置管理行为。以下是对该结构体及其成员的详细解释:


结构体作用

ngx_core_module_t 为核心模块提供统一的接口,使 Nginx 框架能够:

  1. 识别模块 :通过 name 字段标识模块。
  2. 管理配置生命周期 :通过 create_conf 和 init_conf 回调函数,在配置解析的不同阶段创建和初始化模块的配置结构。

成员详解

1. ngx_str_t name
  • 作用 :存储模块的名称(如 "core"、"event")。

  • 意义 :

    • 在日志、调试或配置解析时标识模块。
    • 作为模块的唯一标识符,用于框架内部的模块管理。
  • 数据结构 :

    c 复制代码
    typedef struct {
        size_t      len;    // 字符串长度
        u_char     *data;   // 字符串数据(以 NULL 结尾)
    } ngx_str_t;

2. void *(*create_conf)(ngx_cycle_t *cycle)
  • 作用:回调函数,用于创建模块的配置结构。
  • 调用时机:在解析配置文件前被 Nginx 框架调用。
  • 功能 :
    • 为模块分配配置结构的内存(通常使用内存池 cycle->pool)。
    • 初始化配置结构的默认值(如设置默认的工作进程数、超时时间等)。

3. char *(*init_conf)(ngx_cycle_t *cycle, void *conf)
  • 作用:回调函数,用于验证和调整配置。
  • 调用时机:在配置解析完成后被调用。
  • 功能 :
    • 验证配置的合法性(如检查必填项是否缺失)。
    • 合并或调整配置值(如将相对路径转换为绝对路径)。
    • 返回错误信息(若配置无效)。
  • 返回值 :
    • NULL:配置有效。
    • 非 NULL:指向错误信息字符串(Nginx 启动失败并输出该信息)。

整体流程

  1. 模块注册 :核心模块通过定义 ngx_core_module_t 实例注册到 Nginx。
  2. 配置创建 :Nginx 调用 create_conf 为模块分配配置结构。
  3. 配置解析:解析配置文件,填充配置结构。
  4. 配置验证 :调用 init_conf 检查配置合法性。
  5. 启动/错误处理 :若 init_conf 返回错误,Nginx 终止启动并输出错误信息。

核心模块与普通模块的区别

  • 核心模块 :使用 ngx_core_module_t,负责基础功能(如进程管理、事件处理)。
  • 普通模块 :使用 ngx_module_t,实现扩展功能(如 HTTP 处理模块)。

示例场景

以 core 模块为例:

  • create_conf :创建 ngx_core_conf_t 结构,设置 daemon、master_process 等默认值。
  • init_conf :检查 pid 文件路径是否有效,合并主配置与子配置。

总结

ngx_core_module_t 通过标准化核心模块的配置管理,实现了模块与框架的解耦,使 Nginx 能够高效地处理配置的创建、解析和验证,是模块化架构的核心设计之一。

相关推荐
ZhengEnCi4 小时前
覆盖索引是什么:用借书和外卖看懂回表这件事
sql·mysql·postgresql
jaysee-sjc4 小时前
【黑马点评】Day02:优惠券秒杀与分布式锁
java·分布式·nginx·spring·node.js·tomcat·maven
Csvn11 小时前
Nginx 日志、监控与排障:全字段日志、条件日志与证据链定位
后端·nginx
杨凯凡1 天前
Spring Boot SSE 上线后不实时、频繁断线?Nginx 缓冲、心跳与连接回收实战
spring boot·后端·nginx
ZhengEnCi1 天前
覆盖索引怎么设计:从回表代价到 MySQL 与 PostgreSQL 的落地写法
sql·mysql·postgresql
Csvn1 天前
Nginx 缓存体系:三层 key、七态 X-Cache-Status 与锁/stale 策略
后端·nginx
Csvn2 天前
Nginx 负载均衡进阶与健康检查:哈希、keepalive 池与 DNS 自愈
后端·nginx
橘色的喵2 天前
不接 SRS,只用 Nginx 做 WebRTC 播放:架构与踩坑
nginx·webrtc·srs·rtmp
Csvn2 天前
Nginx rewrite 与 server_name:last/break 语义、多域名匹配与伪静态
后端·nginx
亚那迦基2 天前
24小时高危漏洞速报,互联网惊天危机来临!PHP、Java、Node.js、NGINX、GitLab无一幸免,看看你家是否中招
nginx·gitlab·php