解剖Nginx·模块开发篇（1）跑起你的 Hello World 模块！

最新推荐文章于 2024-04-18 14:10:18 发布
最新推荐文章于 2024-04-18 14:10:18 发布
阅读量119 收藏
点赞数
文章标签： 运维 php

解剖Nginx·模块开发篇（1）跑起你的 Hello World 模块！

  • 作者：柳大·Poechant（钟超）
  • 邮箱：zhongchao.ustc#gmail.com（# -> @）
  • 博客：Blog.CSDN.net/Poechant
  • 日期：June 2nd, 2012

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=/your/module/path/ngx_http_hello_world_module
make

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

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

3.6 测试你的模块

http://localhost/hello_world

你应该会看到：

hello_world, Poechant

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

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

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

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

5 推荐一些参考

  1. Emiller’s Guide to Nginx Module Development
  2. Emiller’s Advanced Topics in Nginx Module Development
  3. 博客园-T2噬菌体-Nginx模块开发入门
  4. crk_world的博客
  5. Ngx Deve Kit
  6. Emiller’s Guide To Nginx Module Development 中文版
  7. Nginx & OpenResty
  8. CodingLabs-Nginx模块开发入门

-

转载请注明来自柳大的CSDN博客：Blog.CSDN.net/Poechant

-

