Nginx开发HTTP模块入门

最新推荐文章于 2024-11-15 11:54:09 发布
最新推荐文章于 2024-11-15 11:54:09 发布
阅读量100 收藏
点赞数
文章标签： 运维 开发工具
原文链接：http://www.cnblogs.com/jianbingguozi/p/6938884.html
版权

Nginx开发HTTP模块入门

我们以一个最简单的Hello World模块为例，学习Nginx的模块编写。假设我们的模块在nginx配置文件中的指令名称为hello_world，那我们就可以在nginx.conf文件中配置这个指令

location / {
    hello_world;
}

这样，当我们访问首页的时候就会执行hello_world指令，输出Hello World。接下来，就开始编写我们的Hello World模块，按照nginx命名规则，我们把这个模块取名为ngx_http_hello_world_module

编写config文件

我们先建一个目录hello_world来保存我们的扩展

mkdir /opt/nginx/ext/hello_world

要想一个办法把我们的模块编译到nginx中，我们需要在执行./configure命令的时候加入--add-module=PATH,这里的PATH就是我们扩展目录，所以我们要完成./configure需要使用的config文件，在扩展目录下，新建config文件，

vim /opt/nginx/ext/hello_world/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"
CORE_LIBS="$CORE_LIBS -lpcre"
  1. ngx_addon_name：仅在configure执行时使用，一般设置为模块名称
  2. HTTP_MODULES：保存所有的HTTP模块名称，每个HTTP模块间由空格符相连，在重新设置HTTP_MODULES变量时，不要直接覆盖他，应该使用空格追加模块
  3. NGX_ADDON_SRCS：指定扩展模块的源代码

编写模块文件

编写好了config文件之后，就可以编写config文件中定义的模块文件了，新建模块文件

vim /opt/nginx/ext/hello_world/ngx_http_hello_world_module.c

定义HTTP模块

在nginx中，模块的数据类型是ngx_module_t
这个类型里面的成员详细可以参考源码，我们直接写出ngx_http_hello_world_module模块定义

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. NGX_MODULE_V1：表示版本号，使用内置的宏定义即可
  2. ngx_http_hello_world_module_ctx：这个成员很重要，设置上下文结构，HTTP框架要求，它必须指向ngx_http_module_t接口
  3. ngx_http_hello_world_commands：定义模块的配置文件参数，这个会作用在nginx.conf文件解析
  4. NGX_HTTP_MODULE：表示这是一个HTTP模块

编写模块上下文结构

这个结构体针对本文的HTTP模块来说，不需要调用，设置为NULL即可，但是HTTP框架要求，它必须指向ngx_http_module_t接口，所以我们这样定义

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

编写命令结构

ngx_http_hello_world_commands数组用于定义模块的配置文件参数，每一个元素都是ngx_command_t类型，数组的结尾用ngx_null_command表示。我们编写的模块的命令结构如下

static ngx_command_t  ngx_http_hello_world_commands[] = {
    { ngx_string("hello_world"),
      NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS,
      ngx_http_hello_world,
      0,
      0,
      NULL },
    ngx_null_command
}
  1. hello_world：表示我们的配置项名称，和gzip一样，设置名称而已
  2. NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS：指定出现的位置，可以出现在location{}块中
  3. ngx_http_hello_world：这是ngx_command_t中的set成员，当某块配置中出现hello_world时候，nginx将会启动ngx_http_hello_world方法，我们需要实现该函数

编写触发回调函数

前面编写完命令结构，定义了出现hello_world配置项的时候触发ngx_http_hello_world方法，我们要实现这个方法

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;
    return NGX_CONF_OK;
}
  1. ngx_http_conf_get_module_loc_conf：这个函数会首先找到hello_world配置项所属的配置块，然后赋值给变量clcf
  2. clcf->handler：HTTP框架在处理用户请求进行到NGX_HTTP_CONTENT_PHASE阶段时，如果请求的主机域名，URL和hello_wrold相匹配，那么就调用这handler指向的方法ngx_http_hello_world_handler

编写对http请求的具体处理方法hander

前面分析，当匹配URL之后，真正执行的其实是我们的ngx_http_hello_world_handler函数，所以，我们要实现这个函数

static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r)
{
    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);//向用户发送响应包
}

这个函数的参数是ngx_http_request_t类型参数r，它包含了很多东西（方法，URI，协议，头部等）。

完整的例子

将上面的步骤联系起来，可以最终合并成我们的新模块文件ngx_http_hello_world_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("hello_world"),
        NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_HTTP_LMT_CONF|NGX_CONF_NOARGS,
        ngx_http_hello_world,
        NGX_HTTP_LOC_CONF_OFFSET,
        0,
        NULL
    },
    ngx_null_command
};

