Nginx的请求上下文

Nginx 的配置项

nginx 在每一个 http 块，server 块，location 块下，都会生成独立的数据结构用来存放配置项

使用 Http 配置

• 处理 http 配置项的基本流程：
  • 创建数据结构，存储配置项参数
  • 设定 nginx.conf 中配置项的限制条件与回掉方法
  • 实现上一步中的回掉函数，或者使用预设的 14 种方法
  • 合并不同级别的配置块中出现的同名配置项

分配用于保存配置参数的数据结构

• 数据结构可以根据自己的项目的需求进行定义，nginx 有 14 种预设配置项，设计了如下数据结构：

  typedef struct { 
  ngx_str_t my_str; 
  ngx_int_t my_num; 
  ngx_flag_t my_flag; 
  size_t my_size; 
  ngx_array_t * my_str_array; 
  ngx_array_t * my_keyval; 
  off_t my_off; 
  ngx_msec_t my_msec; 
  time_t my_sec; 
  ngx_bufs_t my_bufs; 
  ngx_uint_t my_enum_seq; 
  ngx_uint_t my_bitmask; 
  ngx_uint_t my_access; 
  ngx_path_t * my_path; 
  } ngx_http_mytest_conf_t;

• nginx 设计在 HTTP 框架解析 nginx.conf 文件的时候，只要遇到 http{}, server{}, location{} 配置块，就会立即分配一个结构体用来存储配置参数，进程中可能会有多个这样的配置实例存在，因而，需要定义上述这个结构体，便于参数管理。通过 ngx_http_module_t 中所定义的回调方法，我们可以操作 这个结构体。
  • 当框架遇到 http{} 的时候，调用 HTTP 模块可能实现的 create_main_conf, create_srv_conf, create_loc_conf 生成存储 main 级别配置参数的结构体
  • 同理，遇到 server{} 的时候，调用 create_srv_conf, create_loc_conf 生成存储 srv 级别配置参数的结构体
  • 遇到 location{}时，调用 create_loc_conf 生成 loc 级别配置参数的存储结构
• 一般普通的 HTTP 模块往往只实现 create_loc_conf 回调方法，因为，他们一般只关心匹配某种 URL 的请求
  

   

设定配置项的解析方式

nginx 中，配置项主要通过 ngx_command_t 结构进行解析。

 

• 关于 type 的设置具体可以参考官方文档：https://www.nginx.com/resources/wiki/extending/api/configuration/?highlight=ngx_command_t#

• set 回调方法，是用来处理 nginx.conf 中的配置项的，这部分可以使用 14 种预设的方法
• conf，用来指示配置项所处内存的相对偏移位置。
  • 因为，HTTP 模块中可能定义了 3 个结构体，用来存储 main，srv，loc 级别的配置项（对应 create_main_conf, create_srv_conf, create_loc_conf）, 这里使用 conf 用来指明，将解析出来的配置项的值存放到哪个结构体中
  • 对 conf 的设置是与 ngx_http_module_t 实现的回调方法相关的。
  • 功能较为简单的 HTTP 模块都只实现了 create_loc_conf 的回调方法，对于 http{}, server{} 块内出现的同名配置项，都是并入到某个 location{} 内 create_loc_conf 方法所产生的结构体中的。如果希望，在 HTTP 模块中的代码保存到不同的变量中，就需要实现 create_mian_conf, create_srv_conf
• offset, 用来表明当前配置项在整个存储配置项的结构体中的偏移位置，可以借助 offsetof 宏实现这个计算的过程
• post，配置项处理后的后续方法。

自定义配置项处理方法

• 首先自定义存储结构体
• 编写 set 方法

  static char * ngx_conf_set_myconfig(ngx_conf_t * cf, ngx_command_t * cmd, void * conf);

