{{docContent.title}}

简单helloword模块编写

参考https://blog.csdn.net/xiajun07061225/article/details/9130237

首先我们先编写模块,编写模块的时候我们需要新建一个config文件这个文件就是nginx模块的配置文件

比如我们写一个简单的mytest模块,那么文件的配置信息就是下面这样的。这里我们需要定义三个变量

config文件其实是一个可执行的Shell脚本,如果只想开发一个HTTP模块,需要定义三个变量:

(1)ngx_adon_name。仅在configure执行时使用,一般设置为模块名称。

(2)HTTP_MODULES。保存所有的HTTP模块名称。每个模块间由空格相连。在重新设置这个变量时,不要直接覆盖,因此要如下设置:"$HTTP_MODULES ngx_http_mytest_module"

(3)NGX_ADDON_SRCS。用于指定新模块的源代码,多个待编译的源代码之间可以用空格相连。

注意,在设置这个变量时可以使用$ngx_addon_dir变量(这个变量是用于我们编译的时候传递的),它等价于configure执行时--add-module=PATH的PATH参数。

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

然后我们新建一个ngx_http_mytest_module.c文件用于自己的代码,代码内容如下

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>
 
static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r);
static char * 
ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
//处理配置项
static ngx_command_t ngx_http_mytest_commands[] = {
    {
        ngx_string("mytest"),
        NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_HTTP_LMT_CONF|NGX_CONF_NOARGS,
        ngx_http_mytest,
        NGX_HTTP_LOC_CONF_OFFSET,
        0,
        NULL
    },
    ngx_null_command
};
//模块上下文
static ngx_http_module_t ngx_http_mytest_module_ctx = {
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL
};
//新模块定义
ngx_module_t ngx_http_mytest_module = {
    NGX_MODULE_V1,
    &ngx_http_mytest_module_ctx,
    ngx_http_mytest_commands,
    NGX_HTTP_MODULE,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
	NULL,
    NGX_MODULE_V1_PADDING
};
 
//配置项对应的回调函数
static char * 
ngx_http_mytest(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_mytest_handler;
 
    return NGX_CONF_OK;
}
 
//实际完成处理的回调函数
static ngx_int_t ngx_http_mytest_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 World");
    r->headers_out.status = NGX_HTTP_OK;
    r->headers_out.content_length_n = response.len;
    r->headers_out.content_type = type;
 
    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 (b == NULL) {
        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);
}

如果我们之前安装过nginx需要先停止nginx(我不知道要不要删除nginx安装的源代码,我删掉了)然后我们进行重新编译安装nginx

./configure --prefix=/usr/local/nginx(指定安装部署后的根目录) --add-module=/home/nginx(新模块存放目录)
make
sudo make instal

安装好后我们修改nginx的配置文件,在里面加上

     location /test {
    	    mytest;
        }

最后访问127.0.0.1/test然后我们需要重载nginx的配置文件nginx -s reload最后测试的效果如下

另外附几条常用的nginx命令

#配置文件重载
nginx -s reload
#关闭
nginx -s stop // 快速
nginx -s quit // 完整有序