nginx

编程
目录
  1. nginx模块
    1. nginx模块的组成要素？
    2. 如何编写一个nginx模块？
      1. 为模块添加config脚本及编译
  2. nginx中几个重要的模块分析

nginx模块

nginx模块的组成要素？

  1. 模块数据结构ngx_module_t，用于集成模块
  2. 模块配置指令数组ngx_command_t
  3. 具体的模块，如HTTP模块ngx_http_module_t
  4. config配置文件，声明模块名及源码路径

需要掌握的知识结构：

  • http请求处理阶段
  • 组成要素中列举的关键数据结构
  • nginx基本编程风格及常用函数及类型

如何编写一个nginx模块？

####定义模块的配置指令数组

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
static ngx_command_t ngx_http_hello_commands[] = {
  		{
               ngx_string("hello_string"),
               NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS|NGX_CONF_TAKE1,
               ngx_http_hello_string,
               NGX_HTTP_LOC_CONF_OFFSET,
               offsetof(ngx_http_hello_loc_conf_t, hello_string),
               NULL },
       {
               ngx_string("hello_counter"),
               NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
               ngx_http_hello_counter,
               NGX_HTTP_LOC_CONF_OFFSET,
               offsetof(ngx_http_hello_loc_conf_t, hello_counter),
               NULL },
       ngx_null_command
};

其中ngx_http_hello_loc_conf_t为配置数据对应的数据结构，其定义如下：

1
2
3
4
5
typedef struct                       
{
        ngx_str_t hello_string;
        ngx_int_t hello_counter;
}ngx_http_hello_loc_conf_t;

####定义HTTP模块

1
2
3
4
5
6
7
8
9
10
static ngx_http_module_t ngx_http_hello_module_ctx = {
        NULL,                          /* preconfiguration */
        ngx_http_hello_init,           /* postconfiguration */
        NULL,                          /* create main configuration */
        NULL,                          /* init main configuration */
        NULL,                          /* create server configuration */
        NULL,                          /* merge server configuration */
        ngx_http_hello_create_loc_conf, /* create location configuration */    
        NULL                            /* merge location configuration */
};

其中ngx_http_hello_init函数将在nginx配置解析阶段调用，向nginx框架注册我们自己的处理函数(ngx_http_hello_handler，注册到NGX_HTTP_CONTENT_PHASE阶段)，其实现如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
static ngx_int_t
ngx_http_hello_init(ngx_conf_t *cf)
{
        ngx_http_handler_pt        *h;
        ngx_http_core_main_conf_t  *cmcf;
		//ngx_http_core_module模块负责管理所有的http功能模块，其对应的域为main
        cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
        h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
        if (h == NULL) {
                return NGX_ERROR;
        }
        *h = ngx_http_hello_handler;
        return NGX_OK;
}

ngx_http_hello_handler的实现如下(实现访问次数统计和简单的信息回复)：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
static ngx_int_t
ngx_http_hello_handler(ngx_http_request_t *r)
{
        ngx_int_t    rc;
        ngx_buf_t   *b;
        ngx_chain_t  out;
        ngx_http_hello_loc_conf_t* my_conf;
        u_char ngx_hello_string[1024] = {0};
        ngx_uint_t content_length = 0;
        ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "ngx_http_hello_handler is called!");
        my_conf = ngx_http_get_module_loc_conf(r, ngx_http_hello_module);
        if (my_conf->hello_string.len == 0 )
        {
                ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "hello_string is empty!");
                return NGX_DECLINED;
        }
        if (my_conf->hello_counter == NGX_CONF_UNSET
                || my_conf->hello_counter == 0)
        {
                ngx_sprintf(ngx_hello_string, "%s", my_conf->hello_string.data);
        }
        else
        {
                ngx_sprintf(ngx_hello_string, "%s Visited Times:%d", my_conf->hello_string.data,
                        ++ngx_hello_visited_times);
        }
        ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "hello_string:%s", ngx_hello_string);
        content_length = ngx_strlen(ngx_hello_string);      
        /* we response to 'GET' and 'HEAD' requests only */
        if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD))) {
                return NGX_HTTP_NOT_ALLOWED;
        }
        /* discard request body, since we don't need it here */
        rc = ngx_http_discard_request_body(r);
        if (rc != NGX_OK) {
                return rc;
        }
        /* set the 'Content-type' header */
        /*
         *r->headers_out.content_type.len = sizeof("text/html") - 1;
         *r->headers_out.content_type.data = (u_char *)"text/html";
         */
        ngx_str_set(&r->headers_out.content_type, "text/html");
        /* send the header only, if the request type is http 'HEAD' */
        if (r->method == NGX_HTTP_HEAD) {
                r->headers_out.status = NGX_HTTP_OK;
                r->headers_out.content_length_n = content_length;
                return ngx_http_send_header(r);
        }
        /* allocate a buffer for your response body */
        b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
        if (b == NULL) {
                return NGX_HTTP_INTERNAL_SERVER_ERROR;                              
        }
        /* attach this buffer to the buffer chain */
        out.buf = b;
        out.next = NULL;
        /* adjust the pointers of the buffer */
        b->pos = ngx_hello_string;
        b->last = ngx_hello_string + content_length;
        b->memory = 1;    /* this buffer is in memory */
        b->last_buf = 1;  /* this is the last buffer in the buffer chain
        /* set the status line */
        r->headers_out.status = NGX_HTTP_OK;
        r->headers_out.content_length_n = content_length;
        /* send the headers of your response */
        rc = ngx_http_send_header(r);
        if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
                return rc;
        }
        /* send the buffer chain of your response */
        return ngx_http_output_filter(r, &out);
}

ngx_http_hello_create_loc_conf函数用于在配置解析时使用内存池创建对象（nginx要求模块自己分配配置数据结构的内存），其实现如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
static void *ngx_http_hello_create_loc_conf(ngx_conf_t *cf)                            
{
        ngx_http_hello_loc_conf_t* local_conf = NULL;
        local_conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_hello_loc_conf_t));
        if (local_conf == NULL)
        {
                return NULL;
        }
        ngx_str_null(&local_conf->hello_string);
        local_conf->hello_counter = NGX_CONF_UNSET;
        return local_conf;
}

####集成配置指令
ngx_module_t是Nginx真正定义模块的数据结构，它集成了ngx_http_module_t和ngx_commond_t数组：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
ngx_module_t ngx_http_hello_module = {                                  
        NGX_MODULE_V1,
        &ngx_http_hello_module_ctx,    /* module context */
        ngx_http_hello_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
};

为模块添加config脚本及编译

nginx要求模块的Shell脚本名字必须是config，里面使用特定的Shell变量告诉configure模块相关的信息，其config文件如下

1
2
3
ngx_addon_name=ngx_http_hello_module
HTTP_MODULES="$HTTP_MODULES ngx_http_hello_module"
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_hello_module.c"

编译命令

./configure --prefix=$nginx_src_home/nginx-1.13.6 --add-module=$nginx_module_src/test/ --with-pcre=$HOME/pcre-8.39 --with-zlib=$HOME/zlib-1.2.11

其中nginx-1.13.6版本依赖于pcre和zlib，所以configure的时候要加上路径

nginx中几个重要的模块分析

upstream模块

load-balance模块

filter模块

http模块

本站总访问量次