NGINX系列之HTTP模块开发

1
2
3
4
5
6
7
8
9
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;
};

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
//命令值的存储结构体
typedef struct
{
    ngx_str_t header_value; //存储命令的值

} ngx_http_hello_world_header_loc_conf_t;

//命令结构体
static ngx_command_t  ngx_http_hello_world_commands[] = {

    { ngx_string("hello_world_header"),
      NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, //命令出现在loc块内，且具有一个值
      ngx_http_hello_world_set,
      NGX_HTTP_LOC_CONF_OFFSET,
      offset(ngx_http_hello_world_header_loc_conf_t, header_value),//存储到ngx_http_hello_world_header_loc_conf_t结构体的header_value位置
      NULL },
      ngx_null_command //标志命令结束
};

static char* ngx_http_hello_world_set(ngx_conf_t *cf, ngx_command_t *cmd, void *conf){

        printf("---------ngx_http_hello_world_set--------");
       ngx_http_hello_world_header_loc_conf_t* local_conf;

       local_conf = conf;
       char* rv = ngx_conf_set_str_slot(cf, cmd, conf);

        return rv;

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
typedef struct  {
    ngx_int_t   (*preconfiguration)(ngx_conf_t *cf),                /* preconfiguration */
    ngx_int_t   (*postconfiguration)(ngx_conf_t *cf),               /* postconfiguration */

    void       *(*create_main_conf)(ngx_conf_t *cf),                /* create main configuration */
    char       *(*init_main_conf)(ngx_conf_t *cf, void *conf),      /* init main configuration */

    void       *(*create_srv_conf)(ngx_conf_t *cf),                 /* create server configuration */
    char       *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf), /* merge server configuration */

    void       *(*create_loc_conf)(ngx_conf_t *cf),    /* create location configuration */
    char       *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf)   /* merge location configuration */
}ngx_http_module_t;

1
2
3
4
5
#define ngx_conf_merge_uint_value(conf, prev, default)                       
    if (conf == NGX_CONF_UNSET_UINT) {                                       
        conf = (prev == NGX_CONF_UNSET_UINT) ? default : prev;               
    }

1
2
3
4
5
6
ngx_conf_merge_value
ngx_conf_merge_ptr_value
ngx_conf_merge_uint_value
ngx_conf_merge_msec_value
ngx_conf_merge_sec_value

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
static ngx_http_module_t  ngx_http_hello_world_module_ctx = {
    NULL,                                  /* preconfiguration */
    ngx_http_hello_world_init,              /* 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 */
};

//进行模块的挂载，下文详细介绍
static ngx_int_t ngx_http_hello_world_init(ngx_conf_t *cf){
    printf("---------ngx_http_hello_world_init--------");
    ngx_http_handler_pt        *h;
    ngx_http_core_main_conf_t  *cmcf;

    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_world_handler;

    return NGX_OK;

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
static ngx_int_t ngx_http_hello_world_handler(ngx_http_request_t *r)
{

    printf("%sn", "-------ngx_http_hello_world_handler--------");
    //不关心包体内容，因此丢弃包体内容
    ngx_int_t rc = ngx_http_discard_request_body(r);
    if (rc != NGX_OK) {
        return rc;
    }
    //增加一个头部信息
    h = ngx_list_push(&r->headers_out.headers );
    if(h == NULL){
        return NGX_ERROR;
    }
    ngx_str_set(&h->key,"X-Hello-World");
    ngx_str_set(&h->value,"Tango");
    h->hash = 1;

    return NG_DECLINED;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
static ngx_int_t ngx_http_hello_world_init(ngx_conf_t *cf){
    printf("---------ngx_http_hello_world_init--------");
    ngx_http_handler_pt        *h;
    ngx_http_core_main_conf_t  *cmcf;

    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_world_handler;

    return NGX_OK;
}

1
2
3
4
5
6
7
8
9
10
11
static char * ngx_http_hello_world_set(ngx_conf_t *cf, ngx_command_t *cmd, void *conf){
      printf("---------ngx_http_hello_world_init--------");
     ngx_http_handler_pt        *h;
      ngx_http_core_loc_conf_t  *clcf;

     clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
     clcf->handler =ngx_http_hello_world_handler;

     return NGX_CONF_OK;
}

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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>

static ngx_int_t ngx_http_hello_world_handler(ngx_http_request_t *r);

ngx_module_t  ngx_http_hello_world_module;

typedef struct {

  ngx_str_t header_value;

} ngx_http_hello_world_header_loc_conf_t;

static ngx_int_t ngx_http_hello_world_handler(ngx_http_request_t *r){

    printf("%sn", "-------ngx_http_hello_world_handler--------");

  ngx_http_hello_world_header_loc_conf_t* local_conf;
  ngx_table_elt_t  *h;
  //ngx_pool_t *p;

  local_conf = ngx_http_get_module_loc_conf(r,ngx_http_hello_world_module);
  ngx_str_t header_value = local_conf->header_value;

    ngx_int_t rc = ngx_http_discard_request_body(r);
  if (rc != NGX_OK) {
        return rc;
  }

  h = ngx_list_push(&r->headers_out.headers );
  if(h == NULL){
        return NGX_ERROR;
  }
  ngx_str_set(&h->key,"X-Hello-World");
  h->value.len = header_value.len;
  h->value.data = header_value.data;
  h->hash = 1;

  return NGX_DECLINED;
}

static void *ngx_http_hello_world_create_loc_conf(ngx_conf_t *cf){

  ngx_http_hello_world_header_loc_conf_t* local_conf = NULL;
  local_conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_hello_world_header_loc_conf_t));
  if (local_conf == NULL)
  {
          return NULL;
  }
  ngx_str_null(&local_conf->header_value);

  return local_conf;
}

