nginx 模块相关配置及结构理解

文章目录

  • 模块配置结构
  • 模块配置指令
    • 先看一下 ngx_command_t 结构
    • 一个模块配置的demo
    • 简单模块配置的案例演示
  • 模块上下文结构
  • 模块的定义

模块配置结构

Nginx中每个模块都会提供一些指令，以便于用户通过配置去控制该模块的行为。
Nginx的配置信息分成了几个作用域(scope,有时也称作上下文)。作用域有main, server, 以及location。

模块配置指令

先看一下 ngx_command_t 结构

位置： src/core 目录下 ngx_conf_file.h
ngx_command_t原型：

typedef struct ngx_command_s         ngx_command_t;
struct ngx_command_s {ngx_str_t             name;		// 配置指令名称ngx_uint_t            type;		// 该配置的类型，其实更准确一点说，是该配置指令属性的集合。（具体见下文）char               *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);	// （具体见下文）ngx_uint_t            conf;		/*该字段被NGX_HTTP_MODULE类型模块所用 (我们编写的基本上都是NGX_HTTP_MOUDLE，只有一些nginx核心模块是非NGX_HTTP_MODULE)，该字段指定当前配置项存储的内存位置。实际上是使用哪个内存池的问题。因为http模块对所要保存的配置信息，划分了main, server和location三个地方进行存储，每个地方都有一个内存池用来分配存储这些信息的内存。这里可能的值为 NGX_HTTP_MAIN_CONF_OFFSET、NGX_HTTP_SRV_CONF_OFFSET或NGX_HTTP_LOC_CONF_OFFSET。当然也可以直接置为0，就是NGX_HTTP_MAIN_CONF_OFFSET。*/ngx_uint_t            offset;	/*指定该配置项值的精确存放位置，一般指定为某一个结构体变量的字段偏移。因为对于配置信息的存储，一般我们都是定义个结构体来存储的。那么比如我们定义了一个结构体A，该项配置的值需要存储到该结构体的b字段。那么在这里就可以填写为offsetof(A, b)。对于有些配置项，它的值不需要保存或者是需要保存到更为复杂的结构中时，这里可以设置为0。*/void                 *post;		/* 该字段存储一个指针。可以指向任何一个在读取配置过程中需要的数据，以便于进行配置读取的处理。大多数时候，都不需要，所以简单地设为0即可。*/
};

补充说明：
1）对type字段
nginx提供了很多预定义的属性值（一些宏定义），通过逻辑或运算符可组合在一起，形成对这个配置指令的详细的说明。
属性值可以有：

NGX_CONF_NOARGS：配置指令不接受任何参数。
NGX_CONF_TAKE1：配置指令接受1个参数。
NGX_CONF_TAKE2：配置指令接受2个参数。
NGX_CONF_TAKE3：配置指令接受3个参数。
NGX_CONF_TAKE4：配置指令接受4个参数。
NGX_CONF_TAKE5：配置指令接受5个参数。
NGX_CONF_TAKE6：配置指令接受6个参数。
NGX_CONF_TAKE7：配置指令接受7个参数。
可以组合多个属性，比如一个指令即可以不填参数，也可以接受1个或者2个参数。那么就是
NGX_CONF_NOARGS|NGX_CONF_TAKE1|NGX_CONF_TAKE2。

nginx还提供了一些定义，使用起来更简洁：

NGX_CONF_TAKE12：配置指令接受1个或者2个参数。
NGX_CONF_TAKE13：配置指令接受1个或者3个参数。
NGX_CONF_TAKE23：配置指令接受2个或者3个参数。
NGX_CONF_TAKE123：配置指令接受1个或者2个或者3参数。
NGX_CONF_TAKE1234：配置指令接受1个或者2个或者3个或者4个参数。
NGX_CONF_1MORE：配置指令接受至少一个参数。
NGX_CONF_2MORE：配置指令接受至少两个参数。
NGX_CONF_MULTI：配置指令可以接受多个参数，即个数不定。
NGX_CONF_BLOCK：配置指令可以接受的值是一个配置信息块。也就是一对大括号括起来的内容。里面可以再包括很多的配置指令。比如常见的server指令就是这个属性的。
NGX_CONF_FLAG：配置指令可以接受的值是”on”或者”off”，最终会被转成bool值。
NGX_CONF_ANY：配置指令可以接受的任意的参数值。一个或者多个，或者”on”或者”off”，或者是配置块。
需要说明的是，无论如何，nginx的配置指令的参数个数不可以超过NGX_CONF_MAX_ARGS个。目前这个值被定义为8，也就是不能超过8个参数值。

