nginx http子產品配置合并

在配置nginx.conf檔案的時候，我們很容易發現，有部配置設定置項是既可以配置在http塊，也可以配置在server塊，還可以配置在location塊中。但是并不是所有的配置項都可以在任意位置進行配置的，根據配置項所起到的作用，nginx對各個配置塊所能使用的位置進行了定義。既然一個配置項可以配置在多個配置塊中，那麼這裡就涉及到一個問題就是，在處理請求的時候是以哪一個配置項為準。本文主要講解nginx是如何實作配置項的合并的。

在前面的文章中，我們講解了nginx http子產品的基本存儲結構，在閱讀本文之前強烈建議讀者朋友先閱讀這篇文章。如下是nginx http子產品的存儲結構示意圖：

這裡我們不再贅述nginx是如何解析各個配置項，進而形成這樣的一個存儲結構的。nginx對配置項的合并主要是通過ngx_http_merge_servers()方法進行的，如下是該方法的源碼：

* @param cf 整個nginx運作的ngx_conf_t對象
 * @param cmcf 核心子產品對應的配置對象
 * @param module 外層周遊時，目前周遊的子產品
 * @param ctx_index 外層周遊時，目前周遊的子產品的配置對應的存儲位置
 */
static char * ngx_http_merge_servers(ngx_conf_t *cf, ngx_http_core_main_conf_t *cmcf,
                       ngx_http_module_t *module, ngx_uint_t ctx_index) {
  char *rv;
  ngx_uint_t s;
  ngx_http_conf_ctx_t *ctx, saved;
  ngx_http_core_loc_conf_t *clcf;
  ngx_http_core_srv_conf_t **cscfp;

  // 這裡擷取所有server配置塊對應的ngx_http_core_srv_conf_t結構體，每個結構體都對應了配置檔案中
  // 一個server塊的配置
  cscfp = cmcf->servers.elts;
  // 這裡的cf->ctx就是解析http配置塊得到的ngx_http_conf_ctx_t結構體，需要注意的是，其中隻有main_conf
  // 對應的數組資料有意義，因為http塊的資料隻存儲在main_conf中
  ctx = (ngx_http_conf_ctx_t *) cf->ctx;
  // 這裡需要注意的是，在執行saved=*ctx;之後，會将目前*ctx的結構體對象完全複制而得到一個新的，進而存儲到
  // saved中，也就是說ctx和&saved的值是不一樣的。在下面的for循環中會執行
  // ctx->srv_conf = cscfp[s]->ctx->srv_conf;語句，這裡其實改變
  // 的是ctx指針所指向的結構體對象的srv_conf屬性的值，而并沒有影響到saved->srv_conf屬性值，
  // 因為saved和*ctx是兩個各個屬性值雖然相同，但是本身并不同的結構體對象。
  saved = *ctx;
  rv = NGX_CONF_OK;

  for (s = 0; s < cmcf->servers.nelts; s++) {

    /* merge the server{}s' srv_conf's */

    ctx->srv_conf = cscfp[s]->ctx->srv_conf;

    if (module->merge_srv_conf) {
      // 這裡主要是進行配置的合并，saved.srv_conf[ctx_index]指向的是http塊中解析出的SRV類型的配置，
      // cscfp[s]->ctx->srv_conf[ctx_index]解析的則是目前server塊中的配置，合并的一般規則是通過對應
      // 子產品實作的merge_srv_conf()來進行的，具體将會使用http塊中的配置，還是使用server塊中的配置，
      // 或者說合并兩者，則是由具體的實作來決定的。這裡合并的效果本質上就是對
      // cscfp[s]->ctx->srv_conf[ctx_index]中的屬性指派，如果該值不存在，則将http塊對應的值寫到
      // 該屬性中
      rv = module->merge_srv_conf(cf, saved.srv_conf[ctx_index], 
                                  cscfp[s]->ctx->srv_conf[ctx_index]);
      if (rv != NGX_CONF_OK) {
        goto failed;
      }
    }

    if (module->merge_loc_conf) {
      ctx->loc_conf = cscfp[s]->ctx->loc_conf;

      // 需要注意的是，這裡合并的主要是http塊和目前server塊中對應的LOC類型的配置資料，此時并沒有開始
      // 合并server塊下的各個location配置
      rv = module->merge_loc_conf(cf, saved.loc_conf[ctx_index], 
                                  cscfp[s]->ctx->loc_conf[ctx_index]);
      if (rv != NGX_CONF_OK) {
        goto failed;
      }

      clcf = cscfp[s]->ctx->loc_conf[ngx_http_core_module.ctx_index];

      // 這裡clcf->locations存儲了目前server塊下的所有location塊的配置，而cscfp[s]->ctx->loc_conf
      // 則指向的是将http塊和server塊合并之後的配置資料，從這裡就可以看出，目前方法的結果就是合并了
      // http塊、server塊和location塊的配置
      rv = ngx_http_merge_locations(cf, clcf->locations, cscfp[s]->ctx->loc_conf, 
                                    module, ctx_index);
      if (rv != NGX_CONF_OK) {
        goto failed;
      }
    }
  }

  failed:

  *ctx = saved;

  return rv;
}           

