nginx模块开发0(hello world)

来源：互联网发布：软件开发项目建议书编辑：程序博客网时间：2024/06/05 07:59

参考：《深入理解Nginx》

使用方法

Nginx提供了两种编译自定义HTTP模块的方法。

将模块源码放在同一目录下，并编写config文件。在Nginx代码configure执行的时候添加参数–add-module=PATH(模块源码所在目录)。其中config文件是一个可执行的shell脚本，对于简单的模块，需要定义以下三个变量:(1),ngx_addon_name,一般设为模块名称;(2), HTTP_MODULES,保存所有的HTTP模块名称，每个模块间用空格符相连;(3), NGX_ADDON_SRCS,用于指定新增模块的源代码，代码文件之间用空格相连，在设置NGX_ADDON_SRCS时可以使用$ngx_addon_dir变量，其值为configure执行时指定的PATH参数。如对于hello模块，则config文件可编写如下:

ngx_addon_name=ngx_http_hello_moduleHTTP_MODULES="$HTTP_MODULES ngx_http_hello_module"NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_hello_module.c"

手动修改configure脚本执行后生成的ojbs/Makefile和objs/ngx_modules.c文件。

测试

编写测试模块，源码文件名为ngx_http_hello_module.c,代码如下所示：

#include <ngx_config.h>#include <ngx_core.h>#include <ngx_http.h>static char *ngx_http_hello(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);static ngx_command_t ngx_http_hello_commands[] = {    {        ngx_string("hello"),        NGX_HTTP_MAIN_CONF | NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_CONF_NOARGS,        ngx_http_hello,        0,        0,        NULL    },    ngx_null_command};static ngx_http_module_t ngx_http_hello_module_ctx = {    NULL,    NULL,    NULL,    NULL,    NULL,    NULL,    NULL,    NULL};ngx_module_t ngx_http_hello_module = {    NGX_MODULE_V1,    &ngx_http_hello_module_ctx,    ngx_http_hello_commands,    NGX_HTTP_MODULE,    NULL,    NULL,    NULL,    NULL,    NULL,    NULL,    NULL,    NGX_MODULE_V1_PADDING};static ngx_int_t ngx_http_hello_handler(ngx_http_request_t *r){    if(!(r->method & (NGX_HTTP_GET | NGX_HTTP_HEAD)))    {        return NGX_HTTP_NOT_ALLOWED;    }    ngx_int_t rc = ngx_http_discard_request_body(r);    if(rc != NGX_OK)    {        return rc;    }    ngx_str_t type = ngx_string("text/plain");    ngx_str_t response = ngx_string("hello sxc1989");    r->headers_out.status = NGX_HTTP_OK;    r->headers_out.content_type = type;    r->headers_out.content_length_n = response.len;    rc = ngx_http_send_header(r);    if(rc == NGX_ERROR || rc > NGX_OK || r->header_only)    {        return rc;    }    ngx_buf_t *b;    b = ngx_create_temp_buf(r->pool, response.len);    if(NULL == b)    {        return NGX_HTTP_INTERNAL_SERVER_ERROR;    }    ngx_memcpy(b->pos, response.data, response.len);    b->last = b->pos + response.len;    b->last_buf = 1;    ngx_chain_t out;    out.buf = b;    out.next = NULL;    return ngx_http_output_filter(r, &out);}static char *ngx_http_hello(ngx_conf_t *cf, ngx_command_t *cmd, void *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_handler;    return NGX_CONF_OK;}

编译，将config文件和ngx_http_hello_module.c放在同一目录下，设路径名为path。在编译nginx的configure过程中添加参数–add-module=path;
运行，在配置文件中添加如下代码,

location /test {    hello;}

运行nginx，在游览器中输入http://127.0.0.1/test即可看到hello sxc1989。

0 0