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.mfbz.cn/a/182274.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

LeetCode算法心得——爬楼梯（记忆化搜索+dp）

LeetCode算法心得——爬楼梯（记忆化搜索+dp）

大家好，我是晴天学长，第二个记忆化搜索练习，需要的小伙伴可以关注支持一下哦！后续会继续更新的。💪💪💪 1）爬楼梯 假设你正在爬楼梯。需要 n 阶你才能到达楼顶。 每次你可以爬 1 或…
阅读更多...
9.2 Windows驱动开发：内核解析PE结构导出表

9.2 Windows驱动开发：内核解析PE结构导出表

在笔者的上一篇文章《内核特征码扫描PE代码段》中LyShark带大家通过封装好的LySharkToolsUtilKernelBase函数实现了动态获取内核模块基址，并通过ntimage.h头文件中提供的系列函数解析了指定内核模块的PE节表参数，本章将继续延申这个话题，实现…
阅读更多...
Springboot集成swagger之knife4j

Springboot集成swagger之knife4j

knife4j的最终效果&#xff1a; 支持直观的入参介绍、在线调试及离线各种API文档下载。 1 引入pom <dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.2</ver…
阅读更多...
创建maven的web项目

创建maven的web项目

&#xff08;一&#xff09;创建maven的web项目 Step1、创建一个普通的maven项目 &#xff08;1&#xff09;新建一个empty project&#xff0c;命名为SSM2。 点击项目名&#xff0c;右键new&#xff0c;选择Module&#xff0c;左侧选择“Maven archetype”&#xff0c;可以给…
阅读更多...
Py之PyMuPDF：PyMuPDF的简介、安装、使用方法之详细攻略

Py之PyMuPDF：PyMuPDF的简介、安装、使用方法之详细攻略

Py之PyMuPDF&#xff1a;PyMuPDF的简介、安装、使用方法之详细攻略 目录 PyMuPDF的简介 PyMuPDF的安装 PyMuPDF的使用方法 1、基础用法 PyMuPDF的简介 PyMuPDF是一个高性能的Python库&#xff0c;用于PDF(和其他)文档的数据提取&#xff0c;分析&#xff0c;转换和操作。 …
阅读更多...
Matrix

Matrix

Matrix 如下是四种变换对应的控制参数&#xff1a; Rect 常用的一个“绘画相关的工具类”&#xff0c;常用来描述长方形/正方形&#xff0c;他只有4个属性&#xff1a; public int left; public int top; public int right; public int bottom; 这4个属性描述着这一个“方块…
阅读更多...
如何在AD的PCB板做矩形槽孔以及如何倒圆弧角

如何在AD的PCB板做矩形槽孔以及如何倒圆弧角

Altium Designer 22下载安装教程-CSDN博客 如何在AD上创建完整的项目-CSDN博客 开始前&#xff0c;请先安装后AD&#xff0c;并创建好项目。 目录 1. 如何在AD的PCB板做矩形槽孔 2. 如何在AD的PCB板倒圆弧角 1. 如何在AD的PCB板做矩形槽孔 首先&#xff0c;我们进入上面创…
阅读更多...
【Axure教程】用中继器制作卡片多条件搜索效果

【Axure教程】用中继器制作卡片多条件搜索效果

卡片设计通过提供清晰的信息结构、可视化吸引力、易扩展性和强大的交互性&#xff0c;为用户界面设计带来了许多优势&#xff0c;使得用户能够更轻松地浏览、理解和互动。 那今天就教大家如何用中继器制作卡片的模板&#xff0c;以及完成多条件搜索的效果&#xff0c;我们会以…
阅读更多...
思维模型 等待效应

思维模型 等待效应

本系列文章 主要是 分享 思维模型 &#xff0c;涉及各个领域&#xff0c;重在提升认知。越是等待&#xff0c;越是焦虑。 1 等待效应的应用 1.1 等待效应在管理中的应用 西南航空公司是一家美国的航空公司&#xff0c;它在管理中运用了等待效应。西南航空公司鼓励员工在工作中…
阅读更多...
函数与数组

函数与数组

一.函数 1、函数的作用 定义较为复杂的但是需要重复使用的内容&#xff0c;以便再次使用&#xff0c;可以直接调用&#xff0c;节约时间&#xff0c;提高效率。 语句块定义成函数约等于别名&#xff0c;定义函数&#xff0c;再引用函数。 封装的可重复利用的具有特定功能的…
阅读更多...
获取地区天气