下面介绍一组说明配置指令作用域的相关属性：

NGX_DIRECT_CONF：可以出现在配置文件中最外层。例如已经提供的配置指令daemon，master_process等。
NGX_MAIN_CONF：http、mail、events、error_log等。
NGX_ANY_CONF：该配置指令可以出现在任意配置级别上。
对于我们编写的大多数模块而言，都是在处理http相关的事情，也就是所谓的都是NGX_HTTP_MODULE，对于这样类型的模块，其配置可能出现的位置也是分为直接出现在http里面，以及其他位置：
NGX_HTTP_MAIN_CONF： 可以直接出现在http配置指令里。
NGX_HTTP_SRV_CONF：可以出现在http里面的server配置指令里。
NGX_HTTP_LOC_CONF：可以出现在http server块里面的location配置指令里。
NGX_HTTP_UPS_CONF：可以出现在http里面的upstream配置指令里。
NGX_HTTP_SIF_CONF：可以出现在http里面的server配置指令里的if语句所在的block中。
NGX_HTTP_LMT_CONF：可以出现在http里面的limit_except指令的block中。
NGX_HTTP_LIF_CONF：可以出现在http server块里面的location配置指令里的if语句所在的block中。

2）对set字段
这是一个函数指针，当nginx在解析配置的时候，如果遇到这个配置指令，将会把读取到的值传递给这个函数进行分解处理。因为具体每个配置指令的值如何处理，只有定义这个配置指令的人是最清楚的。
函数原型：

// 处理成功时，返回NGX_OK，否则返回NGX_CONF_ERROR或者是一个自定义的错误信息的字符串。
/* cf: 该参数里面保存从配置文件读取到的原始字符串以及相关的一些信息。特别注意的是这个参数的args字段是一个ngx_str_t
类型的数组，该数组的首个元素是这个配置指令本身，第二个元素是指令的第一个参数，第三个元素是第二个参数，依次类推。*/
/* cmd:  这个配置指令对应的ngx_command_t结构。*/
/* conf: 就是定义的存储这个配置值的结构体，用户在处理的时候可以使用类型转换，转换成自己知道的类型，再进行字段的赋值。*/
char *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);

为了更加方便的实现对配置指令参数的读取，nginx已经默认提供了对一些标准类型的参数进行读取的函数，可以直接赋值给set字段使用。
下面列出这些已经实现的set类型函数：

ngx_conf_set_flag_slot：读取NGX_CONF_FLAG类型的参数。
ngx_conf_set_str_slot：读取字符串类型的参数。
ngx_conf_set_str_array_slot：读取字符串数组类型的参数。
ngx_conf_set_keyval_slot：读取键值对类型的参数。
ngx_conf_set_num_slot：读取整数类型(有符号整数ngx_int_t)的参数。
ngx_conf_set_size_slot：读取size_t类型的参数，也就是无符号数。
ngx_conf_set_off_slot：读取off_t类型的参数。
ngx_conf_set_msec_slot： 读取毫秒值类型的参数。
ngx_conf_set_sec_slot：读取秒值类型的参数。
ngx_conf_set_bufs_slot：读取的参数值是2个，一个是buf的个数，一个是buf的大小。例如： output_buffers 1 128k;
ngx_conf_set_enum_slot：读取枚举类型的参数，将其转换成整数ngx_uint_t类型。
ngx_conf_set_bitmask_slot：读取参数的值，并将这些参数的值以bit位的形式存储。例如：HttpDavModule模块的dav_methods指令。

一个模块配置的demo

static ngx_command_t ngx_http_hello_commands[] = {{ngx_string("hello_string"),NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS|NGX_CONF_TAKE1,ngx_http_hello_string,NGX_HTTP_LOC_CONF_OFFSET,offsetof(ngx_http_hello_loc_conf_t, hello_string),NULL },ngx_null_command	// 每个模块配置后必不可少的  // 它的原型是 #define ngx_null_command  { ngx_null_string, 0, NULL, 0, 0, NULL }
};

我们定义的配置指令，一个叫hello_string可以接收一个或零个参数，可以出现在http server块里面的location配置指令里。该配置的处理函数是ngx_http_hello_string。该配置作用域在NGX_HTTP_LOC_CONF_OFFSET(location中)。该配置信息保存在自定义结构体ngx_http_hello_loc_conf_t 的hello_string字段。