這裡ngx_http_merge_servers()方法主要完成了如下幾個工作：

1、調用目前子產品的merge_srv_conf()方法将http配置塊和server配置塊中NGX_HTTP_SRV_CONF_OFFSET類型的配置項進行合并，也即将http配置塊結構體中的srv_conf數組與server配置塊結構體中的srv_conf數組進行合并，如此就完成了NGX_HTTP_SRV_CONF_OFFSET類型配置項的合并；

2、調用目前子產品的merge_loc_conf()方法将http配置塊和server配置塊中NGX_HTTP_LOC_CONF_OFFSET類型的配置項進行合并，也即将http配置塊結構體中的loc_conf數組與server配置塊結構體中的loc_conf數組進行合并。不過不同于NGX_HTTP_SRV_CONF_OFFSET類型的配置項，NGX_HTTP_LOC_CONF_OFFSET類型的配置項是還可以配置在location配置塊中的，因而還需要将合并的結果與location配置塊中的配置項進行合并；

3、調用ngx_http_merge_locations()方法将前一步http配置塊與server配置塊合并的NGX_HTTP_LOC_CONF_OFFSET類型的配置項繼續與location配置塊中的配置項進行合并，進而得到最終合并結果。不過這裡需要注意的一點是，location配置塊中還可以繼續配置配置子location配置塊，如此不斷往複下去，而這裡的ngx_http_merge_locations()方法則可以用于遞歸調用，以便于進行子location的合并。

這裡我們繼續看ngx_http_merge_locations()方法是如何合并子location的：

* 合并location塊的配置
 *
 * @param cf 指向目前http塊的配置結構體ngx_http_conf_ctx_t
 * @param locations 目前server塊下所有的location塊的配置
 * @param loc_conf
 * @param module
 * @param ctx_index
 * @return
 */
static char * ngx_http_merge_locations(ngx_conf_t *cf, ngx_queue_t *locations, void **loc_conf,
    ngx_http_module_t *module, ngx_uint_t ctx_index) {
  char *rv;
  ngx_queue_t *q;
  ngx_http_conf_ctx_t *ctx, saved;
  ngx_http_core_loc_conf_t *clcf;
  ngx_http_location_queue_t *lq;

  if (locations == NULL) {
    return NGX_CONF_OK;
  }

  ctx = (ngx_http_conf_ctx_t *) cf->ctx;
  saved = *ctx;

  for (q = ngx_queue_head(locations);
       q != ngx_queue_sentinel(locations);
       q = ngx_queue_next(q)) {
    lq = (ngx_http_location_queue_t *) q;

    clcf = lq->exact ? lq->exact : lq->inclusive;
    ctx->loc_conf = clcf->loc_conf;

    // 合并location塊的配置，這裡的loc_conf[ctx_index]存儲的是http塊與server塊配置合并的資料，
    // 而clcf->loc_conf則是目前server塊下的某個location塊的資料，這裡其實就是将目前loc_conf中的
    // 資料合并到clcf->loc_conf中
    rv = module->merge_loc_conf(cf, loc_conf[ctx_index], clcf->loc_conf[ctx_index]);
    if (rv != NGX_CONF_OK) {
      return rv;
    }

    // 由于location塊中還可以配置子location塊，因而這裡會遞歸的進行合并
    rv = ngx_http_merge_locations(cf, clcf->locations, clcf->loc_conf, module, ctx_index);
    if (rv != NGX_CONF_OK) {
      return rv;
    }
  }

  *ctx = saved;

  return NGX_CONF_OK;
}           

這裡對location以及子location的合并過程其實比較簡單，就是依次彈出目前配置塊（server或者父location）下的各個子location，然後調用目前子產品的merge_loc_conf()方法将目前配置塊的配置與彈出的子location進行合并。在合并完成後，繼續對該子location進行遞歸的合并，也即将該子location與其子location進行合并。如此不斷往複下去，直到所有的location都被合并完成。

nginx的配置項合并是一個比較重要的功能，比如某個既可以在http塊中也可以在server塊中配置的配置項，如果nginx.conf中僅僅隻是配置了http塊中的配置，那麼所有的server塊的配置就都可以繼承http塊的配置，但如果其中某個server自身也進行了該配置項的配置，那麼進行合并的時候該配置項就可以直接使用其自身的配置，而不需要繼承http配置塊的配置，如此就可以實作非常靈活的功能。

文章來源：

https://my.oschina.net/zhangxufeng/blog/3173782

相關内容推薦：

https://www.roncoo.com/view/1211250285484212225