nginx实现简单模块开发

转载 2015年07月08日 14:21:05

1 学习 Nginx 模块开发需要有哪些准备?

需要的预备知识不多,有如下几点:

  1. 有过一些 C 语言的编程经历;
  2. 知道 Nginx 是干嘛的,并有过编写或改写 Nginx 的配置文件的经历。

OK,就这两点就够了 :)

好了,那就开始吧~

2 我们的 HelloWorld 的目标是什么?

我们的目标,就是你在浏览器里输入http://localhost/hello_world时,显示:

hello world

当然,为了能够更加自定义一些,我们尝试在hello world后面再显示一个字符串,比如:

hello world, Poechant

那么我们的配置文件看起来是什么样的呢?

http {
    include mime.types;
    default_type application/octet-stream;
    server {
        listen 80;
        server_name localhost;
        location / {
            root html;
            index index.php index.html index.htm;
        }
        location /hello_world {
            hello_world Poechant;
        }
    }
}

是的,很简单吧,唯一特别的部分,就是:

location /hello_world {
    hello_world Poechant;
}

3 开工

3.1 目录结构

首先要明确,我们的文件和目录结构:

ngx_http_hello_world_module
|_____________ngx_http_hello_world_module.c
|_____________config

其中ngx_http_hello_world_module.c是模块的 C 源码文件,config是模块的配置文件。

3.2 ngx_http_hello_world_module.c

定义一个结构体:

typedef struct {
    ngx_str_t output_words;
} ngx_http_hello_world_loc_conf_t;

定义三个变量:

// Structure for the HelloWorld command
static ngx_command_t ngx_http_hello_world_commands[] = {
    {
        ngx_string("hello_world"), // The command name
        NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1,
        ngx_http_hello_world, // The command handler
        NGX_HTTP_LOC_CONF_OFFSET,
        offsetof(ngx_http_hello_world_loc_conf_t, output_words),
        NULL
    },
    ngx_null_command
};

// Structure for the HelloWorld context
static ngx_http_module_t ngx_http_hello_world_module_ctx = {
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    ngx_http_hello_world_create_loc_conf,
    ngx_http_hello_world_merge_loc_conf
};

// Structure for the HelloWorld module, the most important thing
ngx_module_t ngx_http_hello_world_module = {
    NGX_MODULE_V1,
    &ngx_http_hello_world_module_ctx,
    ngx_http_hello_world_commands,
    NGX_HTTP_MODULE,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NGX_MODULE_V1_PADDING
};

定义三个函数:

static char* ngx_http_hello_world(ngx_conf_t* cf, ngx_command_t* cmd, void* conf);
static void* ngx_http_hello_world_create_loc_conf(ngx_conf_t* cf)
static char* ngx_http_hello_world_merge_loc_conf(ngx_conf_t* cf, void* parent, void* child)

完整的程序如下:

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>

typedef struct {
    ngx_str_t output_words;
} ngx_http_hello_world_loc_conf_t;

// To process HelloWorld command arguments
static char* ngx_http_hello_world(ngx_conf_t* cf, ngx_command_t* cmd, void* conf);

// Allocate memory for HelloWorld command
static void* ngx_http_hello_world_create_loc_conf(ngx_conf_t* cf);

// Copy HelloWorld argument to another place
static char* ngx_http_hello_world_merge_loc_conf(ngx_conf_t* cf, void* parent, void* child);

// Structure for the HelloWorld command
static ngx_command_t ngx_http_hello_world_commands[] = {
    {
        ngx_string("hello_world"), // The command name
        NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1,
        ngx_http_hello_world, // The command handler
        NGX_HTTP_LOC_CONF_OFFSET,
        offsetof(ngx_http_hello_world_loc_conf_t, output_words),
        NULL
    },
    ngx_null_command
};

// Structure for the HelloWorld context
static ngx_http_module_t ngx_http_hello_world_module_ctx = {
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    ngx_http_hello_world_create_loc_conf,
    ngx_http_hello_world_merge_loc_conf
};

// Structure for the HelloWorld module, the most important thing
ngx_module_t ngx_http_hello_world_module = {
    NGX_MODULE_V1,
    &ngx_http_hello_world_module_ctx,
    ngx_http_hello_world_commands,
    NGX_HTTP_MODULE,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    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[2];

    ngx_http_hello_world_loc_conf_t* hlcf;
    hlcf = ngx_http_get_module_loc_conf(r, ngx_http_hello_world_module);

    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[0].buf = b;
    out[0].next = &out[1];

    b->pos = (u_char*)"hello_world, ";
    b->last = b->pos + sizeof("hello_world, ") - 1;
    b->memory = 1;

    b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));

    out[1].buf = b;
    out[1].next = NULL;

    b->pos = hlcf->output_words.data;
    b->last = hlcf->output_words.data + (hlcf->output_words.len);
    b->memory = 1;
    b->last_buf = 1;

    r->headers_out.status = NGX_HTTP_OK;
    r->headers_out.content_length_n = hlcf->output_words.len + sizeof("hello_world, ") - 1;
    rc = ngx_http_send_header(r);
    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
        return rc;
    }

    return ngx_http_output_filter(r, &out[0]);
}