简单模块配置的案例演示

  1. 首先我们在src/core/nginx.c文件中找到ngx_core_commands数组。

  2. 在该数组中添加一条自定义配置。
    在这里插入图片描述

  3. 实现处理函数ngx_conf_my_handler(这个函数名是自己起的)。
    在这里插入图片描述

  4. 重新编译install。

  5. 在nginx.conf配置文件中加上自定义的配置。
    在这里插入图片描述

  6. 测试：./nginx -t
    在这里插入图片描述

模块上下文结构

这是一个ngx_http_module_t类型的静态变量。这个变量实际上是提供一组回调函数指针，这些函数有在创建存储配置信息的对象的函数，也有在创建前和创建后会调用的函数。

ngx_http_module_t结构原型：

typedef struct {ngx_int_t   (*preconfiguration)(ngx_conf_t *cf);	// 在创建和读取该模块的配置信息之前被调用。ngx_int_t   (*postconfiguration)(ngx_conf_t *cf);	// 在创建和读取该模块的配置信息之后被调用。void   *(*create_main_conf)(ngx_conf_t *cf);	/* 调用该函数创建本模块位于http block的配置信息存储结构。该函数成功的时候，返回创建的配置对象。失败的话，返回NULL。*/char   *(*init_main_conf)(ngx_conf_t *cf, void *conf);	/* 调用该函数初始化本模块位于http block的配置信息存储结构。该函数成功的时候，返回NGX_CONF_OK。失败的话，返回NGX_CONF_ERROR或错误字符串。*/void       *(*create_srv_conf)(ngx_conf_t *cf);		/* 调用该函数创建本模块位于http server block的配置信息存储结构，每个server block会创建一个。该函数成功的时候，返回创建的配置对象。失败的话，返回NULL。*/char       *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf);	/* 因为有些配置指令既可以出现在http block，也可以出现在http server block中。那么遇到这种情况，每个server都会有自己存储结构来存储该server的配置，但是在这种情况下http block中的配置与server block中的配置信息发生冲突的时候，就需要调用此函数进行合并，该函数并非必须提供，当预计到绝对不会发生需要合并的情况的时候，就无需提供。当然为了安全起见还是建议提供。该函数执行成功的时候，返回NGX_CONF_OK。失败的话，返回NGX_CONF_ERROR或错误字符串。*/void       *(*create_loc_conf)(ngx_conf_t *cf);	/* 调用该函数创建本模块位于location block的配置信息存储结构。每个在配置中指明的location创建一个。该函数执行成功，返回创建的配置对象。失败的话，返回NULL。*/char       *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf);	/* 与merge_srv_conf类似，这个也是进行配置值合并的地方。该函数成功的时候，返回NGX_CONF_OK。失败的话，返回NGX_CONF_ERROR或错误字符串。*/
} ngx_http_module_t;

Nginx里面的配置信息都是上下一层层的嵌套的，对于具体某个location的话，对于同一个配置，如果当前层次没有定义，那
么就使用上层的配置，否则使用当前层次的配置。
这些配置信息一般默认都应该设为一个未初始化的值，针对这个需求，Nginx定义了一系列的宏定义来代表各种配置所对应
数据类型的未初始化值，如下：

#define NGX_CONF_UNSET       -1
#define NGX_CONF_UNSET_UINT  (ngx_uint_t) -1
#define NGX_CONF_UNSET_PTR   (void *) -1
#define NGX_CONF_UNSET_SIZE  (size_t) -1
#define NGX_CONF_UNSET_MSEC  (ngx_msec_t) -1

模块的定义

对于开发一个模块来说，我们都需要定义一个ngx_module_t类型的变量来说明这个模块本身的信息，从某种意义上来说，这是这个模块最重要的一个信息，它告诉了nginx这个模块的一些信息，上面定义的配置信息，还有模块上下文信息，都是通过这个结构来告诉nginx系统的，也就是加载模块的上层代码，都需要通过定义的这个结构，来获取这些信息。

ngx_module_t 原型：