static ngx_http_module_t ngx_http_hello_world_module_ctx = {
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL
};

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,
    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_hello_world_handler;

    return NGX_CONF_OK;
}


static ngx_int_t ngx_http_hello_world_handler(ngx_http_request_t *r)
{
    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);
}

编译HTTP模块

经过上面的步骤，我们的扩展模块下面有两个文件在/opt/nginx/ext/hello_world目录中

shell> ls /opt/nginx/ext/hello_world
config
ngx_http_hello_world_module.c

我们使用测试的nginx版本为nginx-1.0.10。在安装过程中，执行./configure的时候需要加入我们模块路径

shell> ./configure --add-module=/opt/nginx/ext/hello_world/nginx_hello_world/

然后进行安装即可

shell> make && make install

测试HTTP模块

修改nginx配置文件nginx.conf，如果不想配置规则，可以直接让访问首页的时候就执行hello_world执行

location / {
    hello_world;
}

然后启动我们的nginx

shell> ./sbin/nginx

测试我们的nginx扩展的HTTP模块

shell> curl "127.0.0.1"
Hello World

转载于:https://www.cnblogs.com/jianbingguozi/p/6938884.html

dazhi4469
关注
nginx模块开发之一
for_tech的博客
05-17 2177
本文以开发一个简单nginx模块为例，讲述nginx http模块开发的入门知识。
Nginx模块开发入门
07-02
### Nginx模块开发入门详解 #### Nginx概述与市场地位 Nginx作为一款高性能的HTTP服务器和反向代理服务器，在全球范围内享有极高的声誉。根据权威机构W3Techs的数据，截至某一时间点，全球排名前100万的网站中，...
【网关层】Nginx C模块开发入门
这太Imba了
01-14 765
Nginx C模块开发入门 一、前言 Nginx本身支持多个模块，如HTTP模块、EVENT模块和MAIL模块，此处只讲HTTP模块 Nginx本身工作实际较少，接到HTTP请求时候，仅仅通过查找配置文件将此次请求映射到一个loaction block，而此location中所配置的各个指令则会启动不同的模块去完成工作。因此模块可以看作Nginx真正的劳动工作者。通常一个location中的指令会涉及到一个handler模块和多个filter模块(多个location也可以复用一个模块)。handler模块
Nginx模块开发之http handler实现流量统计（入门篇）
Lion_Long的博客
11-22 5290
在本文中，我们将介绍HTTP Handler的概念和作用，探讨如何使用Nginx模块开发来实现流量统计功能。我们将从基础的HTTP Handler编写开始，逐步引导您完成一个简单而功能强大的流量统计模块。无论您是新手还是有一定经验的开发者，本文都将为您提供入门级别的指导和实例代码，帮助您快速上手并实现您的流量统计需求。
Nginx(1)入门
weixin_43994244的博客
04-03 1550
nginx安装，目录结构介绍，nginx.conf的初步认识
Nginx开发从入门到精通
GarfieldEr007的专栏
04-23 3133
Nginx开发从入门到精通 缘起 nginx由于出色的性能，在世界范围内受到了越来越多人的关注，在淘宝内部它更是被广泛的使用，众多的开发以及运维同学都迫切的想要了解nginx模块的开发以及它的内部原理，但是国内却没有一本关于这方面的书，源于此我们决定自己来写一本。本书的作者为淘宝核心系统服务器平台组的成员，本书写作的思路是从模块开发逐渐过渡到nginx原理剖析。书籍的内容会定期在这里更
nginx 模块开发入门
10-31 3822
转载一篇文章，以备之后查阅 转载地址:点击打开链接 前言 Nginx是当前最流行的HTTP Server之一，根据W3Techs的统计，目前世界排名（根据Alexa）前100万的网站中，Nginx的占有率为6.8%。与Apache相比，Nginx在高并发情况下具有巨大的性能优势。 Nginx属于典型的微内核设计，其内核非常简洁和优雅，同时具有非常高的可扩展性。Nginx
nginx 模块开发入门实例
DIYing
06-05 769
模块的开发需要一定的代码架构和操作步骤。要符合主体代码要求 实例胜千言，所以我准备了这个代码供入门参考。 1. 准备模块代码 2. 编写配置文件 3. 运行./configure 编译nginx 程序 4. make & make install 5. 运行测试 甲: 前言 Nginx的模块动态添加，所有的模块都要预先编译进Nginx的二进制可执行文件中。 所以要./conf
Nginx服务器超详细入门教程
who_im_i的博客
06-15 1294
说到代理，首先我们要明确一个概念，所谓代理就是一个代表、一个渠道；此时就涉及到两个角色，一个是被代理角色，一个是目标角色，被代理角色通过这个代理访问目标角色完成一些任务的过程称为代理操作过程；如同生活中随处可见的中介，我们可以通过中介买到房子，中介就是代理，被代理的就是买房子的人，而我们就是目标角色。nginx -s stop ：强制关闭Nginx，可能不保存相关信息，并迅速终止web服务。pkill nginx ：强制关闭nginx。
深入学习Nginx：从入门到实践
热门推荐
聚焦于深度解析最新的编程语言特性、框架升级、架构设计、开发工具和最佳实践，涵盖Web前端（如Vue3, React, Angular等）、后端开发（如Node.js, Java, Python等）、移动端开发（iOS, Android原生及跨平台开发）
03-17 3万+
Nginx的功能远不止于此，还包括SSL/TLS加密传输、限速控制、重写规则、防盗链设置等诸多高级特性。理解并熟练运用Nginx的各项配置和技术，将极大提升您的Web服务架构水平。不断实践与探索，结合业务需求灵活调整Nginx配置，才是持续优化服务性能的关键所在。
Nginx开发从入门到精通pdf高清带目录
10-11
《Nginx开发从入门到精通》是一本深入解析Nginx技术的书籍，适合对Web服务器技术感兴趣的初学者和进阶者。Nginx是一款高性能的HTTP和反向代理服务器，广泛应用于互联网领域的网站部署和负载均衡。本书旨在帮助读者...
nginx:Nginx 开发从入门到精通
06-04
Nginx 开发从入门到精通 Nginx ("engine x") 是一个高性能的 HTTP 和 反向代理 服务器，也是一个 IMAP/POP3/SMTP 代理服务器。 Nginx 是由 Igor Sysoev 为俄罗斯访问量第二的 Rambler.ru 站点开发的...
Docker：查看镜像里的文件
最新发布
weixin_52116015的博客
11-15 463
Docker：查看镜像里的文件
Openshift 如何更新访问控制机
11-13 402
OPenshift 安装的时候会指定用于访问集群的访问机， 比如PC1的ssh key 为key1, 那key1会配置到集群的ISO中， 那后如果PC1重新装OS 或者想换成其他的电脑是， key1 可以为变成key2.1. 新的访问机上把key 生成一下： ssh-keygen -t rsa -C 'xx@xx.com'保存key: cat /root/.ssh/id_rsa.pub。把/root/.ssh/id_rsa.pub 中的key 修改到这个yaml中。
ks8 本地化部署 F5-TTS
陈锐的技术笔记
11-13 923
此外，F5-TTS 还创新性地引入了推理时的 Sway Sampling 策略，这一策略可以在推理阶段优先处理早期的流步骤，从而提高生成语音与输入文本的对齐效果。在 LibriSpeech-PC 数据集上，该模型的字错误率（WER）达到了2.42，并且在推理时的实时因子(RTF)为0.15，显著优于之前的扩散模型 E2TTS，后者在处理速度和鲁棒性上存在短板。传统的 TTS 模型往往需要进行复杂的持续时间建模、音素对齐和专门的文本编码，这些都增加了合成过程的复杂性。继续TSS的启动，进入pod 输入命令。
记录一次C盘存储空间被异常占用的排查
ajax_beijing_java的博客
11-14 145
解决方案：开始一直认为是程序往C盘里面写入了文件，才导致c盘的存储一直在增加，但是之前服务是部署在云下的。从来是没有出现过磁盘被占用的现象。于是，找到了镜像同事，镜像同事反馈这个2019的镜像是老镜像，他们替换了新的镜像。服务器也暂时使用了2016的镜像，做成2016的系统。发现c盘被占用空间的问题不再出现。场景：运维同事发现一台windows server 2019的服务器，本来部署的是大屏业务，但是不知道为啥，总是能发现c盘莫名其妙的生成一些日志信息。后来竟然慢慢将c盘给占满了。导致服务无法正常使用。
虚拟机安装Ubuntu 24.04服务器版(命令行版)
weixin_42173947的博客
11-13 788
这个是专门用于服务器使用的，没有GUI，常用软件安装，见虚拟机安装Ubuntu 24.04及其常用软件(2024.7)_ubuntu24.04-CSDN博客这里只记录独特的安装步骤。
Nginx模块开发入门指南
"Nginx模块开发入门." Nginx是一个高度可扩展的HTTP服务器，以其在高并发场景下的优秀性能而闻名。它采用微内核架构，核心功能精简，但可以通过添加各种模块来增强其功能。随着Nginx的发展，越来越多的公司，如淘宝...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值