nginx學習三 nginx配置項解析詳解及程式碼實現
nginx配置項解析詳解及程式碼實現
0回顧
在上一節，用nginx簡單實現了一個hello world程式：當我們在瀏覽器中輸入lochost/hello ，瀏覽器就返回：hello world。為什麼會這樣呢，簡單一點說就是當我們請求訪問hello這個服務，nginx就會看配置檔案中是否有，如果有，根據具體的handler處理後把處理的結果返回給使用者，沒有就返回not found。
location /hello {
test_hello ;//無引數的配置
這其實是一個簡單的配置。這節我們來看一個複雜的配置檔案解析：
location /myconfig { mystring smile_to_life; mycounter 24; myflag on; mygrage better; mybufs 2 4k; }
這個配置幾乎覆蓋了nginx的基本型別，還有9種類型和這幾種型別很相同，後面我們在詳細講。
先看一下儲存配置引數的結構體：
typedef struct{
ngx_str_t arg_str;
ngx_int_t arg_counter;
ngx_flag_t arg_flag;
ngx_uint_t arg_enum_seq;
ngx_bufs_t arg_bufs;
}ngx_http_myconfig_loc_conf_t;
mystring = smile_to_life, my_counter = 24, myflag = on, mygrage = better, buf.num = 2, buf.size = 4096;
1模組的基本結構
首先讓我們看上一節出現的三個基本的資料結構。
1.1 模組配置指令 nginx_command_t
ngx_command_t的定義，位於src/core/ngx_conf_file.h中。
定義：
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; };
name: 配置指令的名稱。
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中。
set: 這是一個函式指標，當nginx在解析配置的時候，如果遇到這個配置指令，將會把讀取到的值傳遞給這個函式進行分解處理。因為具體每個配置指令的值如何處理，只有定義這個配置指令的人是最清楚的。來看一下這個函式指標要求的函式原型。
char *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void*conf);
先看該函式的返回值，處理成功時，返回NGX_OK，否則返回NGX_CONF_ERROR或者是一個自定義的錯誤資訊的字串。
再看一下這個函式被呼叫的時候，傳入的三個引數。
cf: 該引數裡面儲存從配置檔案讀取到的原始字串以及相關的一些資訊。特別注意的是這個引數的args欄位是一個ngx_str_t型別的陣列，該陣列的首個元素是這個配置指令本身，第二個元素是指令的第一個引數，第三個元素是第二個引數，依次類推。
cmd: 這個配置指令對應的ngx_command_t結構。
conf: 就是定義的儲存這個配置值的結構體，比如在上面展示的那個ngx_http_myconfig_loc_conf_t。當解析這個arg_str變數的時候，傳入的conf就指向一個ngx_http_myconfig_loc_conf_t型別的變數。使用者在處理的時候可以使用型別轉換，轉換成自己知道的型別，再進行欄位的賦值。
為了更加方便的實現對配置指令引數的讀取，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指令。
conf: 該欄位被NGX_HTTP_MODULE型別模組所用 (我們編寫的基本上都是NGX_HTTP_MOUDLE，只有一些nginx核心模組是非NGX_HTTP_MODULE)，該欄位指定當前配置項儲存的記憶體位置。實際上是使用哪個記憶體池的問題。因為http模組對所有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。
offset: 指定該配置項值的精確存放位置，一般指定為某一個結構體變數的欄位偏移。因為對於配置資訊的儲存，一般我們都是定義個結構體來儲存的。那麼比如我們定義了一個結構體A，該項配置的值需要儲存到該結構體的b欄位。那麼在這裡就可以填寫為offsetof(A, b)。對於有些配置項，它的值不需要儲存或者是需要儲存到更為複雜的結構中時，這裡可以設定為0。
post: 該欄位儲存一個指標。可以指向任何一個在讀取配置過程中需要的資料，以便於進行配置讀取的處理。大多數時候，都不需要，所以簡單地設為0即可。
好了，這個結構題我們已經知道，現在來看實現本節的配置指令結構體：
配置檔案：
location /myconfig {
mystring smile_to_life;
mycounter 24;
myflag on;
mygrage better;
mybufs 2 4k;
}
配置檔案的結構體：
typedef struct{
ngx_str_t arg_str;//儲存mystring的值
ngx_int_t arg_counter; //儲存mycounter的值
ngx_flag_t arg_flag; //儲存myflag的值
ngx_uint_t arg_enum_seq; //儲存mygrage的值
ngx_bufs_t arg_bufs;//儲存mybufs的值
}ngx_http_myconfig_loc_conf_t;
static ngx_conf_enum_t test_enums[] = {
{ ngx_string("good"), 1},
{ ngx_string("better"), 2},
{ ngx_string("best"), 3},
{ ngx_null_string, 0}
};
當arg_enum_seq=2時我們會輸出better!
本節配置指令如下：
static ngx_command_t ngx_http_myconfig_commands[] = {
{
ngx_string("mystring"),//配置指令名稱
NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, //配置引數屬性
ngx_http_mystring, //set 函式,具體實現請參看原始碼
NGX_HTTP_LOC_CONF_OFFSET, //該配置在http的local配置中
offsetof(ngx_http_myconfig_loc_conf_t, arg_str),//offsetof(type, member):&(((type*)0)->member)
NULL
},
{
ngx_string("mycounter"),//配置指令名稱
NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1,//配置引數屬性
ngx_http_mycounter,//set 函式,具體實現請參看原始碼
NGX_HTTP_LOC_CONF_OFFSET,//該配置在http的local配置中
offsetof(ngx_http_myconfig_loc_conf_t, arg_counter), //在配置結構體中對應的位置
NULL
},
{
ngx_string("myflag"),
NGX_HTTP_LOC_CONF | NGX_CONF_FLAG | NGX_CONF_TAKE1,//ngx_conf_t 的型別要用NGX_CONF_FLAG
ngx_http_myflag,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_myconfig_loc_conf_t, arg_flag),
NULL
},
{
ngx_string("mygrade"),
NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1,
ngx_http_mygrade,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_myconfig_loc_conf_t, arg_enum_seq),
test_enums //post = test_enums, 引數post指向一個emum型別
},
{
ngx_string("mybufs"),
NGX_HTTP_LOC_CONF | NGX_CONF_TAKE2,//ngx_bufs_t 有兩個資料成員
ngx_http_mybufs,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_myconfig_loc_conf_t, arg_bufs),
NULL
},
ngx_null_command
};1.2 模組上下文 ngx_http_module_t
這是一個ngx_http_module_t型別的靜態變數。這個變數實際上是提供一組回撥函式指標，這些函式有在建立儲存配置資訊的物件的函式，也有在建立前和建立後會呼叫的函式。這些函式都將被nginx在合適的時間進行呼叫。
定義：
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);
char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
void *(*create_srv_conf)(ngx_conf_t *cf);
char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf);
void *(*create_loc_conf)(ngx_conf_t *cf);
char *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf);
} ngx_http_module_t;
preconfiguration:
在建立和讀取該模組的配置資訊之前被呼叫。
postconfiguration:
在建立和讀取該模組的配置資訊之後被呼叫。
create_main_conf:
呼叫該函式建立本模組位於http block的配置資訊儲存結構。該函式成功的時候，返回建立的配置物件。失敗的話，返回NULL。
init_main_conf:
呼叫該函式初始化本模組位於http block的配置資訊儲存結構。該函式成功的時候，返回NGX_CONF_OK。失敗的話，返回NGX_CONF_ERROR或錯誤字串。
create_srv_conf:
呼叫該函式建立本模組位於http server block的配置資訊儲存結構，每個server block會建立一個。該函式成功的時候，返回建立的配置物件。失敗的話，返回NULL。
merge_srv_conf:
因為有些配置指令既可以出現在http block，也可以出現在http server block中。那麼遇到這種情況，每個server都會有自己儲存結構來儲存該server的配置，但是在這種情況下http block中的配置與server block中的配置資訊發生衝突的時候，就需要呼叫此函式進行合併，該函式並非必須提供，當預計到絕對不會發生需要合併的情況的時候，就無需提供。當然為了安全起見還是建議提供。該函式執行成功的時候，返回NGX_CONF_OK。失敗的話，返回NGX_CONF_ERROR或錯誤字串。
create_loc_conf:
呼叫該函式建立本模組位於location block的配置資訊儲存結構。每個在配置中指明的location建立一個。該函式執行成功，返回建立的配置物件。失敗的話，返回NULL。
merge_loc_conf:
與merge_srv_conf類似，這個也是進行配置值合併的地方。該函式成功的時候，返回NGX_CONF_OK。失敗的話，返回NGX_CONF_ERROR或錯誤字串。
Nginx裡面的配置資訊都是上下一層層的巢狀的，對於具體某個location的話，對於同一個配置，如果當前層次沒有定義，那麼就使用上層的配置，否則使用當前層次的配置。
這些引數如果不用，即我們不使用任何的回撥函式可以設為NULL。不過本節使用最後兩個回撥函式作為例項。好，看看myconfig模組的上下文：
static ngx_http_module_t ngx_http_myconfig_module_ctx = {
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
ngx_http_myconfig_create_loc_conf, //建立myconig_loc_conf_t結構體並初始化，見程式碼
ngx_http_myconfig_merge_loc_conf// 合併可能出現的重複項，僅作樣例用
};
1.3 模組的定義 ngx_module_t
對於開發一個模組來說，我們都需要定義一個ngx_module_t型別的變數來說明這個模組本身的資訊，從某種意義上來說，這是這個模組最重要的一個資訊，它告訴了nginx這個模組的一些資訊，上面定義的配置資訊，還有模組上下文資訊，都是通過這個結構來告訴nginx系統的，也就是載入模組的上層程式碼，都需要通過定義的這個結構，來獲取這些資訊。
我們先來看下ngx_module_t的定義：
當然那7個回撥函式我們不用的話就設定為NULL
好我們來看myconfig的實現：
ngx_module_t ngx_http_myconfig_module = {
NGX_MODULE_V1,
&ngx_http_myconfig_module_ctx, //設定為自己的模組上下文
ngx_http_myconfig_commands,//設定為自己的模組配置指令
NGX_HTTP_MODULE,//表明是HTTP模組
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NGX_MODULE_V1_PADDING
};
2解析配置項set函式
我們看看nginx的預設配置解析函式，這裡僅僅簡單接受，詳細請參看陶輝寫的nginx深入詳解第四章，講的很詳細。
2.1nginx的預設配置項解析函式
nginx提供了14個預設配置解析函式，分別解析下面14種常見的資料型別：
typedef struct{
ngx_str_t arg_str;
ngx_int_t arg_num;
ngx_flag_t arg_flag;
size_t arg_size;
ngx_array_t* arg_str_array;
ngx_array_t* arg_keyval;
off_t arg_off;
ngx_msec_t arg_msec;
time_t arg_sec;
ngx_bufs_t arg_bufs;
ngx_uint_t arg_enum_seq;
ngx_uint_t arg_bitmask;
ngx_uint_t arg_access;
ngx_path_t* arg_path;
}ngx_http_commondata_loc_conf_t;
相應的14個預設配置解析函式
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指令。
2.1簡單的例子
看看ngx_conf_set_str_slot的用法：
static char* ngx_http_mystring(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "mystring begin");
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = conf;
char* rt = ngx_conf_set_str_slot(cf, cmd, conf); //呼叫ngx_conf_set_str_slot 處理ngx_str_t型別的變數
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "mystring = %s", mlcf->arg_str.data);
//這裡我們按需求掛載了handler函式（還有按處理階段掛在，這裡不做介紹）
ngx_http_core_loc_conf_t *clcf;
clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
clcf->handler = ngx_http_myconfig_handler;
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "handler");
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "mystring end");
return rt;
}
看看ngx_buf_set_bufs_slot的用法：
static char* ngx_http_mybufs(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "buffer begin");
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = conf;
char* rt = ngx_conf_set_bufs_slot(cf, cmd, conf);//呼叫ngx_conf_set_bufs_slot 處理ngx_bufs_t型別的變數
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "buf_nums = %d, buf_size = %z",
mlcf->arg_bufs.num, mlcf->arg_bufs.size);
return rt;
}
最後強烈建議大家去看幾個預設配置項解析函式的原始碼加深印象（原始碼也比較簡單）。
3程式例項程式碼
模組程式設計的主要思路：
1編寫模組基本結構。包括模組的定義，模組上下文結構，模組的配置結構等。
2 實現handler的掛載函式。根據模組的需求選擇正確的掛載方式。
3 編寫handler處理函式。模組的功能主要通過這個函式來完成。
例項程式碼：
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>
static ngx_conf_enum_t test_enums[] = {
{ ngx_string("good"), 1},
{ ngx_string("better"), 2},
{ ngx_string("best"), 3},
{ ngx_null_string, 0}
};
typedef struct{
ngx_str_t arg_str;
ngx_int_t arg_counter;
ngx_flag_t arg_flag;
ngx_uint_t arg_enum_seq;
ngx_bufs_t arg_bufs;
}ngx_http_myconfig_loc_conf_t;
/*
location /myconfig {
mystring smile_to_life;
mycounter 24;
myflag on;
mygrage better;
mybufs 2 4k;
}
*/
static char* ngx_http_mystring(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static char* ngx_http_mycounter(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static char* ngx_http_myflag(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static char* ngx_http_mygrade(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static char* ngx_http_mybufs(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static ngx_int_t ngx_http_myconfig_handler(ngx_http_request_t *r);
static void* ngx_http_myconfig_create_loc_conf(ngx_conf_t* cf);
static char *ngx_http_myconfig_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
static ngx_command_t ngx_http_myconfig_commands[] = {
{
ngx_string("mystring"),//配置指令名稱
NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, //配置引數屬性
ngx_http_mystring, //set 函式,具體實現請參看原始碼
NGX_HTTP_LOC_CONF_OFFSET, //該配置在http的local配置中
offsetof(ngx_http_myconfig_loc_conf_t, arg_str),//offsetof(type, member):&(((type*)0)->member)
NULL
},
{
ngx_string("mycounter"),//配置指令名稱
NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1,//配置引數屬性
ngx_http_mycounter,//set 函式,具體實現請參看原始碼
NGX_HTTP_LOC_CONF_OFFSET,//該配置在http的local配置中
offsetof(ngx_http_myconfig_loc_conf_t, arg_counter), //在配置結構體中對應的位置
NULL
},
{
ngx_string("myflag"),
NGX_HTTP_LOC_CONF | NGX_CONF_FLAG | NGX_CONF_TAKE1,//ngx_conf_t 的型別要用NGX_CONF_FLAG
ngx_http_myflag,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_myconfig_loc_conf_t, arg_flag),
NULL
},
{
ngx_string("mygrade"),
NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1,
ngx_http_mygrade,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_myconfig_loc_conf_t, arg_enum_seq),
test_enums //post = test_enums, 引數post指向一個emum型別
},
{
ngx_string("mybufs"),
NGX_HTTP_LOC_CONF | NGX_CONF_TAKE2,//ngx_bufs_t 有兩個資料成員
ngx_http_mybufs,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_myconfig_loc_conf_t, arg_bufs),
NULL
},
ngx_null_command
};
static ngx_http_module_t ngx_http_myconfig_module_ctx = {
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
ngx_http_myconfig_create_loc_conf, //建立myconig_loc_conf_t結構體並初始化，見程式碼
ngx_http_myconfig_merge_loc_conf// 合併可能出現的重複項，僅作樣例用
};
ngx_module_t ngx_http_myconfig_module = {
NGX_MODULE_V1,
&ngx_http_myconfig_module_ctx, //設定為自己的模組上下文
ngx_http_myconfig_commands,//設定為自己的模組配置指令
NGX_HTTP_MODULE,//表明是HTTP模組
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NGX_MODULE_V1_PADDING
};
static char* ngx_http_mystring(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "mystring begin");
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = conf;
char* rt = ngx_conf_set_str_slot(cf, cmd, conf); //呼叫ngx_conf_set_str_slot 處理ngx_str_t型別的變數
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "mystring = %s", mlcf->arg_str.data);
//這裡我們按需求掛載了handler函式（還有按處理階段掛在，這裡不做介紹）
ngx_http_core_loc_conf_t *clcf;
clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
clcf->handler = ngx_http_myconfig_handler;
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "handler");
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "mystring end");
return rt;
}
static char* ngx_http_mycounter(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "c begin");
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = conf;
char* rt = ngx_conf_set_num_slot(cf, cmd, conf); //呼叫ngx_conf_set_num_slot 處理ngx_int_t型別的變數
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "num=%d c end", mlcf->arg_counter);
return rt;
}
static char* ngx_http_myflag(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = conf;
char* rt = ngx_conf_set_flag_slot(cf, cmd, conf);//呼叫ngx_conf_set_flag_slot 處理ngx_flag_t型別的變數
int flag = mlcf->arg_flag;
if (flag == 0)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "myflag = on");
}
else
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "myflag = off");
}
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "myflag=%d", mlcf->arg_flag);
return rt;
}
static char* ngx_http_mygrade(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "grage begin");
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = conf;
char* rt = ngx_conf_set_enum_slot(cf, cmd, conf);//呼叫ngx_conf_set_enum_slot 處理ngx_enum_t型別的變數
//有興趣的話可以看一下原始碼，很簡單的
ngx_str_t grade;
if (mlcf->arg_enum_seq == 1)
{
ngx_str_set(&grade, "good");
}
else if(mlcf->arg_enum_seq == 2)
{
ngx_str_set(&grade, "better");
}
else
{
ngx_str_set(&grade, "best");
}
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "mygrage = %s", grade.data);
return rt;
}
static char* ngx_http_mybufs(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "buffer begin");
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = conf;
char* rt = ngx_conf_set_bufs_slot(cf, cmd, conf);//呼叫ngx_conf_set_bufs_slot 處理ngx_bufs_t型別的變數
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "buf_nums = %d, buf_size = %z",
mlcf->arg_bufs.num, mlcf->arg_bufs.size);
return rt;
}
static void* ngx_http_myconfig_create_loc_conf(ngx_conf_t *cf)
{
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "create loc_conf_t begin");
ngx_http_myconfig_loc_conf_t *mlcf;
//申請記憶體空間
mlcf = ngx_pcalloc(cf->pool, sizeof(ngx_http_myconfig_loc_conf_t));
if (mlcf == NULL)
{
return NGX_CONF_ERROR;;
}
/*一定要初始話結構體的成員變數，不然會出現一些錯誤*/
//ngx_str_set(&mlcf->arg_str, "");///////////nginx: [emerg] "mystring" directive is duplicate in,這個錯誤除錯了一整天
//看ngx_conf_set_str_slot的實現,當arg_str.data不為空時會返回“is duplicate”
ngx_str_null(&mlcf->arg_str);
mlcf->arg_counter = NGX_CONF_UNSET;
mlcf->arg_flag = NGX_CONF_UNSET;
mlcf->arg_enum_seq = NGX_CONF_UNSET_UINT;
//mlcf->arg_bufs不用初始化
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "create loc_conf_t end");
return mlcf;
}
//合併可能出現的重複項，僅作樣例用
static char *ngx_http_myconfig_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
{
ngx_http_hello_loc_conf_t* prev = parent;
ngx_http_hello_loc_conf_t* conf = child;
ngx_conf_merge_str_value(conf->arg_str, prev->hello_str, "");
ngx_conf_merge_value(conf->arg_counter, prev->arg_counter, 0);
return NGX_CONF_OK;
}
//handler 函式
static ngx_int_t ngx_http_myconfig_handler(ngx_http_request_t *r)
{
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "ngx_http_myconfig_handler is called!");
if (!(r->method & (NGX_HTTP_HEAD | NGX_HTTP_GET)))
{
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "method is failed!");
return NGX_HTTP_NOT_ALLOWED;
}
ngx_int_t rc = ngx_http_discard_request_body(r);
if (rc != NGX_OK)
{
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "discard_qeuwest_body is failed!");
return rc;
}
ngx_str_t type = ngx_string("text/html");
r->headers_out.content_type = type;
r->headers_out.status = NGX_HTTP_OK;
if (r->method == NGX_HTTP_HEAD)
{
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "only header!");
r->headers_out.content_length_n = type.len;
return ngx_http_send_header(r);
}
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "handling is beginning");
ngx_http_myconfig_loc_conf_t *mlcf;
mlcf = ngx_http_get_module_loc_conf(r, ngx_http_myconfig_module);
if (mlcf == NULL)
{
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, " mlcf is empty!");
return NGX_ERROR;
}
ngx_str_t mystring = mlcf->arg_str;
ngx_str_t myflag;
if (mlcf->arg_flag == 1)
{
ngx_str_set(&myflag, "on");
}
else
{
ngx_str_set(&myflag, "off");
}
ngx_str_t grade;
if (mlcf->arg_enum_seq == 1)
{
ngx_str_set(&grade, "good");
}
else if(mlcf->arg_enum_seq == 2)
{
ngx_str_set(&grade, "better");
}
else
{
ngx_str_set(&grade, "best");
}
ngx_str_t format = ngx_string("mystring=%s, mycounter=%d, myflag=%s, mygrage=%s, buf_num=%d, buf_size=%z");
ngx_int_t content_length = format.len + mystring.len + myflag.len + grade.len;
r->headers_out.content_length_n = content_length;
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "buffer is initing!");
u_char* content_buf = (u_char*)ngx_pcalloc(r->pool, content_length);
if (content_buf == NULL)
{
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
ngx_sprintf(content_buf, (char*)format.data, mystring.data, mlcf->arg_counter, myflag.data,
grade.data, mlcf->arg_bufs.num, mlcf->arg_bufs.size);
ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "buffer is ended!");
ngx_buf_t* buf = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
if (buf == NULL)
{
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
buf->pos = content_buf;
buf->last = buf->pos + content_length;
buf->last_buf = 1;
buf->memory = 1;
ngx_chain_t out;
out.buf = buf;
out.next = NULL;
rc = ngx_http_send_header(r);
if (rc == NGX_ERROR || rc > NGX_OK || r->header_only)
{
return rc;
}
return ngx_http_output_filter(r, &out);
}word hard！