typedef struct ngx_module_s          ngx_module_t;
struct ngx_module_s {ngx_uint_t            ctx_index;ngx_uint_t            index;char                 *name;ngx_uint_t            spare0;ngx_uint_t            spare1;ngx_uint_t            version;const char           *signature;void                 *ctx;ngx_command_t        *commands;ngx_uint_t            type;ngx_int_t           (*init_master)(ngx_log_t *log);ngx_int_t           (*init_module)(ngx_cycle_t *cycle);ngx_int_t           (*init_process)(ngx_cycle_t *cycle);ngx_int_t           (*init_thread)(ngx_cycle_t *cycle);void                (*exit_thread)(ngx_cycle_t *cycle);void                (*exit_process)(ngx_cycle_t *cycle);void                (*exit_master)(ngx_cycle_t *cycle);uintptr_t             spare_hook0;uintptr_t             spare_hook1;uintptr_t             spare_hook2;uintptr_t             spare_hook3;uintptr_t             spare_hook4;uintptr_t             spare_hook5;uintptr_t             spare_hook6;uintptr_t             spare_hook7;
};

模块可以提供一些回调函数给nginx，当nginx在创建进程线程或者结束进程线程时进行调用。但大多数模块在这些时刻并不需要做什么，所以都简单赋值为NULL。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/164698.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

使用注解的AOP编程

使用注解的AOP编程

使用注解的AOP编程 当注解没有参数时 当使用注解进行面向切面编程（AOP）时，你可以按照以下步骤来实现： 步骤： 1. 创建自定义注解： 首先，创建自定义的注解，以便在代码中标记需要进…
阅读更多...
Excel换不了行怎么解决？

Excel换不了行怎么解决？

方法一: 使用Alt Enter键 在Excel中，输入文字时按下回车键，光标将会移到下一个单元格，如果想要换行，可以尝试使用Alt Enter键。具体操作如下: 1.在单元格中输入文字; 2.想要换行时，在需要换行的位置按下Alt Enter键; 3…
阅读更多...
延时任务定时发布，基于 Redis 与 DB 实现

延时任务定时发布，基于 Redis 与 DB 实现

目录 1、什么是延时任务，分别可以使用哪些技术实现？ 1.2 使用 Redis 和 DB 相结合的思路图以及分析 2、实现添加任务、删除任务、拉取任务 3、实现未来数据的定时更新 4、将数据库中的任务数据，同步到 Redis 中 1、什么是延时任务&#xff…
阅读更多...
网络运维与网络安全 学习笔记2023.11.23

网络运维与网络安全 学习笔记2023.11.23

网络运维与网络安全 学习笔记 第二十四天 今日目标 VRRP负载均衡、BFD原理与配置、BFD典型应用 DHCP工作原理、全局模式DHCP VRRP负载均衡 VRRP单组缺陷 每网段存在一个VRRP组，缺点如下： 主网关数据转发压力大 备份网关不转发任何数据 网络设备利用…
阅读更多...
Hook技术（钩子技术）

Hook技术（钩子技术）

HOOK（钩子技术） 这里的hook我理解的意思就是通过拦截指令，将指令换成自己想要的指令，从而做道绕过原本的程序指令，要修改这个指令，要用汇编技术，从二进制入手。 扩展： 木马病毒之…
阅读更多...
git clone慢的解决办法

git clone慢的解决办法

在网站 https://www.ipaddress.com/ 分别搜索： github.global.ssl.fastly.net github.com 得到ip： 打开hosts文件 sudo vim /etc/hosts 在hosts文件末尾添加 140.82.114.3 github.com 151.101.1.194 github.global-ssl.fastly.net 151.101.65.194 g…
阅读更多...
外部网关协议_边界网关协议BGP

外部网关协议_边界网关协议BGP

