文档章节

nginx 开发一个简单的 HTTP 模块

for。
 for。
发布于 2015/12/29 21:47
字数 671
阅读 236
收藏 15

1. 下载 Nginx  

http://nginx.org/

2. 目录结构

$ tree -L 2
.
├── mytest_module
│   ├── config
│   └── ngx_http_mytest_module.c
└── nginx
...

3. config

# 在 configure 执行时使用
ngx_addon_name="ngx_http_mytest_module"
# HTTP 模块名称
HTTP_MODULES="$HTTP_MODULES ngx_http_mytest_module"
# 新增模块源代码
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_mytest_module.c"

4. ngx_http_mytest_module.c

/*
 * mytest_module
 */
#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);

/*
 * --ngx_command_t:用于处理 nginx.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
};

/*
 * --ngx_http_module_t 上下文结构体
 */
static ngx_http_module_t ngx_http_mytest_module_ctx = {
    NULL,
    NULL,

    NULL,
    NULL,

    NULL,
    NULL,

    NULL,
    NULL
};

/*
 * --ngx_module_t 
 *  configure 后,会被加入到 ngx_modules.c 中
 */
ngx_module_t ngx_http_mytest_module = {
    // ctx_index,index,spare0,spare1,spare2,spare3,version
    NGX_MODULE_V1,
    // 上下文结构体
    &ngx_http_mytest_module_ctx,
    // 用于处理 nginx.conf 中的配置项结构
    ngx_http_mytest_commands,
    // 模块类型,HTTP模块
    NGX_HTTP_MODULE,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NGX_MODULE_V1_PADDING
};

// 处理 nginx.conf 配置项参数的方法
static char * 
ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf) 
{
    ngx_http_core_loc_conf_t *clcf;

    // 获取 mytest 配置项所属的配置块
    clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);

    // 如果请求的主机域名、URI与mytest配置项所在的配置块相匹配,调用该方法
    clcf->handler = ngx_http_mytest_handler;

    return NGX_CONF_OK;
}

// 如果请求的主机域名、URI与mytest配置项所在的配置块相匹配,调用该方法
static ngx_int_t 
ngx_http_mytest_handler(ngx_http_request_t *r)
{
    // 必须是 GET 获得 HEAD 方法
    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;
    }

    // Content-Type
    ngx_str_t type = ngx_string("text/plain");
    // 包体内容
    ngx_str_t response = ngx_string("Hello World!");
    // 设置返回状态码
    r->headers_out.status = NGX_HTTP_OK;
    // 设置Content-Length
    r->headers_out.content_length_n = response.len;
    // 设置Content-Type
    r->headers_out.content_type = type;

    // 发送HTTP头部
    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;
    }

    // 将 Hello World 复制到 ngx_buf_t 指向的内存中
    ngx_memcpy(b->pos, response.data, response.len);
    b->last = b->pos + response.len;
    b->last_buf = 1;
    // 构造发送时的 ngx_chain_t 结构体
    ngx_chain_t out;
    out.buf = b;
    out.next = NULL;

    // 发送包体
    return ngx_http_output_filter(r, &out);
}

5. 编译、运行

修改配置:

nginx$ vi conf/nginx.conf

加入如下:

# (添加)非守护进程运行
daemon off;
# (添加)master 自身处理请求 
master_process on; 
 
 events {
     .....
 }
 
http {
    ....
    server {
    # 修改 80 为 8080
    listen 8080;
    ....
        # (添加) 到遇到 GET /test 请求时,使用 mytest 模块处理
        location /test {
            mytest;
        }
        ...
    }
    ...
}

configure:

nginx$ ./configure --prefix=/tmp/ngx_study/ --add-module=../mytest_module

在运行 configure 后,会在 objs/ngx_modules.c 文件的 ngx_modules 数组中加入 ngx_http_mytest_module 信息:

$ cat objs/ngx_modules.c | grep http_mytest_module
extern ngx_module_t  ngx_http_mytest_module;
    &ngx_http_mytest_module,

编译:

nginx$ make
nginx$ make install

运行:

$ /tmp/ngx_study/sbin/nginx

在浏览器中输入:

localhost:8080/test

6. PS 猜想:

nginx 通过 ngx_modules.c 中的结构 ngx_module_t ngx_modules -> 

ngx_http_mytest_module.c 中的结构 ngx_module_t ngx_http_mytest_module -> 结构 ngx_command_t ngx_http_mytest_commands -> 函数ngx_http_mytest 设置 处理函数 ngx_http_mytest_handler。

参考:

《深入理解 Nginx ——模块开发与架构解析》

© 著作权归作者所有

共有 人打赏支持
for。

for。

粉丝 83
博文 47
码字总数 18257
作品 0
深圳
程序员
Nginx学习指南之循序渐进(一)

Nginx学习指南之循序渐进(一) 一、简介 Nginx(‘engine x’)是一个高性能的HTTP和反向代理服务器,也是一个IMAP/POP3/SMTP代理服务器。Nginx 是由俄罗斯的程序设计师lgor sysoev所开发,将...

晨风微凉
06/28
0
0
Nginx 常见应用技术指南[Nginx Tips] 第二版

原文链接:http://bbs.linuxtone.org/thread-1685-1-1.htmlIT运维专家网--"自由平等,互助分享!" 作者:NetSeek http://www.linuxtone.org(IT运维专家网|集群架构|性能调优) 欢迎转载,转载时...

刘赤龙
2010/06/08
0
0
Nginx服务简介及编译安装详解

Nginx服务简介及编译安装详解 一、Nginx简介 Nginx是一个自由、开源、高性能及轻量级的HTTP服务器及反向代理服务器,其性能与IMAP/POP3代理服务器相当。Nginx以其高性能、稳定、功能丰富、配...

long9617
06/03
0
0
nginx的HTTP模块编写

本文是学习《深入理解nginx -- 模块开发与架构解析》的读书笔记 nginx的模块分为4个大类型的模块: 事件模块 HTTP模块 邮件代理相关的mail模块 其他模块 开发HTTP模块流程 这里的HTTP模块是最...

王二狗子11
01/07
0
0
OpenResty(nginx+lua) 开发入门

OpenResty 官网:http://openresty.org/ OpenResty® - 中文官方站 http://openresty.org/cn/ OpenResty 是一个nginx和它的各种三方模块的一个打包而成的软件平台。最重要的一点是它将lua/l...

English0523
2017/11/13
0
0

没有更多内容

加载失败,请刷新页面

加载更多

.NET 知识整理笔记

1.Web.Config配置文件的节点操作 在Web.Config中写入 <configuration> <connectionStrings> <add name="conStr" connectionString="Data Source=IUCL8V4Y7NW5IRA\SQLEXPRESS;Initia......

Jokeny
2分钟前
0
0
Spring 声明式注解事务实现机制

Spring中注解事务实现机制 在使用@Transactional 注解管理事务时步骤很简单。但是如果对@Transactional理解不够透彻,很容易出现事务不起作用的情况。所以,在对@Transactional的实现机制要有...

狂奔的熊二
3分钟前
0
0
Fastjson - 详解SerializeFilter,格式化对象字段

遇到一个奇葩场景,维护一个老的程序, 应用换了个服务方. 要切接口. 但有以下问题. 接口逻辑稍有不同 , 需要自己按原接口文档,重组逻辑. 接口字段名,字段类型改动较大. 但还要按原接口文档返回...

ol_O_O_lo
3分钟前
0
0
一个小知识点---关于传递引用参数

如果传入引用参数 在方法内new 对象,其改变外层不可见

职业搬砖20年
8分钟前
0
0
Oracle数据导入导出命令及参数介绍(Linux)

1.数据导出 exp system/123456 file=d:\backup\oracle\oracle%date:~0,10%.dmp owner=system log=d:\backup\oracle\oracle%date:~0,10%.log 2.数据导入 imp system/manager@TEST file=d:\d......

lyle_luo
9分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部