wapysun
关注
零基础开发 nginx 模块
阿里云云栖号
09-03 1422
简介：推荐学习资料: * nginx 开发指南: http://nginx.org/en/docs/dev/development_guide.html * nginx 动态模块编译博客文章: https://www.nginx.com/blog/compiling-dynamic-modules-nginx-plus/ * nginx 源码: https://github.com/nginx 推荐学习资料: nginx 开发指南:http://nginx.org/en/docs/dev/devel..
开发Nginx模块Helloworld
weixin_30655219的博客
08-11 165
本文是对《深入理解Nginx》一书中的实例进行实战时的记录。 1模块目录结构 my_test_module/ ├── config └── ngx_http_mytest_module.c 1.1配置文件 config文件内容如下： ngx_addon_name=ngx_http_mytest_module HTTP_MODULES="$HTTP_MOD...
nginx module开发中module的调用链
java开发指南博客 【转载】
03-20 245
1.首先在nginx启动时，读取在编译时add-module指定的目录下的配置文件中指定的moudle name对应ngx_http_module_t变量。 如在ngx_module_test模块的目录下的配置文件为： ngx_addon_name=ngx_module_testHTTP_MODULES="$HTTP_MODULES ngx_module_test"NGX_ADDON_SRCS=...
Nginx模块开发系列2--hello_world框架
weixin_49406295的博客
08-13 331
Nginx模块开发-hello_world框架
nginx module开发helloworld
jiaowopan的专栏
12-03 562
众所周知，nginx是一个开源跨平台的高性能的web服务器，由于可以直接无缝使用Linux的epoll模型，因此可以在占用较小的cpu使用率的情况下就处理几万请求。 这么牛逼的服务器当然要研究一下了。思来想去还是从一个helloworld  module入手吧 以下代码摘自 http://cjhust.blog.163.com/blog/static/175827157201172411550
深入理解Nginx模块开发与架构解析第2版
04-17
深入理解Nginx模块开发与架构解析第2版LinuxUnix技术丛书 mobi格式，可以下载mobi阅读器打开
解剖Nginx·模块开发篇（2）ngx_http_hello_world_module 模块基本结构定义
麦克船长的技术笔记
06-03 1万+
解剖Nginx·模块开发篇（2）ngx_http_hello_world_module 基本结构定义作者：柳大·Poechant（钟超）邮箱：zhongchao.ustc#gmail.com（# -> @）博客：Blog.CSDN.net/Poechant日期：June 2nd, 2012HelloWorld 是一个典型的 location 模块。什么是 location 模块？在 Nginx 中
Nginx 模块开发
关注校招求职，微信号：job_campus
01-09 7831
通常，服务器启动时，任何 Handler 模块都有可能去处理配置文件中的位置（location）定义。若出现多个Handler 模块被配置成需要处理某一特定的位置location 时，最终只有其中一个Handler 模块是成功的。 若 Handler 模块的作用是把一个请求反向代理到后台服务器，则会出现另一种类型的空间模块—— Load-balancer（负载均衡器）。 Load-balancer 后端服务器会发出一个请求来决定哪个服务器接收请求。Nginx 目前支持两种 Load-bala
nginx直接打印输出_怎么用nginx输出helloworld
weixin_39902545的博客
12-21 1815
展开全部nginx模块32313133353236313431303231363533e4b893e5b19e31333363366237的处理流程：a.客户端发送http请求道nginx服务器b.nginx基于配置文件中的位置选择一个合适的处理模块c.负载均衡模块选择一台后端服务器(反向代理情况下)d.处理模块进行处理并把输出缓冲放到第一个过滤模块上e.第一个过滤模块处理后输出给第二个过滤模块f...
深入理解nginx模块开发和架构解析_经典文档
06-12
Nginx优势 1、作为Web服务器，Nginx处理静态文件、索引文件，自动索引的效率非常高 2、作为代理服务器，Nginx可以实现无缓存的反向代理加速，提高网站运行速度 3、作为负载均衡服务器，Nginx既可以在内部直接支持Rails和PHP，也可以支持HTTP代理服务器对外进行服务，同时还支持简单的容错和利用算法进行负载均衡 4、在性能方面，Nginx是专门为性能优化而开发的，实现上非常注重效率。它采用内核Poll模型，可以支持更多的并发连接，最大可以支持对5万个并发连接数的响应，而且只占用很低的内存资源 5、在稳定性方面，Nginx采取了分阶段资源分配技术，使得CPU与内存的占用率非常低。Nginx官方表示，Nginx保持1万个没有活动的连接，而这些连接只占用2.5MB内存，因此，类似DOS这样的攻击对Nginx来说基本上是没有任何作用的 6、在高可用性方面，Nginx支持热部署，启动速度特别迅速，因此可以在不间断服务的情况下，对软件版本或者配置进行升级，即使运行数月也无需重新启动，几乎可以做到7x24小时不间断地运行
【Nginx】输出/返回 HelloWorld
sayyy的专栏
01-18 5090
略
Nginx 自定义编译与模块添加
最新发布
峰迹的博客
04-18 620
已学会了如何重新编译Nginx并添加自定义模块。这不仅提升了您的服务器性能，也增加了其功能性。重新编译Nginx是高级系统管理的一部分，需要对Nginx及其模块有深入的理解。
Nginx模块开发系列1--预备知识
weixin_49406295的博客
12-04 3585
Nginx模块开发：ngx_command_t、ngx_module_t、ngx_http_module_t
nginx的helloworld模块的helloworld
走在左边
11-29 234
经典的nginx的helloworld尝试了一下 过程就是 [code="java"]nginx--->config文件---->module--->command[]函数----->handler | | ctx等 位置等[/code] 函数就是这个n...
Nginx学习之一-第一个程序Hello World
热门推荐
计算机专业同学的充电站。
06-19 2万+
本例子实现了一个简单的hello world程序。运行效果： 虚拟机Ubuntu中： win7中chrome浏览器： 一、config文件编写 Nginx提供了一种简单的方式将第三方的模块编译到Nginx中。首先把源代码文件全部放到一个目录下，同时在该目录中编写一个文件用于通知Nginx如何编译本模块，这个文件名必须为config。 然后，在configure
使用c++/c++11开发nginx模块时的两种编译方法
小麒麟的成长之路
11-18 5460
使用c++开发nginx模块时的两种编译方法 Nginx本身只支持使用C语言开发模块，如果我们需要使用C++，那么必须修改源码里的编译脚本 首先，我们不能使用g++编译Nginx自身的C代码，因为C++的语法比C严格很多，而Nginx代码用到了很多C语言的“边角”特性，直接使用g++编译会报大量错误 正确的做法是使用gcc来编译nginx源码，而使用g++来编译我们自己的C++代码，两者可使
Nginx 模块开发简单了解
程序员的日常学习
08-14 1618
Nginx 模块开发简单了解 Nginx 模块开发简单了解 Nginx简介 Nginx Linux下的默认安装与运行 Nginx配置文件说明 Nginx 模块开发Demo - 使用c/c++ Nginx 模块工作概述 Nginx 模块开发源码 Nginx 模块安装 其他更深入学习的东东 参考文档资料 Nginx简介 Nginx是当前最流行的HTTP Server之...
nginx 编写一个非常简单的hello word 模块
小游
12-31 223
本文档为个人博客文档系统的备份版本、作者：小游、作者博客：点击访问 参考https://blog.csdn.net/xiajun07061225/article/details/9130237 首先我们先编写模块，编写模块的时候我们需要新建一个config文件这个文件就是nginx模块的配置文件 比如我们写一个简单的mytest模块，那么文件的配置信息就是下面这样的。这里我们需要定义三个变量 config文件其实是一个可执行的Shell脚本，如果只想开发一个HTTP模块，需要定义三个变量： （1）ngx.
开发nginx测试模块：新手入门的hello world
这个模块是一个用于学习和测试目的的模块，它代表了Nginx模块开发的初级阶段，相当于编程中的“Hello World”示例。"Hello World"通常是一个程序中最简单的示例，用于演示基础的语法结构和功能，而在这个案例中，它...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值