初識nginx helloworld模塊

時間 2019-11-07

原文原文鏈接

1.nginx模塊

首先nginx和apache最大的不一樣就是nginx的模塊html

vi /opt/nginx_hello_word/config

不可以動態添加，須要在編譯時，指定要添加的模塊路徑，與nginx源碼一塊兒編譯。
nginx模塊的處理流程：
a.客戶端發送http請求道nginx服務器
b.nginx基於配置文件中的位置選擇一個合適的處理模塊
c.負載均衡模塊選擇一臺後端服務器(反向代理狀況下)
d.處理模塊進行處理並把輸出緩衝放到第一個過濾模塊上
e.第一個過濾模塊處理後輸出給第二個過濾模塊
f.而後第二個過濾模塊又到第三個過濾模塊
g.第N個過濾模塊。。。
h.發處理結果發給客戶端nginx

2.nginx模塊編寫

a、建立模塊文件夾apache

mkdir -p /opt/nginx_hello_world
cd /opt/nginx_hello_world

b、建立模塊配置文件後端

vi /opt/nginx_hello_word/config

寫入內容以下：數組

ngx_addon_name=ngx_http_hello_world_module
HTTP_MODULES="$HTTP_MODULES ngx_http_hello_world_module"
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_hello_world_module.c"

c、建立模塊主文件bash

vi /opt/nginx_hello_world/ngx_http_hello_world_module.c

寫入內容以下：服務器

#include <ngx_config.h>  
#include <ngx_core.h>  
#include <ngx_http.h>  
  
  
static char *ngx_http_hello_world(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);  
  
  
/* Commands */  
static ngx_command_t  ngx_http_hello_world_commands[] = {  
    { ngx_string("hello_world"),  
      NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS,  
      ngx_http_hello_world,  
      0,  
      0,  
      NULL },  
    ngx_null_command  
};  
  
static u_char ngx_hello_world[] = "hello world";  
  
static ngx_http_module_t  ngx_http_hello_world_module_ctx = {  
    NULL,                                  /* preconfiguration */  
    NULL,                                  /* postconfiguration */  
    NULL,                                  /* create main configuration */  
    NULL,                                  /* init main configuration */  
    NULL,                                  /* create server configuration */  
    NULL,                                  /* merge server configuration */  
    NULL,                                  /* create location configuration */  
    NULL                                   /* merge location configuration */  
};  
/* hook */  
ngx_module_t  ngx_http_hello_world_module = {  
    NGX_MODULE_V1,  
    &ngx_http_hello_world_module_ctx,              /* module context */  
    ngx_http_hello_world_commands,                 /* module directives */  
    NGX_HTTP_MODULE,                       /* module type */  
    NULL,                                  /* init master */  
    NULL,                                  /* init module */  
    NULL,             /* init process */  
    NULL,                                  /* init thread */  
    NULL,                                  /* exit thread */  
    NULL,             /* exit process */  
    NULL,                                  /* exit master */  
    NGX_MODULE_V1_PADDING  
};  
static ngx_int_t  
ngx_http_hello_world_handler(ngx_http_request_t *r)  
{  
    /* ngx_int_t     rc; */
    ngx_buf_t    *b;
    ngx_chain_t   out;
    /* Http Output Buffer */
    r->headers_out.content_type.len = sizeof("text/html;charset=utf-8") - 1;
    r->headers_out.content_type.data = (u_char *) "text/html;charset=utf-8";
      
    b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));  
    
    out.buf = b;
    out.next = NULL;
    
    b->pos = ngx_hello_world;
    b->last = ngx_hello_world + sizeof(ngx_hello_world);
    b->memory = 1;
    b->last_buf = 1;
    
    r->headers_out.status = NGX_HTTP_OK;
    r->headers_out.content_length_n = sizeof(ngx_hello_world);
    ngx_http_send_header(r);
    
    return ngx_http_output_filter(r, &out);
}
static char *
ngx_http_hello_world(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
    ngx_http_core_loc_conf_t *clcf ;
    /* register hanlder */
    clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
    clcf->handler = ngx_http_hello_world_handler;
    return NGX_CONF_OK;
}

d、編譯

個人加了nginx_lua模塊，其餘模塊等的。負載均衡

