文档章节

nginx 开发一个简单的 HTTP 模块

for。
 for。
发布于 2015/12/29 21:47
字数 671
阅读 223
收藏 15
点赞 0
评论 0

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。

粉丝 80
博文 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
OpenResty(nginx+lua) 开发入门

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

English0523
2017/11/13
0
0
nginx的HTTP模块编写

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

王二狗子11
01/07
0
0
中文分词 mmseg nginx 模块开发

一、nginx模块开发 Nginx 是一款高性能web服务器,因此,工作业务中需要借助nginx强大的网络服务功能,往往需要开发和定制相应的 Nginx 模块满足业务需求。 基本上作为第三方开发者最可能开发...

gfsfg8545
2016/01/17
0
0
web缓存系统--NCache

NCACHE 是基于 NGINX 的 WEB 服务器模型构件起来的缓存系统, 是SINA公司的开源产品. 起初的目的是为了提升缓存响应速度而开发的,因为SQUID实在比较慢, 而NGINX的优势就在于网络服务上,所以N...

匿名
2008/09/17
17.2K
0
nginx + ngx_lua安装测试

nginx lua模块淘宝开发的nginx第三方模块,它能将lua语言嵌入到nginx配置中,从而使用lua就极大增强了nginx的能力.nginx以高并发 而知名,lua脚本轻便,两者的搭配堪称完美.接下来请看如何安装n...

小运
2013/09/03
0
0
nginx与apache的区别

1、nginx相对于apache的优点: 轻量级,同样起web 服务,比apache占用更少的内存及资源抗并发,nginx 处理请求是异步非阻塞的,而apache 则是阻塞型的,在高并发下nginx 能保持低资源低消耗高...

libray
2016/03/19
143
0
Nginx服务器防止负载过高模块sysguard

Nginx ("engine x") 是一个高性能的 HTTP 和 反向代理 服务器,也是一个 IMAP/POP3/SMTP 服务器。 Nginx 是由 Igor Sysoev 为俄罗斯访问量第二的 Rambler.ru 站点开发的,第一个公开版本0.1...

Foundation
2015/12/10
64
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

about git flow

  昨天元芳做了git分支管理规范的分享,为了拓展大家关于git分支的认知,这里我特意再分享这两个关于git flow的链接,大家可以看一下。 Git 工作流程 Git分支管理策略   git flow本质上是...

qwfys
今天
1
0
Linux系统日志文件

/var/log/messages linux系统总日志 /etc/logrotate.conf 日志切割配置文件 参考https://my.oschina.net/u/2000675/blog/908189 dmesg命令 dmesg’命令显示linux内核的环形缓冲区信息,我们可...

chencheng-linux
今天
1
0
MacOS下给树莓派安装Raspbian系统

下载镜像 前往 树莓派官网 下载镜像。 点击 最新版Raspbian 下载最新版镜像。 下载后请,通过 访达 双击解压,或通过 unzip 命令解压。 检查下载的文件 ls -lh -rw-r--r-- 1 dingdayu s...

dingdayu
今天
0
0
spring boot使用通用mapper(tk.mapper) ,id自增和回显等问题

最近项目使用到tk.mapper设置id自增,数据库是mysql。在使用通用mapper主键生成过程中有一些问题,在总结一下。 1、UUID生成方式-字符串主键 在主键上增加注解 @Id @GeneratedValue...

北岩
今天
2
0
告警系统邮件引擎、运行告警系统

告警系统邮件引擎 cd mail vim mail.py #!/usr/bin/env python#-*- coding: UTF-8 -*-import os,sysreload(sys)sys.setdefaultencoding('utf8')import getoptimport smtplibfr......

Zhouliang6
今天
0
0
Java工具类—随机数

Java中常用的生成随机数有Math.random()方法及java.util.Random类.但他们生成的随机数都是伪随机的. Math.radom()方法 在jdk1.8的Math类中可以看到,Math.random()方法实际上就是调用Random类...

PrivateO2
今天
2
0
关于java内存模型、并发编程的好文

Java并发编程:volatile关键字解析    volatile这个关键字可能很多朋友都听说过,或许也都用过。在Java 5之前,它是一个备受争议的关键字,因为在程序中使用它往往会导致出人意料的结果。在...

DannyCoder
昨天
0
0
dubbo @Reference retries 重试次数 一个坑

在代码一中设置 成retries=0,也就是调用超时不用重试,结果DEBUG的时候总是重试,不是0吗,0就不用重试啊。为什么还是调用了多次呢? 结果在网上看到 这篇文章才明白 https://www.cnblogs....

奋斗的小牛
昨天
2
0
数据结构与算法3

要抓紧喽~~~~~~~放羊的孩纸回来喽 LowArray类和LowArrayApp类 程序将一个普通的Java数组封装在LowArray类中。类中的数组隐藏了起来,它是私有的,所以只有类自己的方法才能访问他。 LowArray...

沉迷于编程的小菜菜
昨天
0
0
spring boot应用测试框架介绍

一、spring boot应用测试存在的问题 官方提供的测试框架spring-boot-test-starter,虽然提供了很多功能(junit、spring test、assertj、hamcrest、mockito、jsonassert、jsonpath),但是在数...

yangjianzhou
昨天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部