• 其中，conf 指代的就是我们自定义的存储结构体 然后通过，cf->args->elfs 获取参数队列

  static char* ngx_conf_set_myconfig(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  {
    // 注意，参数 conf 就是 http 框架传给我们的，在 ngx_http_mytest_create_loc_conf
  // 回调方法中分配的结构体 ngx_http_mytest_conf_t
    ngx_http_mytest_conf_t  *mycf = conf;
  
    // cf->args 是 1 个 ngx_array_t 队列，它的成员都是 ngx_str_t 结构。// 我们用 value 指向 ngx_array_t 的 elts 内容，其中 value[1]就是第 1
  // 个参数，同理 value[2]是第 2 个参数
    ngx_str_t* value = cf->args->elts;
  
    //ngx_array_t 的 nelts 表示参数的个数
    if (cf->args->nelts > 1)
    {
        // 直接赋值即可，ngx_str_t 结构只是指针的传递
        mycf->my_config_str = value[1];
    }
    if (cf->args->nelts > 2)
    {
        // 将字符串形式的第 2 个参数转为整型
        mycf->my_config_num = ngx_atoi(value[2].data, value[2].len);
        // 如果字符串转化整型失败，将报 "invalid number" 错误，//nginx 启动失败
        if (mycf->my_config_num == NGX_ERROR)
        {return "invalid number";}
    }
  
    // 返回成功
    return NGX_CONF_OK;
  }

合并配置项

如果 http{}, server{}, location{} 下面都出现了同名的配置项，根据 merge_loc_conf（merge_srv_conf）进行合并，如果他们被设置为 null，忽略上一级中的同名配置项

// cf 表示全局配置的设置，prev 表示父级配置结构体，void * conf 为当前配置结构体
char * (*merge_loc_conf)(ngx_conf_t * cf, void * prev, void * conf)

HTTP 配置模型

• 当 nginx 检测到 http{} 关键配置的时候，HTTP 配置模型启动，首先建立一个 ngx_http_conf_ctx_t 的上下文结构

  typedef struct {
    void ** main_conf;
    void ** srv_conf;
    void ** loc_conf; // 指针数组，数组的每个元素指向相应 HTTP 模块 的 create_loc_conf 方法产生的结构体的地址
  } ngx_http_conf_ctx_t;

  HTTP 框架为所有的 HTTP 模块建立 3 个数组，分别存放 create_main_conf, create_srv_conf, create_loc_conf 方法所返回的地址指针。即ngx_http_conf_ctx_t 结构保存了所有 HTTP 模块的配置数据结构的入口。

解析 HTTP 配置的流程

• 对于每一个 server 块，location 块，http 块 都会建立一个相应的 ngx_http_conf_ctx_t 的结构

 

HTTP 配置模型的内存结构

 

 

• 通过上面的图，我们可以知道，nginx.conf 中 http{}, server{}, location{} 的总个数 与 调用 create_loc_conf 方法的次数相同；而 http{}, server{} 的总个数 与 调用 create_srv_conf 方法的次数相同。而这些方法每被调用一次就生成一个结构体。（便于解决同名配置项的合并问题）。
• 调用 merge_srv_conf, 和 merge_loc_conf 进行配置项合并

预设配置项处理方法的工作原理

• 通过 使用 cf->args->elts 直接获取配置参数
• nginx 配置项解析模块在调用 ngx_command_t 结构体的 set 方法的时候，会同时把 offset 编译传递进来。由此，可以正确识别需要解析的配置项的存储位置

error 日志

• 可以使用 ngx_log_error / ngx_log_debug 进行日志记录

  请求上下文

• 在一个请求的处理过程中，用类似 struct 这样的结构体把一些关键的信息保存起来的结构体，称为上下文上下文是针对一个请求 一个模块而言的，因而他是低耦合的
• 使用方法：
  • 两个宏：
    • ngx_http_get_module_ctx
    • ngx_http_set_ctx
  • 一般的调用方式是：
    

     

    可以看到这里先设置了上下文，然后后面就可以获取它并进行使用

  • HTTP 框架维护上下文结构的方式
    • 类似于 ngx_http_conf_ctx_t 的 3 个数组成员，HTTP 框架 使用 ctx 数组 保存所有 HTTP 模块上下文结构体的指针

      struct ngx_http_request_s {
      ...
      void ** ctx;
      ...
      }

    • ngx_http_get_module_ctx 和 ngx_http_set_ctx 的原理就是去获取或设置 ctx 数组中相应的 HTTP 模块的指针