static char* ngx_http_hello_world_set(ngx_conf_t *cf, ngx_command_t *cmd, void *conf){

   printf("---------ngx_http_hello_world_set--------");
   //ngx_http_hello_world_header_loc_conf_t* local_conf;
   //local_conf = conf;
   char* rv = ngx_conf_set_str_slot(cf, cmd, conf);

    ngx_http_core_loc_conf_t  *clcf;

     clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
     clcf->handler =ngx_http_hello_world_handler;

     return NGX_CONF_OK;
   return rv;

}

static ngx_command_t  ngx_http_hello_world_commands[] = {

  { ngx_string("hello_world_header"),
    NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
    ngx_http_hello_world_set,
    NGX_HTTP_LOC_CONF_OFFSET,
    offsetof(ngx_http_hello_world_header_loc_conf_t,header_value),
    NULL },
    ngx_null_command
};


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 */
  ngx_http_hello_world_create_loc_conf,  /* create location configuration */
  NULL                                   /* merge location configuration */
};

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
};

1
2
3
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"

1
2
3
./configure --with-debug --add-module=/home/iknow/nginx/nginx-1.15.1/src/ext/
make
make install

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
   server {
        listen       80;
        server_name  localhost;

        #charset koi8-r;

        #access_log  logs/host.access.log  main;

        location / {
            ##添加的命令
            hello_world_header Tango; 添加的命令
            root   html;
            index  index.html index.htm;
        }

        #error_page  404              /404.html;

        # redirect server error pages to the static page /50x.html
        #
        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }

        # proxy the PHP scripts to Apache listening on 127.0.0.1:80
        #
        #location ~ .php$ {
        #    proxy_pass   http://127.0.0.1;
        #}

        # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
        #
        #location ~ .php$ {
        #    root           html;
        #    fastcgi_pass   127.0.0.1:9000;
        #    fastcgi_index  index.php;
        #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
        #    include        fastcgi_params;
        #}

        # deny access to .htaccess files, if Apache's document root
        # concurs with nginx's one
        #
        #location ~ /.ht {
        #    deny  all;
        #}
    }

1
/usr/local/nginx/sbin/nginx

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
HTTP/1.1 200 OK
Server: nginx/1.15.1
Date: Sat, 21 Jul 2018 13:33:21 GMT
Content-Type: text/html
Content-Length: 612
Last-Modified: Thu, 19 Jul 2018 05:18:08 GMT
Connection: keep-alive
X-Hello-World: Tango
X-Hello-World: Tango
ETag: "5b501f10-264"
Accept-Ranges: bytes

<!DOCTYPE html>
<html>
<head>
<title>Welcome to nginx!</title>
<style>
    body {
        width: 35em;
        margin: 0 auto;
        font-family: Tahoma, Verdana, Arial, sans-serif;
    }
</style>
</head>
<body>
<h1>Welcome to nginx!</h1>
<p>If you see this page, the nginx web server is successfully installed and
working. Further configuration is required.</p>

<p>For online documentation and support please refer to
<a href="http://nginx.org/">nginx.org</a>.<br/>
Commercial support is available at
<a href="http://nginx.com/">nginx.com</a>.</p>

<p><em>Thank you for using nginx.</em></p>
</body>
</html>