一.边界网关协议BGP的基本概念 边界网关协议(Border Gateway Protocol，BGP）属于外部网关协议EGP这个类别，用于自治系统AS之间的路由选择协议。由于在不同AS内度量路由的“代价”(距离、带宽、费用等）可能不同，因此对于…
阅读更多...
elasticsearch 7安装

elasticsearch 7安装

问题提前报 max virtual memory areas error max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144] 如果您的环境是Linux，注意要做以下操作，否则es可能会启动失败 1 用编辑工具打开文件/etc/sysctl.conf 2 …
阅读更多...
qml渲染引擎介绍

qml渲染引擎介绍

qml项目启动入口 Qt Quick项目qml脚本在C++代码里启动，main.cpp如下： #include <QGuiApplication> #include <QQmlApplicationEngine>int main(int argc, char *argv[]) {
阅读更多...
VUE excel表格导出

VUE excel表格导出

js代码 //下载模板 downloadExl() { // 标题 const tHeader [‘xxx’,xxx,xx名称,电枪xx,协议xx,snxx]; // key const filterVal [agentName, stationName, equName, channelNumber, manufacturer, sn, ]; // 值 const datas [ { agentName: 你好, stationName: 我们, e…
阅读更多...
激光雷达与惯导标定 | Lidar_IMU_Init ： 编译

激光雷达与惯导标定 | Lidar_IMU_Init ： 编译

激光雷达与惯导标定&#xff1a;Lidar_IMU_Init 编译 功能包安装安装ceres-solver-2.0.0 &#xff08;注意安装2.2.0不行&#xff0c;必须要安装2.0.0&#xff09; LI-Init是一种鲁棒、实时的激光雷达惯性系统初始化方法。该方法可校准激光雷达与IMU之间的时间偏移量和外部参数…
阅读更多...
unity shaderGraph实例-可交互瀑布

unity shaderGraph实例-可交互瀑布

不要问我水在哪里&#xff0c;你自己相像这是一个瀑布&#xff0c;瀑布的效果我还不会做 效果展示 整体结构 这里片元着色器最后输出的baseColor应该是黑色&#xff0c;白色为错误。 各区域内容 区域1 计算球到瀑布的距离&#xff0c;然后减去一个值&#xff0c;实现黑色区域…
阅读更多...
UNETR：用于三维医学图像分割的Transformer

UNETR：用于三维医学图像分割的Transformer

论文链接&#xff1a;https://arxiv.org/abs/2103.10504 代码链接&#xff1a; https://monai.io/research/unetr 机构&#xff1a;Vanderbilt University, NVIDIA 最近琢磨不出来怎么把3d体数据和文本在cnn中融合&#xff0c;因为确实存在在2d里面用的transformer用在3d里面…
阅读更多...
wpf使用CefSharp.OffScreen模拟网页登录，并获取身份cookie，C#后台执行js

wpf使用CefSharp.OffScreen模拟网页登录，并获取身份cookie，C#后台执行js

目录 框架信息&#xff1a;MainWindow.xamlMainWindow.xaml.cs爬取逻辑模拟登录拦截请求Cookie获取 CookieVisitorHandle 框架信息&#xff1a; CefSharp.OffScreen.NETCore 119.1.20 MainWindow.xaml <Window x:Class"Wpf_CHZC_Img_Identy_ApiDataGet.MainWindow&qu…
阅读更多...
API自动化测试：如何构建高效的测试流程

API自动化测试：如何构建高效的测试流程

一、引言 在当前的软件开发环境中&#xff0c;API&#xff08;Application Programming Interface&#xff09;扮演了极为重要的角色&#xff0c;连接着应用的各个部分。对API进行自动化测试能够提高测试效率&#xff0c;降低错误&#xff0c;确保软件产品的质量。本文将通过实…
阅读更多...
SpringMVC（三）

SpringMVC（三）

十、拦截器 1、拦截器的配置 SpringMVC中的拦截器用于拦截控制器方法的执行 SpringMVC中的拦截器需要实现HandlerInterceptor SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置&#xff1a; <bean class"com.atguigu.interceptor.FirstInterceptor">…
阅读更多...
constexpt

constexpt

constexpt constexpt是C11引入的新的关键字&#xff0c;它用于在编译时而非运行时计算函数或变量的值。这个特性对于提高程序效率和优化代非常有用。 编译时常量和运行时常量 编译时常量&#xff08;Compile-time Constants&#xff09;和运行时常量&#xff08;Runtime Con…
阅读更多...
8年经验之谈 —— 如何使用自动化工具编写测试用例？

8年经验之谈 —— 如何使用自动化工具编写测试用例？

以下为作者观点&#xff0c;仅供参考&#xff1a; 在快速变化的软件开发领域&#xff0c;保证应用程序的可靠性和质量至关重要。随着应用程序复杂性和规模的不断增加&#xff0c;仅手动测试无法满足行业需求。 这就是测试自动化发挥作用的地方&#xff0c;它使软件测试人员能…
阅读更多...
leetcode做题笔记1410. HTML 实体解析器

leetcode做题笔记1410. HTML 实体解析器

「HTML 实体解析器」 是一种特殊的解析器&#xff0c;它将 HTML 代码作为输入&#xff0c;并用字符本身替换掉所有这些特殊的字符实体。 HTML 里这些特殊字符和它们对应的字符实体包括&#xff1a; 双引号&#xff1a;字符实体为 &quot; &#xff0c;对应的字符是 "…
阅读更多...
python appium 官网下载

python appium 官网下载

找了半天吐了 https://github.com/appium/appium-desktop/releases/tag/v1.22.3-4
阅读更多...
最新文章

Copyright @ 2022~2023