./configure --prefix=/usr/local/nginx-1.9.6 --with-pcre=/root/pcre-8.36 --with-zlib=/root/zlib-1.2.8 --with-openssl=/root/openssl-1.0.2a --with-stream --with-stream_ssl_module --with-cpp_test_module --with-http_stub_status_module --with-http_degradation_module --with-http_secure_link_module --with-http_gzip_static_module --with-http_gunzip_module --with-http_sub_module --with-http_realip_module --with-http_v2_module --with-http_ssl_module --with-threads --add-module=/root/ngx_devel_kit-master --add-module=/root/lua-nginx-module-master --add-module=/root/echo-nginx-module-master --add-module=/root/stream-lua-nginx-module-master --add-module=/root/lua-upstream-nginx-module-master --add-module=/root/headers-more-nginx-module-master --add-module=/opt/nginx_hello_world

默認只須要函數

./configure --prefix=/usr/local/nginx --add-module=/opt/nginx_hello_world/

make
make install

e、配置nginx.confpost

只須要在server域增長location

server {
        listen 83;
        server_name _;
        charset utf-8;
        access_log logs/tttt.access.log;

	    location /helloworld {
		    hello_world;
	    }

}

訪問：http://192.168.26.61:83/helloworld便可獲得helloworld

3.hello world模塊分析

a. ngx_command_t函數用於定義包含模塊指令的靜態數組ngx_http_hello_world_commands

static ngx_command_t  ngx_http_hello_world_commands[] = {  
    { ngx_string("hello_world"),  //設置指令名稱字符串，注意不能包含空格，數據類型ngx_str_t以後會詳細講解。  
      NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS, //配置指令的合法位置，這裏表示：location部分合法，而且指令沒有參數。  
      ngx_http_hello_world,//回調函數，三個參數（ngx_conf_t *cf，ngx_command_t *cmd, void *conf）  
      0,//後面的參數有待發掘，我尚未用到  
      0,  
      NULL },  
    ngx_null_command  
};

b.static u_char ngx_hello_world[] ="hello world" 則是輸出到屏幕的字符串。

c.ngx_http_module_t用來定義結構體ngx_http_hello_world_module_ctx:

static ngx_http_module_t  ngx_http_hello_world_module_ctx = {  
    NULL,                                  /* 讀入配置前調用*/  
    NULL,                                     /* 讀入配置後調用*/  
    NULL,                                  /* 建立全局部分配置時調用 */  
    NULL,                                  /* 初始化全局部分的配置時調用*/  
    NULL,                                  /* 建立虛擬主機部分的配置時調用*/  
    NULL,                                  /* 與全局部分配置合併時調用 */  
    NULL,                                  /* 建立位置部分的配置時調用 */  
    NULL                                   /* 與主機部分配置合併時調用*/  
};

d.ngx_module_t定義結構體ngx_http_hello_world_module

ngx_module_t  ngx_http_hello_world_module = {  
    NGX_MODULE_V1,  
    &ngx_http_hello_world_module_ctx,              /* module context */  
    ngx_http_hello_world_commands,                 /* module directives */  
    NGX_HTTP_MODULE,                       /* module type */  
    NULL,                                  /* init master */  
    NULL,                                  /* init module */  
    NULL,             /* init process */  
    NULL,                                  /* init thread */  
    NULL,                                  /* exit thread */  
    NULL,             /* exit process */  
    NULL,                                  /* exit master */  
    NGX_MODULE_V1_PADDING  
};

他包含有模塊的主要內容和指令的執行部分，下一節會詳細講解。

e.處理函數，ngx_http_hello_world_handler，也是hello world 模塊的核心部分。

static ngx_int_t  
ngx_http_hello_world_handler(ngx_http_request_t *r)//ngx_http_request_t *r 能夠訪問到客戶端的頭部和不久要發送的回覆頭部  
{  
    /* ngx_int_t     rc; */
    ngx_buf_t    *b;  
    ngx_chain_t   out;  
    /* Http Output Buffer */  
    r->headers_out.content_type.len = sizeof("text/plain") - 1;  
    r->headers_out.content_type.data = (u_char *) "text/plain";  
      
    b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));  
      
    out.buf = b;  
    out.next = NULL;  
      
    b->pos = ngx_hello_world;  
    b->last = ngx_hello_world + sizeof(ngx_hello_world);  
    b->memory = 1;  
    b->last_buf = 1;  
      
    r->headers_out.status = NGX_HTTP_OK;  
    r->headers_out.content_length_n = sizeof(ngx_hello_world);  
    ngx_http_send_header(r);  
      
    return ngx_http_output_filter(r, &out);  
}