static void* ngx_http_hello_world_create_loc_conf(ngx_conf_t* cf) {
    ngx_http_hello_world_loc_conf_t* conf;

    conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_hello_world_loc_conf_t));
    if (conf == NULL) {
        return NGX_CONF_ERROR;
    }
    conf->output_words.len = 0;
    conf->output_words.data = NULL;

    return conf;
}

static char* ngx_http_hello_world_merge_loc_conf(ngx_conf_t* cf, void* parent, void* child) {
    ngx_http_hello_world_loc_conf_t* prev = parent;
    ngx_http_hello_world_loc_conf_t* conf = child;
    ngx_conf_merge_str_value(conf->output_words, prev->output_words, "Nginx");
    return NGX_CONF_OK;
}

static char* ngx_http_hello_world(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_world_handler;
    ngx_conf_set_str_slot(cf, cmd, conf);
    return NGX_CONF_OK;
}

3.3 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"

3.4 编写配置文件

最开始已经展示过了,就是它。

3.5 编译你的模块

$ ./configure --add-module=/usr/local/nginx/ngx_http_hello_world_module (这个根据自己目录设置就可以了)
make 

如果没有任何错误提示的话,那么恭喜你,你的模块编译通过了!

然后运行 Nginx。如果没有任何错误提示的话,再次恭喜你,你的模块已经被正常加载运行了!

3.6 测试你的模块

http://localhost/hello_world

你应该会看到:

hello_world, Poechant

这个简单模块的详细解释,在该系列博文的第二、三、四篇中。

4 恐怕我还是要说一些“非代码”

一般来说,刚入门做某件事情的时候,我们不大想听废话,希望赶紧开始上手干活,否则会觉得很空洞。这也是为什么我一开始就上了一个例子,并给出代码。但是还是要了解一些“空话”,才有助于理解。

Nginx 处理请求的过程,是在请求收到后定位到配置文件中描述的相应 location,然后由 handler 生成 response,再由 filter 进行处理。所以模块开发,可以是 handler 模块开发,也可以是 filter 模块开发(当然还有其他类型的模块)。

nginx 开发简单的http模块

nginx开发简单的http模块
  • zhangxiao93
  • zhangxiao93
  • 2016年10月17日 09:33
  • 1882

Nginx模块开发之最简单的Hello模块

nginx模块开发并不是那么容易, 从行数上来讲, 淘宝给出的tengine给出的那个所谓hello模块的长度也到了245行, 要想真正独立写出这么多代码, 对于我来说是非常难的. 245行, ...
  • liwf616
  • liwf616
  • 2016年05月30日 13:53
  • 2850

【Nginx】开发一个简单的HTTP模块

首先来分析一下HTTP模块是如何介入Nginx的。 当master进程fork出若干个workr子进程后,每个worker子进程都会在自己的for死循环中不断调用事件模块: for ( ;; ) ...
  • jy02326166
  • jy02326166
  • 2014年06月17日 21:56
  • 4660

nginx 开发简单的http模块

nginx开发简单的http模块
  • zhangxiao93
  • zhangxiao93
  • 2016年10月17日 09:33
  • 1882

Nginx开发一个简单的HTTP过滤模块

转载:http://blog.csdn.net/zhangxiao93/article/details/53691642 记录为了学习 开发一个HTTP过滤模块的步骤和相关知识跟开发一个普...
  • xiaofei0859
  • xiaofei0859
  • 2017年04月26日 18:23
  • 151

nginx模块简单开发(发送字符串方式)

直接定义一个字符串,用返回字符串的返回到客户端/* zhuheming 20160811 */#include #include #include //定义字符串 static char ...
  • qq_35039122
  • qq_35039122
  • 2016年08月20日 18:32
  • 470

Nginx开发一个简单的HTTP过滤模块

Nginx开发一个简单的HTTP过滤模块
  • zhangxiao93
  • zhangxiao93
  • 2016年12月16日 16:39
  • 1634

深入理解nginx chap3 开发一个简单的HTTP模块

1. 如何调用HTTP模块本质:worker 进程会在一个for 循环里面反复调用事件模块检测网络事件。 2. 基本数据结构 命名规则: ngx_http_xxx_module.c 2.1 整形封装...
  • zhyh1435589631
  • zhyh1435589631
  • 2016年06月21日 21:28
  • 4714

nginx学习笔记(2):开发一个简单的HTTP模块

自己动手编写一个简单的nginx HTTP模块
  • Leeds1993
  • Leeds1993
  • 2016年09月12日 22:03
  • 1125

nginx 学习五 filter模块简介和实现一个简单的filter模块

1 nginx过滤模块简介 过滤(filter)模块是过滤响应头和内容的模块,可以对回复的头和内容进行处理。它的处理时间在获取回复内容之后, 向用户发送响应之前。它的处理过程分为两个阶段,过滤HTTP...
  • yanziguilai
  • yanziguilai
  • 2014年09月26日 22:40
  • 1827
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:nginx实现简单模块开发
举报原因:
原因补充:

(最多只允许输入30个字)