获取地区天气

上网找了半天js获取天气的方法&#xff0c;试了好几个都不行&#xff0c;还是得用api才行 1.用的心知天气的api 很简单,注册就能用,调用api需要key,官方网站&#xff1a;https://gaofen.mlogcn.com/documentation/0/00 2.areacode 这个网页里面找 精确到县&#xff1a;https:/…
阅读更多...
Hibernate批量处理数据

Hibernate批量处理数据

概念&#xff1a; 批量处理数据是指在一个事务场景中处理大量数据。 在应用程序中难以避免进行批量操作&#xff0c;Hibernate提供了以下方式进行批量处理数据&#xff1a; (1)使用HQL进行批量操作 数据库层面 executeUpdate() (2)使用JDBC API进行批量操作 数据库层面 …
阅读更多...
王道p149 9.设树B是一棵采用链式结构存储的二叉树，编写一个把树 B中所有结点的左、右子树进行交换的函数。（c语言代码实现）

王道p149 9.设树B是一棵采用链式结构存储的二叉树，编写一个把树 B中所有结点的左、右子树进行交换的函数。（c语言代码实现）

本题代码如下 void swap(tree* t) {if (*t){treenode* temp (*t)->lchild;(*t)->lchild (*t)->rchild;(*t)->rchild temp;swap(&(*t)->lchild);swap(&(*t)->rchild);} } 完整测试代码 #include<stdio.h> #include<stdlib.h> typed…
阅读更多...
python+requests+unittest执行自动化接口测试！

python+requests+unittest执行自动化接口测试！

1、安装requests、xlrd、json、unittest库 <1>pip 命令安装&#xff1a; pip install requests pip install xlrd pip install json pip install unittest <2> pycharm里安装 2、利用Page Object Model 设计理念创建六类Python Package(也可根据项目要求具体实施…
阅读更多...
基于SSM的校园奶茶点单管理系统

基于SSM的校园奶茶点单管理系统

基于SSM的校园奶茶点单管理系统的设计与实现~ 开发语言&#xff1a;Java数据库&#xff1a;MySQL技术&#xff1a;SpringMyBatisSpringMVC工具&#xff1a;IDEA/Ecilpse、Navicat、Maven 系统展示 主页 奶茶列表 登录界面 管理员界面 用户界面 摘要 随着社会的发展和科技的进…
阅读更多...
Python---把函数的返回值作为另外一个函数的参数

Python---把函数的返回值作为另外一个函数的参数

def test1():return 50def test2(num):print(num)# 1. 保存函数test1的返回值 result test1()# 2.将函数返回值所在变量作为参数传递到test2函数 test2(result) # 50
阅读更多...
JavaScript框架 Angular、React、Vue.js 的全栈解决方案比较

JavaScript框架 Angular、React、Vue.js 的全栈解决方案比较

在 Web 开发领域&#xff0c;JavaScript 提供大量技术栈可供选择。其中最典型的三套组合&#xff0c;分别是 MERN、MEAN 和 MEVN。前端框架&#xff08;React、Angular 和 Vue&#xff09;进行简化比较。 MERN 技术栈详解 MERN 技术栈包含四大具体组件&#xff1a; MongoDB&am…
阅读更多...
springMVC上传文件

springMVC上传文件

阅读更多...
读书笔记——《黑猩猩的政治》

读书笔记——《黑猩猩的政治》

前言 弗朗斯德瓦尔&#xff08;Frans de Waal)的代表作《黑猩猩政治》成书于1982年&#xff0c;是它的首部书籍作品&#xff0c;也是美国国会新任议员的被推荐读物。之前看的他另一部作品的《万智有灵》是2016年的作品&#xff0c;时间跨度居然这么大。《万智有灵》介绍了许多…
阅读更多...
2023亚太杯数学建模竞赛C题详细代码解析建模

2023亚太杯数学建模竞赛C题详细代码解析建模

C题&#xff1a;The Development Trend of New Energy Electric Vehicles in China中国谈新能源电动汽车的发展趋势 第一问部分&#xff1a; import numpy as np import pandas as pd import matplotlib.pyplot as plt from sklearn.cluster import KMeans from sklearn.prep…
阅读更多...
最新文章

Copyright @ 2022~2023

友情链接： 我的编程经验分享 一条长河网 尧图网站开发 尧图建网站