深度解析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_uint_t offset;
void post;
};

解析:

1）ngx_str_t name

其中，name是配置项名称，

2）ngx_uint_t type

其中，type决定这个配置项可以在哪些块（如http、server、location、if、upstream块等） 中出现，以及可以携带的参数类型和个数等。表4-1列出了设置http配置项时type可以取的 值。注意，type可以同时取表4-1中的多个值，各值之间用|符号连接.附录1可见

3）关于set回调方法。

如果处理配置项，我们既可以自己实现一个回调方法来处理配置项，也可以使用Nginx预设的14个解析配置项方法，这会少写许 多代码，附录二

4）ngx_uint_t conf conf

用于指示配置项所处内存的相对偏移位置，仅在type中没有设置 NGX_DIRECT_CONF和NGX_MAIN_CONF时才会生效 

对于HTTP模块，conf是必须要设置 的

为什么HTTP模块一定要设置conf的值呢？因为HTTP框架可以使用预设的14种方法自动 地将解析出的配置项写入HTTP模块代码定义的结构体中，但HTTP模块中可能会定义3个结 构体，分别用于存储main、srv、loc级别的配置项（对应于create_main_conf、 create_srv_conf、create_loc_conf方法创建的结构体），而HTTP框架自动解析时需要知道应把 解析出的配置项值写入哪个结构体中，这将由conf成员完成 因此，对conf的设置是与ngx_http_module_t实现的回调方法（在4.2.1节中介绍）相关的。 如果用于存储这个配置项的数据结构是由create_main_conf回调方法完成的，那么必须把conf 设置为NGX_HTTP_MAIN_CONF_OFFSET。同样，如果这个配置项所属的数据结构是由 create_srv_conf回调方法完成的，那么必须把conf设置为NGX_HTTP_SRV_CONF_OFFSET。 可如果create_loc_conf负责生成存储这个配置项的数据结构，就得将conf设置为 NGX_HTTP_LOC_CONF_OFFSET。

5）ngx_uint_t offset offset

表示当前配置项在整个存储配置项的结构体中的偏移位置（以字节（Byte）为单 位）

例子：

typedef struct { int a; int b; int c; } test_stru;

 如果要处理的配置项是由成员b来存储参数的，那么这时b相对于test_stru的偏移量就是 4；如果要处理的配置项由成员c来存储参数，那么这时c相对于test_stru的偏移量就是8设置offset有什么作用呢？如果使用Nginx预设的解析配置项方法，就必须设置offset，这 样Nginx首先通过conf成员找到应该用哪个结构体来存放，然后通过offset成员找到这个结构 体中的相应成员，以便存放该配置

6）void*post

如果自定义了配置项的回调方法，那么post指针的用途完全由用户来定义。如果不使用 它，那么随意设为NULL即可。如果想将一些数据结构或者方法的指针传过来，那么使用post 也可以。 如果使用Nginx预设的配置项解析方法，就需要根据这些预设方法来决定post的使用方式

附录一

note1

每个进程中都有一个唯一的ngx_cycle_t核心结构体，它有一个成员conf_ctx维护着所有模块的配置结构体，其类型是void****。conf_ctx意义为首先指向一个成员皆为指针的数组， 其中每个成员指针又指向另外一个成员皆为指针的数组，第2个子数组中的成员指针才会指 向各模块生成的配置结构体。这正是为了事件模块、http模块、mail模块而设计的。这有利于不同NGX_CORE_MODULE类型的特定模块解析配置项。然而， NGX_CORE_MODULE类型的核心模块解析配置项时，配置项一定是全局的，不会从属于 任何{}配置块的，它不需要上述这种双数组设计。解析标识为NGX_DIRECT_CONF类型的 配置项时，会把void****类型的conf_ctx强制转换为void**，也就是说，此时，在conf_ctx指向 的指针数组中，每个成员指针不再指向其他数组，直接指向核心模块生成的配置结构体。因 此，NGX_DIRECT_CONF仅由NGX_CORE_MODULE类型的核心模块使用，而且配置项只 应该出现在全局配置 

note2

如果HTTP模块中定义的配置项在nginx.conf配置文件中实际出现的位置和参 数格式与type的意义不符，那么Nginx在启动时会报错。

附录二

附录三

note3：ngx_conf_post_t

typedef char (ngx_conf_post_handler_pt) (ngx_conf_t cf,void data, void *conf);

typedef struct {
ngx_conf_post_handler_pt post_handler;
} ngx_conf_post_t;

如果需要在解析完配置项后回调某个方法，就要实现 上面的ngx_conf_post_handler_pt，并将包含post_handler的ngx_conf_post_t结构体传给post指 针

最后

以上就是碧蓝冷风为你收集整理的深度解析ngx_command_t结构的全部内容，希望文章能够帮你解决深度解析ngx_command_t结构所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。